From f32090a1f151de03e67e9d1a057188cdefbb3ed7 Mon Sep 17 00:00:00 2001 From: gabrielraeder Date: Wed, 12 Nov 2025 19:49:28 -0300 Subject: [PATCH 1/7] adds pages from universal login sdks --- .gitignore | 1 + main/docs.json | 746 +++++++++++++++++- .../reference/js-sdk/README.md | 46 ++ .../js-sdk/classes/AcceptInvitation.mdx | 131 +++ .../reference/js-sdk/classes/AculError.mdx | 16 + .../js-sdk/classes/Auth0ServerError.mdx | 16 + .../reference/js-sdk/classes/BaseContext.mdx | 60 ++ .../reference/js-sdk/classes/Branding.mdx | 38 + .../classes/BruteForceProtectionUnblock.mdx | 151 ++++ .../BruteForceProtectionUnblockFailure.mdx | 89 +++ .../BruteForceProtectionUnblockSuccess.mdx | 86 ++ .../reference/js-sdk/classes/Client.mdx | 30 + .../reference/js-sdk/classes/Consent.mdx | 273 +++++++ .../js-sdk/classes/CustomizedConsent.mdx | 319 ++++++++ .../js-sdk/classes/DeviceCodeActivation.mdx | 140 ++++ .../classes/DeviceCodeActivationAllowed.mdx | 89 +++ .../classes/DeviceCodeActivationDenied.mdx | 84 ++ .../js-sdk/classes/DeviceCodeConfirmation.mdx | 179 +++++ .../classes/EmailIdentifierChallenge.mdx | 285 +++++++ .../js-sdk/classes/EmailOTPChallenge.mdx | 86 ++ .../classes/EmailVerificationResult.mdx | 184 +++++ .../reference/js-sdk/classes/FormHandler.mdx | 36 + .../js-sdk/classes/InterstitialCaptcha.mdx | 152 ++++ .../reference/js-sdk/classes/Login.mdx | 280 +++++++ .../js-sdk/classes/LoginEmailVerification.mdx | 378 +++++++++ .../reference/js-sdk/classes/LoginId.mdx | 178 +++++ .../js-sdk/classes/LoginPassword.mdx | 90 +++ .../classes/LoginPasswordlessEmailCode.mdx | 218 +++++ .../classes/LoginPasswordlessSmsOtp.mdx | 264 +++++++ .../reference/js-sdk/classes/Logout.mdx | 168 ++++ .../js-sdk/classes/LogoutAborted.mdx | 123 +++ .../js-sdk/classes/LogoutComplete.mdx | 123 +++ .../js-sdk/classes/MfaBeginEnrollOptions.mdx | 168 ++++ .../js-sdk/classes/MfaCountryCodes.mdx | 173 ++++ .../classes/MfaDetectBrowserCapabilities.mdx | 165 ++++ .../js-sdk/classes/MfaEmailChallenge.mdx | 343 ++++++++ .../reference/js-sdk/classes/MfaEmailList.mdx | 167 ++++ .../js-sdk/classes/MfaEnrollResult.mdx | 221 ++++++ .../js-sdk/classes/MfaLoginOptions.mdx | 184 +++++ .../js-sdk/classes/MfaOtpChallenge.mdx | 244 ++++++ .../js-sdk/classes/MfaOtpEnrollmentCode.mdx | 194 +++++ .../js-sdk/classes/MfaOtpEnrollmentQr.mdx | 211 +++++ .../js-sdk/classes/MfaPhoneChallenge.mdx | 302 +++++++ .../js-sdk/classes/MfaPhoneEnrollment.mdx | 233 ++++++ .../js-sdk/classes/MfaPushChallengePush.mdx | 424 ++++++++++ .../js-sdk/classes/MfaPushEnrollmentQr.mdx | 165 ++++ .../reference/js-sdk/classes/MfaPushList.mdx | 167 ++++ .../js-sdk/classes/MfaPushWelcome.mdx | 160 ++++ .../classes/MfaRecoveryCodeChallenge.mdx | 175 ++++ .../MfaRecoveryCodeChallengeNewCode.mdx | 213 +++++ .../classes/MfaRecoveryCodeEnrollment.mdx | 138 ++++ .../js-sdk/classes/MfaSmsChallenge.mdx | 335 ++++++++ .../js-sdk/classes/MfaSmsEnrollment.mdx | 189 +++++ .../reference/js-sdk/classes/MfaSmsList.mdx | 154 ++++ .../js-sdk/classes/MfaVoiceChallenge.mdx | 508 ++++++++++++ .../js-sdk/classes/MfaVoiceEnrollment.mdx | 205 +++++ .../classes/MfaWebAuthnChangeKeyNickname.mdx | 69 ++ .../classes/MfaWebAuthnEnrollmentSuccess.mdx | 70 ++ .../js-sdk/classes/MfaWebAuthnError.mdx | 97 +++ .../classes/MfaWebAuthnNotAvailableError.mdx | 69 ++ .../classes/MfaWebAuthnPlatformChallenge.mdx | 88 +++ .../classes/MfaWebAuthnPlatformEnrollment.mdx | 97 +++ .../classes/MfaWebAuthnRoamingChallenge.mdx | 82 ++ .../classes/MfaWebAuthnRoamingEnrollment.mdx | 86 ++ .../reference/js-sdk/classes/Organization.mdx | 34 + .../js-sdk/classes/OrganizationPicker.mdx | 164 ++++ .../js-sdk/classes/OrganizationSelection.mdx | 142 ++++ .../js-sdk/classes/PasskeyEnrollment.mdx | 91 +++ .../js-sdk/classes/PasskeyEnrollmentLocal.mdx | 187 +++++ .../classes/PhoneIdentifierChallenge.mdx | 299 +++++++ .../classes/PhoneIdentifierEnrollment.mdx | 183 +++++ .../reference/js-sdk/classes/Prompt.mdx | 14 + .../reference/js-sdk/classes/RedeemTicket.mdx | 147 ++++ .../js-sdk/classes/ResetPassword.mdx | 205 +++++ .../js-sdk/classes/ResetPasswordEmail.mdx | 112 +++ .../js-sdk/classes/ResetPasswordError.mdx | 98 +++ .../ResetPasswordMfaEmailChallenge.mdx | 262 ++++++ .../classes/ResetPasswordMfaOtpChallenge.mdx | 193 +++++ .../ResetPasswordMfaPhoneChallenge.mdx | 273 +++++++ .../ResetPasswordMfaPushChallengePush.mdx | 241 ++++++ .../ResetPasswordMfaRecoveryCodeChallenge.mdx | 177 +++++ .../classes/ResetPasswordMfaSmsChallenge.mdx | 259 ++++++ .../ResetPasswordMfaVoiceChallenge.mdx | 301 +++++++ ...etPasswordMfaWebAuthnPlatformChallenge.mdx | 88 +++ ...setPasswordMfaWebAuthnRoamingChallenge.mdx | 88 +++ .../js-sdk/classes/ResetPasswordRequest.mdx | 144 ++++ .../js-sdk/classes/ResetPasswordSuccess.mdx | 89 +++ .../js-sdk/classes/SDKUsageError.mdx | 16 + .../reference/js-sdk/classes/Screen.mdx | 66 ++ .../js-sdk/classes/ScreenOverride.mdx | 65 ++ .../reference/js-sdk/classes/Signup.mdx | 317 ++++++++ .../reference/js-sdk/classes/SignupId.mdx | 333 ++++++++ .../js-sdk/classes/SignupPassword.mdx | 281 +++++++ .../reference/js-sdk/classes/Tenant.mdx | 26 + .../reference/js-sdk/classes/Transaction.mdx | 75 ++ .../js-sdk/classes/TransactionOverride.mdx | 96 +++ .../js-sdk/classes/UntrustedData.mdx | 38 + .../js-sdk/classes/UntrustedDataOverride.mdx | 37 + .../reference/js-sdk/classes/User.mdx | 69 ++ .../js-sdk/classes/UserInputError.mdx | 16 + .../functions/base64UrlToUint8Array.mdx | 18 + .../functions/createPasskeyCredentials.mdx | 18 + .../js-sdk/functions/createPollingControl.mdx | 18 + .../js-sdk/functions/createResendControl.mdx | 27 + .../js-sdk/functions/decodePublicKey.mdx | 18 + .../functions/extractIdentifiersByStatus.mdx | 21 + .../js-sdk/functions/flattenBorders.mdx | 18 + .../js-sdk/functions/flattenColors.mdx | 21 + .../js-sdk/functions/flattenFonts.mdx | 18 + .../functions/flattenPageBackground.mdx | 31 + .../js-sdk/functions/flattenWidget.mdx | 18 + .../js-sdk/functions/getActiveIdentifiers.mdx | 18 + .../functions/getAllowedIdentifiers.mdx | 18 + .../js-sdk/functions/getBackLink.mdx | 18 + .../functions/getBrowserCapabilities.mdx | 15 + .../js-sdk/functions/getCurrentScreen.mdx | 15 + .../functions/getCurrentScreenOptions.mdx | 15 + .../functions/getEditIdentifierLink.mdx | 18 + .../reference/js-sdk/functions/getErrors.mdx | 15 + .../functions/getForgotPasswordLink.mdx | 18 + .../js-sdk/functions/getLoginIdentifiers.mdx | 18 + .../js-sdk/functions/getLoginLink.mdx | 18 + .../functions/getOptionalIdentifiers.mdx | 18 + .../functions/getPasskeyCredentials.mdx | 18 + .../js-sdk/functions/getPasswordPolicy.mdx | 18 + .../js-sdk/functions/getPublicKey.mdx | 18 + .../functions/getRequiredIdentifiers.mdx | 18 + .../js-sdk/functions/getResetPasswordLink.mdx | 18 + .../reference/js-sdk/functions/getScopes.mdx | 18 + .../functions/getShowRememberDevice.mdx | 18 + .../js-sdk/functions/getSignupIdentifiers.mdx | 24 + .../js-sdk/functions/getSignupLink.mdx | 18 + .../js-sdk/functions/getUsernamePolicy.mdx | 18 + .../js-sdk/functions/getWebAuthnType.mdx | 18 + .../functions/hasFlexibleIdentifier.mdx | 18 + .../js-sdk/functions/internalPoll.mdx | 15 + .../isAuthenticatorAssertionResponse.mdx | 18 + .../reference/js-sdk/functions/isBrave.mdx | 15 + .../functions/isForgotPasswordEnabled.mdx | 18 + .../js-sdk/functions/isJsAvailable.mdx | 15 + .../js-sdk/functions/isPasskeyEnabled.mdx | 18 + .../js-sdk/functions/isPasskeySupported.mdx | 15 + .../reference/js-sdk/functions/isRunning.mdx | 15 + .../js-sdk/functions/isSignupEnabled.mdx | 18 + .../js-sdk/functions/isUsernameRequired.mdx | 18 + .../js-sdk/functions/isWebAuthAvailable.mdx | 15 + .../functions/isWebAuthPlatformAvailable.mdx | 15 + .../js-sdk/functions/parseErrorMessage.mdx | 21 + .../functions/registerPasskeyAutofill.mdx | 31 + .../js-sdk/functions/safeBase64Url.mdx | 18 + .../js-sdk/functions/startPolling.mdx | 15 + .../js-sdk/functions/stopPolling.mdx | 15 + .../functions/uint8ArrayToBase64Url.mdx | 18 + .../functions/updatePayloadByIdentifier.mdx | 25 + .../js-sdk/functions/validatePassword.mdx | 21 + .../js-sdk/functions/validateUsername.mdx | 21 + .../interfaces/AbortEnrollmentOptions.mdx | 27 + .../interfaces/AcceptInvitationMembers.mdx | 60 ++ .../js-sdk/interfaces/AllowCredential.mdx | 31 + .../js-sdk/interfaces/AuthorizationDetail.mdx | 27 + .../js-sdk/interfaces/BaseContext.mdx | 55 ++ .../js-sdk/interfaces/BaseMembers.mdx | 55 ++ .../reference/js-sdk/interfaces/Branding.mdx | 36 + .../js-sdk/interfaces/BrandingContext.mdx | 101 +++ .../js-sdk/interfaces/BrandingMembers.mdx | 27 + .../js-sdk/interfaces/BrandingSettings.mdx | 61 ++ .../js-sdk/interfaces/BrandingThemes.mdx | 44 ++ ...teForceProtectionUnblockFailureMembers.mdx | 47 ++ ...teForceProtectionUnblockFailureOptions.mdx | 23 + .../BruteForceProtectionUnblockMembers.mdx | 56 ++ ...teForceProtectionUnblockSuccessMembers.mdx | 51 ++ .../js-sdk/interfaces/CaptchaContext.mdx | 31 + .../js-sdk/interfaces/ClientContext.mdx | 43 + .../js-sdk/interfaces/ClientMembers.mdx | 41 + .../ConditionalMediationCapable.mdx | 23 + .../interfaces/ConfirmLogoutOptions.mdx | 28 + .../js-sdk/interfaces/Connection.mdx | 31 + .../js-sdk/interfaces/ConsentMembers.mdx | 117 +++ .../js-sdk/interfaces/ContinueOptions.mdx | 30 + .../interfaces/ContinueWithCodeOptions.mdx | 34 + .../ContinueWithOrganizationNameOptions.mdx | 35 + .../interfaces/ContinueWithPasskeyOptions.mdx | 32 + .../js-sdk/interfaces/CountryCode.mdx | 27 + .../js-sdk/interfaces/CredentialResponse.mdx | 31 + .../interfaces/CurrentScreenOptions.mdx | 101 +++ .../js-sdk/interfaces/CustomOptions.mdx | 23 + .../interfaces/CustomizedConsentMembers.mdx | 119 +++ .../js-sdk/interfaces/DBConnection.mdx | 164 ++++ .../DeviceCodeActivationAllowedMembers.mdx | 45 ++ .../DeviceCodeActivationDeniedMembers.mdx | 45 ++ .../DeviceCodeActivationMembers.mdx | 61 ++ .../DeviceCodeConfirmationMembers.mdx | 67 ++ .../interfaces/EmailChallengeOptions.mdx | 31 + .../EmailIdentifierChallengeMembers.mdx | 63 ++ .../interfaces/EmailOTPChallengeMembers.mdx | 74 ++ .../EmailVerificationResultMembers.mdx | 53 ++ .../js-sdk/interfaces/EnrolledDevice.mdx | 27 + .../js-sdk/interfaces/EnrolledEmail.mdx | 27 + .../js-sdk/interfaces/EnrolledPhoneNumber.mdx | 27 + .../interfaces/EnterpriseConnection.mdx | 44 ++ .../EnterpriseConnectionContext.mdx | 44 ++ .../reference/js-sdk/interfaces/Error.mdx | 35 + .../interfaces/ExtendedScreenContext.mdx | 41 + .../ExtendedUntrustedDataContext.mdx | 46 ++ .../interfaces/FederatedLoginOptions.mdx | 31 + .../interfaces/FederatedSignupOptions.mdx | 27 + .../js-sdk/interfaces/FlattenedTheme.mdx | 39 + .../js-sdk/interfaces/FormOptions.mdx | 39 + .../js-sdk/interfaces/Identifier.mdx | 38 + .../interfaces/InterstitialCaptchaMembers.mdx | 50 ++ .../reference/js-sdk/interfaces/Login.mdx | 233 ++++++ .../LoginEmailVerificationMembers.mdx | 149 ++++ .../js-sdk/interfaces/LoginEnrollOptions.mdx | 31 + .../reference/js-sdk/interfaces/LoginId.mdx | 118 +++ .../js-sdk/interfaces/LoginIdMembers.mdx | 68 ++ .../js-sdk/interfaces/LoginMembers.mdx | 85 ++ .../js-sdk/interfaces/LoginOptions.mdx | 43 + .../js-sdk/interfaces/LoginPassword.mdx | 59 ++ .../interfaces/LoginPasswordMembers.mdx | 56 ++ .../interfaces/LoginPasswordOptions.mdx | 35 + .../LoginPasswordlessEmailCodeMembers.mdx | 60 ++ .../LoginPasswordlessSmsOtpMembers.mdx | 65 ++ .../interfaces/LogoutAbortedMembers.mdx | 45 ++ .../interfaces/LogoutCompleteMembers.mdx | 45 ++ .../js-sdk/interfaces/LogoutMembers.mdx | 55 ++ .../MfaBeginEnrollOptionsMembers.mdx | 55 ++ .../interfaces/MfaCountryCodesMembers.mdx | 65 ++ .../MfaDetectBrowserCapabilitiesMembers.mdx | 60 ++ .../interfaces/MfaEmailChallengeMembers.mdx | 98 +++ .../js-sdk/interfaces/MfaEmailListMembers.mdx | 65 ++ .../js-sdk/interfaces/MfaEnrollOptions.mdx | 31 + .../interfaces/MfaEnrollResultMembers.mdx | 57 ++ .../interfaces/MfaLoginOptionsMembers.mdx | 77 ++ .../interfaces/MfaOtpChallengeMembers.mdx | 68 ++ .../MfaOtpEnrollmentCodeMembers.mdx | 71 ++ .../interfaces/MfaOtpEnrollmentQrMembers.mdx | 77 ++ .../interfaces/MfaPhoneChallengeMembers.mdx | 122 +++ .../interfaces/MfaPhoneEnrollmentMembers.mdx | 81 ++ .../MfaPushChallengePushMembers.mdx | 99 +++ .../interfaces/MfaPushEnrollmentQrMembers.mdx | 62 ++ .../js-sdk/interfaces/MfaPushListMembers.mdx | 64 ++ .../interfaces/MfaPushPollingControl.mdx | 78 ++ .../interfaces/MfaPushWelcomeMembers.mdx | 55 ++ .../interfaces/MfaPushWelcomeOptions.mdx | 23 + .../MfaRecoveryCodeChallengeMembers.mdx | 73 ++ ...MfaRecoveryCodeChallengeNewCodeMembers.mdx | 84 ++ ...aRecoveryCodeEnrollmentContinueOptions.mdx | 26 + .../MfaRecoveryCodeEnrollmentMembers.mdx | 63 ++ .../interfaces/MfaSmsChallengeMembers.mdx | 77 ++ .../interfaces/MfaSmsChallengeOptions.mdx | 27 + .../interfaces/MfaSmsEnrollmentMembers.mdx | 59 ++ .../interfaces/MfaSmsEnrollmentOptions.mdx | 31 + .../js-sdk/interfaces/MfaSmsListMembers.mdx | 67 ++ .../js-sdk/interfaces/MfaSmsListOptions.mdx | 33 + .../MfaVoiceChallengeContinueOptions.mdx | 45 ++ .../interfaces/MfaVoiceChallengeMembers.mdx | 156 ++++ .../interfaces/MfaVoiceEnrollmentMembers.mdx | 84 ++ .../MfaWebAuthnChangeKeyNicknameMembers.mdx | 100 +++ .../MfaWebAuthnEnrollmentSuccessMembers.mdx | 81 ++ .../interfaces/MfaWebAuthnErrorMembers.mdx | 127 +++ .../MfaWebAuthnNotAvailableErrorMembers.mdx | 71 ++ .../MfaWebAuthnPlatformChallengeMembers.mdx | 149 ++++ .../MfaWebAuthnPlatformEnrollmentMembers.mdx | 148 ++++ .../MfaWebAuthnRoamingChallengeMembers.mdx | 142 ++++ .../MfaWebAuthnRoamingEnrollmentMembers.mdx | 119 +++ .../js-sdk/interfaces/OrganizationContext.mdx | 65 ++ .../js-sdk/interfaces/OrganizationMembers.mdx | 45 ++ .../interfaces/OrganizationPickerMembers.mdx | 65 ++ .../OrganizationSelectionMembers.mdx | 60 ++ .../js-sdk/interfaces/Organizations.mdx | 35 + .../js-sdk/interfaces/OtpCodeOptions.mdx | 30 + .../reference/js-sdk/interfaces/Passkey.mdx | 23 + .../js-sdk/interfaces/PasskeyCreate.mdx | 85 ++ .../interfaces/PasskeyCreateResponse.mdx | 39 + .../interfaces/PasskeyCredentialResponse.mdx | 58 ++ .../js-sdk/interfaces/PasskeyEnroll.mdx | 85 ++ .../js-sdk/interfaces/PasskeyEnrollment.mdx | 61 ++ .../interfaces/PasskeyEnrollmentLocal.mdx | 157 ++++ .../PasskeyEnrollmentLocalMembers.mdx | 55 ++ .../interfaces/PasskeyEnrollmentMembers.mdx | 55 ++ .../js-sdk/interfaces/PasskeyLogin.mdx | 32 + .../js-sdk/interfaces/PasskeyRead.mdx | 32 + .../interfaces/PasswordComplexityRule.mdx | 55 ++ .../js-sdk/interfaces/PasswordPolicy.mdx | 35 + .../interfaces/PasswordValidationResult.mdx | 42 + .../interfaces/PasswordlessConnection.mdx | 38 + .../interfaces/PhoneChallengeOptions.mdx | 31 + .../interfaces/PhoneEnrollmentOptions.mdx | 27 + .../PhoneIdentifierChallengeMembers.mdx | 71 ++ .../PhoneIdentifierEnrollmentMembers.mdx | 55 ++ .../js-sdk/interfaces/PhonePrefix.mdx | 37 + .../interfaces/PickAuthenticatorOptions.mdx | 21 + .../js-sdk/interfaces/PickPhoneOptions.mdx | 21 + .../js-sdk/interfaces/PostPayloadOptions.mdx | 27 + .../js-sdk/interfaces/PromptContext.mdx | 23 + .../js-sdk/interfaces/PromptMembers.mdx | 23 + .../js-sdk/interfaces/RedeemTicketMembers.mdx | 70 ++ .../interfaces/ReportBrowserErrorOptions.mdx | 30 + .../interfaces/ReportWebAuthnErrorOptions.mdx | 23 + .../js-sdk/interfaces/ResendCodeOptions.mdx | 25 + .../js-sdk/interfaces/ResendControl.mdx | 23 + .../interfaces/ResetPasswordEmailMembers.mdx | 51 ++ .../interfaces/ResetPasswordEmailOptions.mdx | 23 + .../interfaces/ResetPasswordErrorMembers.mdx | 47 ++ .../interfaces/ResetPasswordErrorOptions.mdx | 23 + .../interfaces/ResetPasswordMembers.mdx | 56 ++ .../ResetPasswordMfaEmailChallengeMembers.mdx | 87 ++ .../ResetPasswordMfaOtpChallengeMembers.mdx | 64 ++ .../ResetPasswordMfaPhoneChallengeMembers.mdx | 133 ++++ ...setPasswordMfaPushChallengePushMembers.mdx | 97 +++ ...asswordMfaRecoveryCodeChallengeMembers.mdx | 74 ++ .../ResetPasswordMfaSmsChallengeMembers.mdx | 72 ++ .../ResetPasswordMfaVoiceChallengeMembers.mdx | 111 +++ ...ordMfaWebAuthnPlatformChallengeMembers.mdx | 146 ++++ ...wordMfaWebAuthnRoamingChallengeMembers.mdx | 111 +++ .../interfaces/ResetPasswordOptions.mdx | 31 + .../ResetPasswordRequestMembers.mdx | 60 ++ .../ResetPasswordRequestOptions.mdx | 31 + .../ResetPasswordSuccessMembers.mdx | 47 ++ .../ResetPasswordSuccessOptions.mdx | 23 + .../reference/js-sdk/interfaces/Scope.mdx | 27 + .../js-sdk/interfaces/ScreenContext.mdx | 39 + .../interfaces/ScreenContextOnLogin.mdx | 44 ++ .../ScreenContextOnLoginPassword.mdx | 47 ++ ...ScreenContextOnLoginPasswordlessSmsOtp.mdx | 47 ++ .../ScreenContextOnSignupPassword.mdx | 58 ++ .../js-sdk/interfaces/ScreenData.mdx | 23 + ...setPasswordMfaWebAuthnRoamingChallenge.mdx | 39 + .../js-sdk/interfaces/ScreenDataOptions.mdx | 26 + .../js-sdk/interfaces/ScreenMembers.mdx | 55 ++ .../ScreenMembersOnAcceptInvitation.mdx | 56 ++ ...rsOnBruteForceProtectionUnblockFailure.mdx | 53 ++ ...rsOnBruteForceProtectionUnblockSuccess.mdx | 45 ++ .../interfaces/ScreenMembersOnConsent.mdx | 54 ++ .../ScreenMembersOnCustomizedConsent.mdx | 69 ++ .../ScreenMembersOnDeviceCodeConfirmation.mdx | 53 ++ ...creenMembersOnEmailIdentifierChallenge.mdx | 59 ++ .../ScreenMembersOnEmailOTPChallenge.mdx | 47 ++ ...ScreenMembersOnEmailVerificationResult.mdx | 70 ++ .../interfaces/ScreenMembersOnLogin.mdx | 61 ++ .../interfaces/ScreenMembersOnLoginId.mdx | 58 ++ .../ScreenMembersOnLoginPassword.mdx | 65 ++ ...eenMembersOnLoginPasswordlessEmailCode.mdx | 68 ++ ...ScreenMembersOnLoginPasswordlessSmsOtp.mdx | 68 ++ .../ScreenMembersOnMfaCountryCodes.mdx | 52 ++ .../ScreenMembersOnMfaEmailChallenge.mdx | 56 ++ .../ScreenMembersOnMfaEmailList.mdx | 52 ++ .../ScreenMembersOnMfaEnrollResult.mdx | 61 ++ .../ScreenMembersOnMfaLoginOptions.mdx | 52 ++ .../ScreenMembersOnMfaOtpChallenge.mdx | 53 ++ .../ScreenMembersOnMfaOtpEnrollmentCode.mdx | 54 ++ .../ScreenMembersOnMfaOtpEnrollmentQr.mdx | 53 ++ .../ScreenMembersOnMfaPhoneChallenge.mdx | 56 ++ .../ScreenMembersOnMfaPushChallengePush.mdx | 54 ++ .../ScreenMembersOnMfaPushEnrollmentQr.mdx | 59 ++ .../ScreenMembersOnMfaPushWelcome.mdx | 68 ++ ...mbersOnMfaRecoveryCodeChallengeNewCode.mdx | 59 ++ ...reenMembersOnMfaRecoveryCodeEnrollment.mdx | 54 ++ .../ScreenMembersOnMfaSmsChallenge.mdx | 62 ++ .../ScreenMembersOnMfaSmsEnrollment.mdx | 53 ++ .../ScreenMembersOnMfaVoiceChallenge.mdx | 67 ++ ...nMembersOnMfaWebAuthnChangeKeyNickname.mdx | 62 ++ ...nMembersOnMfaWebAuthnEnrollmentSuccess.mdx | 69 ++ .../ScreenMembersOnMfaWebAuthnError.mdx | 65 ++ ...nMembersOnMfaWebAuthnPlatformChallenge.mdx | 67 ++ ...MembersOnMfaWebAuthnPlatformEnrollment.mdx | 56 ++ ...enMembersOnMfaWebAuthnRoamingChallenge.mdx | 58 ++ ...nMembersOnMfaWebAuthnRoamingEnrollment.mdx | 54 ++ .../ScreenMembersOnOrganizationSelection.mdx | 70 ++ .../ScreenMembersOnPasskeyEnrollment.mdx | 58 ++ .../ScreenMembersOnPasskeyEnrollmentLocal.mdx | 50 ++ ...creenMembersOnPhoneIdentifierChallenge.mdx | 65 ++ ...reenMembersOnPhoneIdentifierEnrollment.mdx | 60 ++ .../ScreenMembersOnResetPassword.mdx | 53 ++ .../ScreenMembersOnResetPasswordEmail.mdx | 53 ++ .../ScreenMembersOnResetPasswordError.mdx | 53 ++ ...embersOnResetPasswordMfaEmailChallenge.mdx | 53 ++ ...embersOnResetPasswordMfaPhoneChallenge.mdx | 56 ++ ...ersOnResetPasswordMfaPushChallengePush.mdx | 57 ++ ...nMembersOnResetPasswordMfaSmsChallenge.mdx | 57 ++ ...embersOnResetPasswordMfaVoiceChallenge.mdx | 59 ++ ...etPasswordMfaWebAuthnPlatformChallenge.mdx | 68 ++ ...setPasswordMfaWebAuthnRoamingChallenge.mdx | 72 ++ .../ScreenMembersOnResetPasswordRequest.mdx | 59 ++ .../ScreenMembersOnResetPasswordSuccess.mdx | 45 ++ .../interfaces/ScreenMembersOnSignup.mdx | 50 ++ .../interfaces/ScreenMembersOnSignupId.mdx | 50 ++ .../ScreenMembersOnSignupPassword.mdx | 67 ++ .../interfaces/SelectCountryCodeOptions.mdx | 37 + .../interfaces/SelectMfaEmailOptions.mdx | 34 + .../interfaces/SelectMfaPushDeviceOptions.mdx | 32 + .../interfaces/SelectOrganizationOptions.mdx | 27 + .../js-sdk/interfaces/ShowErrorOptions.mdx | 42 + .../reference/js-sdk/interfaces/SignupId.mdx | 283 +++++++ .../js-sdk/interfaces/SignupIdMembers.mdx | 68 ++ .../js-sdk/interfaces/SignupMembers.mdx | 94 +++ .../js-sdk/interfaces/SignupOptions.mdx | 43 + .../js-sdk/interfaces/SignupPassword.mdx | 238 ++++++ .../interfaces/SignupPasswordMembers.mdx | 60 ++ .../interfaces/SignupPasswordOptions.mdx | 43 + .../js-sdk/interfaces/SocialConnection.mdx | 27 + .../js-sdk/interfaces/StartResendOptions.mdx | 31 + .../interfaces/SubmitCaptchaOptions.mdx | 27 + .../js-sdk/interfaces/SubmitCodeOptions.mdx | 31 + .../js-sdk/interfaces/SubmitOTPOptions.mdx | 35 + .../SubmitPasskeyCredentialOptions.mdx | 23 + .../js-sdk/interfaces/TenantContext.mdx | 35 + .../js-sdk/interfaces/TenantMembers.mdx | 35 + .../js-sdk/interfaces/TransactionContext.mdx | 43 + .../interfaces/TransactionContextOnLogin.mdx | 38 + .../TransactionContextOnLoginPassword.mdx | 38 + .../js-sdk/interfaces/TransactionMembers.mdx | 55 ++ .../interfaces/TransactionMembersOnLogin.mdx | 66 ++ .../TransactionMembersOnLoginId.mdx | 70 ++ .../TransactionMembersOnLoginPassword.mdx | 70 ++ ...ionMembersOnLoginPasswordlessEmailCode.mdx | 50 ++ ...actionMembersOnLoginPasswordlessSmsOtp.mdx | 50 ++ .../TransactionMembersOnResetPassword.mdx | 50 ++ ...ansactionMembersOnResetPasswordRequest.mdx | 58 ++ .../interfaces/TransactionMembersOnSignup.mdx | 66 ++ .../TransactionMembersOnSignupId.mdx | 62 ++ .../TransactionMembersOnSignupPassword.mdx | 62 ++ .../interfaces/TryAnotherMethodOptions.mdx | 33 + .../interfaces/UntrustedDataContext.mdx | 45 ++ .../interfaces/UntrustedDataMembers.mdx | 42 + ...ntrustedDataMembersOnMfaEmailChallenge.mdx | 40 + .../UntrustedDataMembersOnMfaOtpChallenge.mdx | 40 + ...ustedDataMembersOnMfaPushChallengePush.mdx | 41 + .../UntrustedDataMembersOnMfaSmsChallenge.mdx | 40 + ...ntrustedDataMembersOnMfaVoiceChallenge.mdx | 40 + .../interfaces/UseSecurityKeyOptions.mdx | 34 + .../js-sdk/interfaces/UserContext.mdx | 67 ++ .../js-sdk/interfaces/UserMembers.mdx | 71 ++ .../js-sdk/interfaces/UsernamePolicy.mdx | 44 ++ .../interfaces/UsernameValidationError.mdx | 49 ++ .../interfaces/UsernameValidationResult.mdx | 39 + .../VerifyPlatformAuthenticatorOptions.mdx | 32 + .../interfaces/VerifySecurityKeyOptions.mdx | 26 + .../interfaces/WebAuthnErrorDetails.mdx | 43 + .../js-sdk/interfaces/WithRememberOptions.mdx | 26 + .../reference/js-sdk/navigation.json | 581 ++++++++++++++ .../js-sdk/types/AuthenticatorTransport.mdx | 14 + .../js-sdk/types/Base64URLString.mdx | 14 + .../reference/js-sdk/types/IdentifierType.mdx | 14 + .../js-sdk/types/MfaPollingOptions.mdx | 45 ++ .../js-sdk/types/OnStatusChangeCallback.mdx | 14 + .../reference/js-sdk/types/WebAuthnType.mdx | 14 + .../reference/react-sdk/README.md | 50 ++ .../react-sdk/classes/ContextHooks.mdx | 46 ++ .../react-sdk/classes/ErrorStore.mdx | 95 +++ .../functions/abortPasskeyEnrollment.mdx | 18 + .../reference/react-sdk/functions/accept.mdx | 18 + .../react-sdk/functions/acceptInvitation.mdx | 18 + .../react-sdk/functions/backAction.mdx | 18 + .../react-sdk/functions/backToLogin.mdx | 18 + .../reference/react-sdk/functions/cancel.mdx | 18 + .../react-sdk/functions/classifyKind.mdx | 18 + .../react-sdk/functions/clearScreen.mdx | 15 + .../reference/react-sdk/functions/confirm.mdx | 18 + .../react-sdk/functions/confirmLogout.mdx | 18 + .../functions/continueEnrollment.mdx | 24 + .../react-sdk/functions/continueMethod.mdx | 18 + .../functions/continueMfaSmsChallenge.mdx | 18 + .../functions/continuePasskeyEnrollment.mdx | 18 + .../functions/continuePhoneEnrollment.mdx | 18 + .../react-sdk/functions/continueWithCode.mdx | 18 + .../functions/continueWithNewNickname.mdx | 18 + .../continueWithOrganizationName.mdx | 18 + .../functions/continueWithPasskey.mdx | 18 + .../reference/react-sdk/functions/deny.mdx | 18 + .../functions/detectCapabilities.mdx | 18 + .../reference/react-sdk/functions/enroll.mdx | 18 + .../react-sdk/functions/enterCodeManually.mdx | 18 + .../react-sdk/functions/federatedLogin.mdx | 18 + .../react-sdk/functions/federatedSignup.mdx | 18 + .../react-sdk/functions/filterByField.mdx | 21 + .../react-sdk/functions/getACall.mdx | 18 + .../react-sdk/functions/getScreen.mdx | 15 + .../reference/react-sdk/functions/goBack.mdx | 18 + .../react-sdk/functions/listsEqual.mdx | 21 + .../reference/react-sdk/functions/login.mdx | 18 + .../react-sdk/functions/noThanks.mdx | 18 + .../react-sdk/functions/passkeyLogin.mdx | 18 + .../react-sdk/functions/pickAuthenticator.mdx | 18 + .../react-sdk/functions/pickCountryCode.mdx | 18 + .../react-sdk/functions/pickEmail.mdx | 18 + .../react-sdk/functions/pickPhone.mdx | 18 + .../reference/react-sdk/functions/pickSms.mdx | 18 + .../refuseEnrollmentOnThisDevice.mdx | 18 + .../react-sdk/functions/registerScreen.mdx | 18 + .../functions/reportBrowserError.mdx | 18 + .../functions/reportWebAuthnError.mdx | 18 + .../react-sdk/functions/resendCode.mdx | 18 + .../react-sdk/functions/resendEmail.mdx | 18 + .../react-sdk/functions/resendOTP.mdx | 18 + .../functions/resendPushNotification.mdx | 18 + .../react-sdk/functions/resetPassword.mdx | 18 + .../react-sdk/functions/returnToPrevious.mdx | 18 + .../react-sdk/functions/selectCountryCode.mdx | 18 + .../react-sdk/functions/selectMfaEmail.mdx | 18 + .../functions/selectMfaPushDevice.mdx | 18 + .../functions/selectOrganization.mdx | 24 + .../functions/selectPhoneCountryCode.mdx | 18 + .../react-sdk/functions/selectPhoneNumber.mdx | 18 + .../react-sdk/functions/showError.mdx | 18 + .../reference/react-sdk/functions/signup.mdx | 18 + .../functions/skipOrganizationSelection.mdx | 18 + .../react-sdk/functions/snoozeEnrollment.mdx | 18 + .../react-sdk/functions/submitCode.mdx | 18 + .../functions/submitEmailChallenge.mdx | 18 + .../react-sdk/functions/submitOTP.mdx | 18 + .../functions/submitPasskeyCredential.mdx | 18 + .../functions/submitPhoneChallenge.mdx | 18 + .../react-sdk/functions/switchToSms.mdx | 18 + .../react-sdk/functions/switchToText.mdx | 18 + .../react-sdk/functions/switchToVoice.mdx | 18 + .../react-sdk/functions/toErrorObject.mdx | 18 + .../react-sdk/functions/toggleView.mdx | 18 + .../react-sdk/functions/tryAgain.mdx | 18 + .../react-sdk/functions/tryAnotherMethod.mdx | 18 + .../functions/useAcceptInvitation.mdx | 15 + .../react-sdk/functions/useAuth0Themes.mdx | 15 + .../react-sdk/functions/useConsent.mdx | 15 + .../react-sdk/functions/useCurrentScreen.mdx | 15 + .../functions/useCustomizedConsent.mdx | 15 + .../functions/useDeviceCodeActivation.mdx | 15 + .../useDeviceCodeActivationAllowed.mdx | 15 + .../useDeviceCodeActivationDenied.mdx | 15 + .../functions/useDeviceCodeConfirmation.mdx | 15 + .../functions/useEmailIdentifierChallenge.mdx | 15 + .../functions/useEmailOTPChallenge.mdx | 15 + .../functions/useEmailVerificationResult.mdx | 15 + .../react-sdk/functions/useErrors.mdx | 18 + .../functions/useInterstitialCaptcha.mdx | 15 + .../react-sdk/functions/useLogin.mdx | 15 + .../functions/useLoginEmailVerification.mdx | 15 + .../react-sdk/functions/useLoginId.mdx | 15 + .../functions/useLoginIdentifiers.mdx | 15 + .../react-sdk/functions/useLoginPassword.mdx | 15 + .../useLoginPasswordlessEmailCode.mdx | 15 + .../functions/useLoginPasswordlessSmsOtp.mdx | 15 + .../react-sdk/functions/useLogout.mdx | 15 + .../react-sdk/functions/useLogoutAborted.mdx | 15 + .../react-sdk/functions/useLogoutComplete.mdx | 15 + .../functions/useMfaBeginEnrollOptions.mdx | 15 + .../functions/useMfaCountryCodes.mdx | 15 + .../useMfaDetectBrowserCapabilities.mdx | 15 + .../functions/useMfaEmailChallenge.mdx | 15 + .../react-sdk/functions/useMfaEmailList.mdx | 15 + .../functions/useMfaEnrollResult.mdx | 15 + .../functions/useMfaLoginOptions.mdx | 15 + .../functions/useMfaOtpChallenge.mdx | 15 + .../functions/useMfaOtpEnrollmentCode.mdx | 15 + .../functions/useMfaOtpEnrollmentQr.mdx | 15 + .../functions/useMfaPhoneChallenge.mdx | 15 + .../functions/useMfaPhoneEnrollment.mdx | 15 + .../react-sdk/functions/useMfaPolling.mdx | 18 + .../functions/useMfaPushChallengePush.mdx | 15 + .../functions/useMfaPushEnrollmentQr.mdx | 15 + .../react-sdk/functions/useMfaPushList.mdx | 15 + .../react-sdk/functions/useMfaPushWelcome.mdx | 15 + .../functions/useMfaRecoveryCodeChallenge.mdx | 15 + .../useMfaRecoveryCodeChallengeNewCode.mdx | 15 + .../useMfaRecoveryCodeEnrollment.mdx | 15 + .../functions/useMfaSmsChallenge.mdx | 15 + .../functions/useMfaSmsEnrollment.mdx | 15 + .../react-sdk/functions/useMfaSmsList.mdx | 15 + .../functions/useMfaVoiceChallenge.mdx | 15 + .../functions/useMfaVoiceEnrollment.mdx | 15 + .../useMfaWebAuthnChangeKeyNickname.mdx | 15 + .../useMfaWebAuthnEnrollmentSuccess.mdx | 15 + .../functions/useMfaWebAuthnError.mdx | 15 + .../useMfaWebAuthnNotAvailableError.mdx | 15 + .../useMfaWebAuthnPlatformChallenge.mdx | 15 + .../useMfaWebAuthnPlatformEnrollment.mdx | 15 + .../useMfaWebAuthnRoamingChallenge.mdx | 15 + .../useMfaWebAuthnRoamingEnrollment.mdx | 15 + .../functions/useOrganizationPicker.mdx | 15 + .../functions/useOrganizationSelection.mdx | 15 + .../functions/usePasskeyEnrollment.mdx | 15 + .../functions/usePasskeyEnrollmentLocal.mdx | 15 + .../react-sdk/functions/usePassword.mdx | 18 + .../functions/usePasswordValidation.mdx | 25 + .../functions/usePhoneIdentifierChallenge.mdx | 15 + .../usePhoneIdentifierEnrollment.mdx | 15 + .../react-sdk/functions/useRedeemTicket.mdx | 15 + .../react-sdk/functions/useResend.mdx | 18 + .../react-sdk/functions/useResetPassword.mdx | 15 + .../functions/useResetPasswordEmail.mdx | 15 + .../functions/useResetPasswordError.mdx | 15 + .../useResetPasswordMfaEmailChallenge.mdx | 15 + .../useResetPasswordMfaOtpChallenge.mdx | 15 + .../useResetPasswordMfaPhoneChallenge.mdx | 15 + .../useResetPasswordMfaPushChallengePush.mdx | 15 + ...eResetPasswordMfaRecoveryCodeChallenge.mdx | 15 + .../useResetPasswordMfaSmsChallenge.mdx | 15 + .../useResetPasswordMfaVoiceChallenge.mdx | 15 + ...etPasswordMfaWebAuthnPlatformChallenge.mdx | 15 + ...setPasswordMfaWebAuthnRoamingChallenge.mdx | 15 + .../functions/useResetPasswordRequest.mdx | 15 + .../functions/useResetPasswordSuccess.mdx | 15 + .../react-sdk/functions/useSecurityKey.mdx | 18 + .../react-sdk/functions/useSignup.mdx | 15 + .../react-sdk/functions/useSignupId.mdx | 15 + .../functions/useSignupIdentifiers.mdx | 15 + .../react-sdk/functions/useSignupPassword.mdx | 15 + .../functions/useUsernameValidation.mdx | 25 + .../reference/react-sdk/functions/verify.mdx | 18 + .../react-sdk/functions/withError.mdx | 18 + .../react-sdk/hooks/useAuth0Themes.mdx | 55 ++ .../react-sdk/hooks/useCurrentScreen.mdx | 82 ++ .../reference/react-sdk/hooks/useErrors.mdx | 70 ++ .../react-sdk/hooks/useLoginIdentifiers.mdx | 35 + .../react-sdk/hooks/useMfaPolling.mdx | 75 ++ .../react-sdk/hooks/usePasswordValidation.mdx | 47 ++ .../reference/react-sdk/hooks/useResend.mdx | 64 ++ .../react-sdk/hooks/useSignupIdentifiers.mdx | 42 + .../react-sdk/hooks/useUsernameValidation.mdx | 69 ++ .../react-sdk/interfaces/ErrorItem.mdx | 31 + .../react-sdk/interfaces/ErrorsResult.mdx | 27 + .../react-sdk/interfaces/MfaPollingResult.mdx | 55 ++ .../react-sdk/interfaces/UseErrorOptions.mdx | 23 + .../react-sdk/interfaces/UseErrorsResult.mdx | 35 + .../react-sdk/interfaces/UseResendOptions.mdx | 37 + .../react-sdk/interfaces/UseResendReturn.mdx | 37 + .../interfaces/WithLoginIdentifiers.mdx | 23 + .../interfaces/WithResendManager.mdx | 23 + .../interfaces/WithSignupIdentifiers.mdx | 23 + .../interfaces/WithValidatePassword.mdx | 23 + .../interfaces/WithValidateUsername.mdx | 23 + .../reference/react-sdk/navigation.json | 367 +++++++++ .../react-sdk/screens/accept-invitation.mdx | 152 ++++ .../reference/react-sdk/screens/consent.mdx | 154 ++++ .../react-sdk/screens/customized-consent.mdx | 154 ++++ .../device-code-activation-allowed.mdx | 146 ++++ .../screens/device-code-activation-denied.mdx | 146 ++++ .../screens/device-code-activation.mdx | 150 ++++ .../screens/device-code-confirmation.mdx | 158 ++++ .../screens/email-identifier-challenge.mdx | 158 ++++ .../react-sdk/screens/email-otp-challenge.mdx | 158 ++++ .../screens/email-verification-result.mdx | 146 ++++ .../screens/interstitial-captcha.mdx | 146 ++++ .../screens/login-email-verification.mdx | 154 ++++ .../reference/react-sdk/screens/login-id.mdx | 162 ++++ .../react-sdk/screens/login-password.mdx | 154 ++++ .../screens/login-passwordless-email-code.mdx | 154 ++++ .../screens/login-passwordless-sms-otp.mdx | 154 ++++ .../reference/react-sdk/screens/login.mdx | 164 ++++ .../react-sdk/screens/logout-aborted.mdx | 146 ++++ .../react-sdk/screens/logout-complete.mdx | 146 ++++ .../reference/react-sdk/screens/logout.mdx | 152 ++++ .../screens/mfa-begin-enroll-options.mdx | 152 ++++ .../react-sdk/screens/mfa-country-codes.mdx | 158 ++++ .../mfa-detect-browser-capabilities.mdx | 152 ++++ .../react-sdk/screens/mfa-email-challenge.mdx | 168 ++++ .../react-sdk/screens/mfa-email-list.mdx | 158 ++++ .../react-sdk/screens/mfa-enroll-result.mdx | 146 ++++ .../react-sdk/screens/mfa-login-options.mdx | 158 ++++ .../react-sdk/screens/mfa-otp-challenge.mdx | 156 ++++ .../screens/mfa-otp-enrollment-code.mdx | 156 ++++ .../screens/mfa-otp-enrollment-qr.mdx | 162 ++++ .../react-sdk/screens/mfa-phone-challenge.mdx | 158 ++++ .../screens/mfa-phone-enrollment.mdx | 164 ++++ .../screens/mfa-push-challenge-push.mdx | 168 ++++ .../screens/mfa-push-enrollment-qr.mdx | 152 ++++ .../react-sdk/screens/mfa-push-list.mdx | 158 ++++ .../react-sdk/screens/mfa-push-welcome.mdx | 154 ++++ .../mfa-recovery-code-challenge-new-code.mdx | 150 ++++ .../screens/mfa-recovery-code-challenge.mdx | 156 ++++ .../screens/mfa-recovery-code-enrollment.mdx | 150 ++++ .../react-sdk/screens/mfa-sms-challenge.mdx | 166 ++++ .../react-sdk/screens/mfa-sms-enrollment.mdx | 158 ++++ .../react-sdk/screens/mfa-sms-list.mdx | 154 ++++ .../react-sdk/screens/mfa-voice-challenge.mdx | 174 ++++ .../screens/mfa-voice-enrollment.mdx | 162 ++++ .../mfa-webauthn-change-key-nickname.mdx | 150 ++++ .../mfa-webauthn-enrollment-success.mdx | 150 ++++ .../react-sdk/screens/mfa-webauthn-error.mdx | 158 ++++ .../mfa-webauthn-not-available-error.mdx | 150 ++++ .../mfa-webauthn-platform-challenge.mdx | 158 ++++ .../mfa-webauthn-platform-enrollment.mdx | 162 ++++ .../mfa-webauthn-roaming-challenge.mdx | 158 ++++ .../mfa-webauthn-roaming-enrollment.mdx | 164 ++++ .../react-sdk/screens/organization-picker.mdx | 158 ++++ .../screens/organization-selection.mdx | 152 ++++ .../screens/passkey-enrollment-local.mdx | 154 ++++ .../react-sdk/screens/passkey-enrollment.mdx | 154 ++++ .../screens/phone-identifier-challenge.mdx | 166 ++++ .../screens/phone-identifier-enrollment.mdx | 154 ++++ .../react-sdk/screens/redeem-ticket.mdx | 150 ++++ .../screens/reset-password-email.mdx | 150 ++++ .../screens/reset-password-error.mdx | 146 ++++ .../reset-password-mfa-email-challenge.mdx | 162 ++++ .../reset-password-mfa-otp-challenge.mdx | 156 ++++ .../reset-password-mfa-phone-challenge.mdx | 154 ++++ ...reset-password-mfa-push-challenge-push.mdx | 168 ++++ ...t-password-mfa-recovery-code-challenge.mdx | 154 ++++ .../reset-password-mfa-sms-challenge.mdx | 162 ++++ .../reset-password-mfa-voice-challenge.mdx | 168 ++++ ...ssword-mfa-webauthn-platform-challenge.mdx | 158 ++++ ...assword-mfa-webauthn-roaming-challenge.mdx | 154 ++++ .../screens/reset-password-request.mdx | 154 ++++ .../screens/reset-password-success.mdx | 146 ++++ .../react-sdk/screens/reset-password.mdx | 150 ++++ .../reference/react-sdk/screens/signup-id.mdx | 158 ++++ .../react-sdk/screens/signup-password.mdx | 154 ++++ .../reference/react-sdk/screens/signup.mdx | 158 ++++ .../reference/react-sdk/types/Bucket.mdx | 18 + .../reference/react-sdk/types/ErrorKind.mdx | 14 + .../reference/react-sdk/types/Listener.mdx | 14 + .../react-sdk/types/ScreenConstructor.mdx | 14 + 711 files changed, 50391 insertions(+), 2 deletions(-) create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/README.md create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AcceptInvitation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AculError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Auth0ServerError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BaseContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblock.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockFailure.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockSuccess.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Client.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Consent.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/CustomizedConsent.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationAllowed.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationDenied.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeConfirmation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailIdentifierChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailOTPChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailVerificationResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/FormHandler.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/InterstitialCaptcha.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Login.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginEmailVerification.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessEmailCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessSmsOtp.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Logout.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutAborted.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutComplete.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaBeginEnrollOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaCountryCodes.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaDetectBrowserCapabilities.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailList.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEnrollResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaLoginOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentQr.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushChallengePush.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushEnrollmentQr.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushList.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushWelcome.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallengeNewCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsList.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnChangeKeyNickname.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnEnrollmentSuccess.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnNotAvailableError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Organization.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationPicker.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationSelection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollmentLocal.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Prompt.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/RedeemTicket.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordEmail.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaOtpChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPhoneChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPushChallengePush.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaVoiceChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordRequest.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordSuccess.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SDKUsageError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Screen.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Signup.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Tenant.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Transaction.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedData.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/User.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UserInputError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/base64UrlToUint8Array.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPasskeyCredentials.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPollingControl.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createResendControl.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/decodePublicKey.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/extractIdentifiersByStatus.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenBorders.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenColors.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenFonts.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenPageBackground.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenWidget.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getActiveIdentifiers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getAllowedIdentifiers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBackLink.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBrowserCapabilities.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreen.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreenOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getEditIdentifierLink.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getErrors.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getForgotPasswordLink.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginIdentifiers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginLink.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getOptionalIdentifiers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasskeyCredentials.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasswordPolicy.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPublicKey.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getRequiredIdentifiers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getResetPasswordLink.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getScopes.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getShowRememberDevice.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupIdentifiers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupLink.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getUsernamePolicy.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getWebAuthnType.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/hasFlexibleIdentifier.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/internalPoll.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isAuthenticatorAssertionResponse.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isBrave.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isForgotPasswordEnabled.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isJsAvailable.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeyEnabled.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeySupported.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isRunning.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isSignupEnabled.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isUsernameRequired.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthAvailable.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthPlatformAvailable.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/parseErrorMessage.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/registerPasskeyAutofill.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/safeBase64Url.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/startPolling.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/stopPolling.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/uint8ArrayToBase64Url.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/updatePayloadByIdentifier.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validatePassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validateUsername.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AbortEnrollmentOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AcceptInvitationMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AllowCredential.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Branding.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingThemes.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockSuccessMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConditionalMediationCapable.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConfirmLogoutOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConsentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithCodeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithOrganizationNameOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithPasskeyOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CredentialResponse.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CurrentScreenOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomizedConsentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationAllowedMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationDeniedMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeConfirmationMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailChallengeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailIdentifierChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailOTPChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailVerificationResultMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FlattenedTheme.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FormOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/InterstitialCaptchaMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Login.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEmailVerificationMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEnrollOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginIdMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessEmailCodeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessSmsOtpMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutAbortedMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutCompleteMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaBeginEnrollOptionsMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaCountryCodesMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailListMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollResultMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaLoginOptionsMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentCodeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentQrMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushChallengePushMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushEnrollmentQrMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushListMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnErrorMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationPickerMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationSelectionMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Organizations.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OtpCodeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Passkey.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreateResponse.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCredentialResponse.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnroll.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocal.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocalMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyLogin.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordlessConnection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneChallengeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneEnrollmentOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickAuthenticatorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickPhoneOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PostPayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/RedeemTicketMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportWebAuthnErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLogin.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPasswordlessSmsOtp.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnSignupPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnAcceptInvitation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockFailure.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockSuccess.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnConsent.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnCustomizedConsent.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailOTPChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailVerificationResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLogin.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaCountryCodes.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailList.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEnrollResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaLoginOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushChallengePush.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushWelcome.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnOrganizationSelection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordEmail.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordRequest.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordSuccess.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignup.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectCountryCodeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaEmailOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaPushDeviceOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectOrganizationOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupIdMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SocialConnection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCaptchaOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCodeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitOTPOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitPasskeyCredentialOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLogin.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLoginPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLogin.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPasswordRequest.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignup.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UseSecurityKeyOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifyPlatformAuthenticatorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifySecurityKeyOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WithRememberOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/navigation.json create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/AuthenticatorTransport.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/Base64URLString.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/IdentifierType.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/MfaPollingOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/OnStatusChangeCallback.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/WebAuthnType.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/README.md create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ContextHooks.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ErrorStore.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/abortPasskeyEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/accept.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/acceptInvitation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backAction.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backToLogin.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/cancel.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/classifyKind.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/clearScreen.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirm.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirmLogout.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePasskeyEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePhoneEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithNewNickname.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithOrganizationName.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithPasskey.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/deny.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/detectCapabilities.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enterCodeManually.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/filterByField.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getACall.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getScreen.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/listsEqual.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/noThanks.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/passkeyLogin.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickAuthenticator.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickEmail.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickPhone.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickSms.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/refuseEnrollmentOnThisDevice.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/registerScreen.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportWebAuthnError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendEmail.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendOTP.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendPushNotification.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resetPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectCountryCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaEmail.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaPushDevice.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectOrganization.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneCountryCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneNumber.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/showError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/skipOrganizationSelection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/snoozeEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitOTP.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPasskeyCredential.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPhoneChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToSms.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToText.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToVoice.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toErrorObject.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toggleView.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAgain.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAcceptInvitation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAuth0Themes.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useConsent.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCurrentScreen.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCustomizedConsent.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationAllowed.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationDenied.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeConfirmation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailIdentifierChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailOTPChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailVerificationResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useErrors.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useInterstitialCaptcha.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogin.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginEmailVerification.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginIdentifiers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessEmailCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessSmsOtp.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogout.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutAborted.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutComplete.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaBeginEnrollOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaCountryCodes.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaDetectBrowserCapabilities.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailList.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEnrollResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaLoginOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentQr.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPolling.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushChallengePush.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushEnrollmentQr.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushList.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushWelcome.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallengeNewCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsList.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnChangeKeyNickname.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnEnrollmentSuccess.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnNotAvailableError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationPicker.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationSelection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollmentLocal.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasswordValidation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useRedeemTicket.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResend.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordEmail.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaOtpChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPhoneChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPushChallengePush.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaRecoveryCodeChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaVoiceChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnPlatformChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnRoamingChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordRequest.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordSuccess.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSecurityKey.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignup.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupIdentifiers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useUsernameValidation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/verify.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/withError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useAuth0Themes.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useCurrentScreen.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useErrors.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useLoginIdentifiers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useMfaPolling.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/usePasswordValidation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useResend.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useSignupIdentifiers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useUsernameValidation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorsResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/MfaPollingResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorsResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendReturn.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithLoginIdentifiers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithResendManager.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithSignupIdentifiers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidatePassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidateUsername.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/navigation.json create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/accept-invitation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/consent.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/customized-consent.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-allowed.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-denied.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-confirmation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-identifier-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-otp-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-verification-result.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/interstitial-captcha.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-email-verification.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-id.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-password.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-email-code.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-sms-otp.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-aborted.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-complete.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-begin-enroll-options.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-country-codes.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-detect-browser-capabilities.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-list.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-enroll-result.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-login-options.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-code.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-qr.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-enrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-challenge-push.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-enrollment-qr.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-list.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-welcome.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge-new-code.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-enrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-enrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-list.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-enrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-change-key-nickname.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-enrollment-success.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-error.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-not-available-error.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-enrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-enrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-picker.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-selection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment-local.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-enrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/redeem-ticket.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-email.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-error.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-email-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-otp-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-phone-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-push-challenge-push.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-recovery-code-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-sms-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-voice-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-platform-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-roaming-challenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-request.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-success.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-id.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-password.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Bucket.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ErrorKind.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Listener.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ScreenConstructor.mdx diff --git a/.gitignore b/.gitignore index acc02b3ae..81f805eb9 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ temp/ *.py .vite +run_all_instances.sh \ No newline at end of file diff --git a/main/docs.json b/main/docs.json index a909b73f9..71bb30360 100644 --- a/main/docs.json +++ b/main/docs.json @@ -1229,6 +1229,748 @@ "docs/customize/login-pages/advanced-customizations/reference/reset-password-screen-classes", "docs/customize/login-pages/advanced-customizations/reference/signup-screen-classes" ] + }, + { + "group": "@auth0/auth0-acul-js", + "pages": [ + { + "group": "Classes", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BaseContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Client", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Organization", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Prompt", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Screen", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Tenant", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Transaction", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedData", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/User", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AcceptInvitation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblock", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockFailure", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Consent", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/CustomizedConsent", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationAllowed", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationDenied", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeConfirmation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailOTPChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailVerificationResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/InterstitialCaptcha", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Login", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginEmailVerification", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Logout", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutAborted", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutComplete", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaBeginEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaCountryCodes", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaDetectBrowserCapabilities", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailList", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEnrollResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushList", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushWelcome", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallengeNewCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsList", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnChangeKeyNickname", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnEnrollmentSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnNotAvailableError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationPicker", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationSelection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollmentLocal", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/RedeemTicket", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordEmail", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaRecoveryCodeChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Signup", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AculError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UserInputError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SDKUsageError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Auth0ServerError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/FormHandler" + ] + }, + { + "group": "Interfaces", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CurrentScreenOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FlattenedTheme", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingThemes", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Branding", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AllowCredential", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Passkey", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyLogin", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnroll", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordlessConnection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SocialConnection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Organizations", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnAcceptInvitation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AcceptInvitationMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockFailure", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockSuccessMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnConsent", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConsentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnCustomizedConsent", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomizedConsentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationAllowedMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationDeniedMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnDeviceCodeConfirmation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeConfirmationMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailIdentifierChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailOTPChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OtpCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailOTPChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailVerificationResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailVerificationResultMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCaptchaOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/InterstitialCaptchaMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEmailVerificationMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginIdMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessEmailCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitOTPOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessSmsOtpMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Login", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutAbortedMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutCompleteMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConfirmLogoutOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaBeginEnrollOptionsMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaCountryCodes", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectCountryCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaCountryCodesMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaDetectBrowserCapabilitiesMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailList", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaEmailOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailListMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEnrollResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollResultMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaLoginOptionsMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentQrMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickPhoneOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickAuthenticatorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WithRememberOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushChallengePushMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushEnrollmentQrMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaPushDeviceOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushListMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushWelcome", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeNewCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnChangeKeyNicknameMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnEnrollmentSuccessMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnNotAvailableErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifyPlatformAuthenticatorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitPasskeyCredentialOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifySecurityKeyOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportWebAuthnErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectOrganizationOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationPickerMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithOrganizationNameOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnOrganizationSelection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationSelectionMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocal", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AbortEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollmentLocal", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocalMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/RedeemTicketMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordEmail", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaEmailChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaOtpChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPhoneChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPushChallengePushMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaSmsChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaVoiceChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithPasskeyOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UseSecurityKeyOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupIdMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignup", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignup", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FormOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PostPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCredentialResponse", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CredentialResponse", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreateResponse", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConditionalMediationCapable", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult" + ] + }, + { + "group": "Types", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/Base64URLString", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/AuthenticatorTransport", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/WebAuthnType", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/MfaPollingOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/OnStatusChangeCallback", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/IdentifierType" + ] + }, + { + "group": "Functions", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreen", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreenOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getErrors", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/updatePayloadByIdentifier", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupLink", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBackLink", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginLink", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getResetPasswordLink", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getForgotPasswordLink", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getEditIdentifierLink", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPublicKey", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getShowRememberDevice", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getWebAuthnType", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getScopes", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isSignupEnabled", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isForgotPasswordEnabled", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeyEnabled", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isUsernameRequired", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getUsernamePolicy", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasswordPolicy", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getActiveIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getAllowedIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getRequiredIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getOptionalIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/hasFlexibleIdentifier", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/extractIdentifiersByStatus", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenColors", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenFonts", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenBorders", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenPageBackground", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenWidget", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isBrave", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthAvailable", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isJsAvailable", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthPlatformAvailable", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeySupported", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBrowserCapabilities", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/base64UrlToUint8Array", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/uint8ArrayToBase64Url", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/safeBase64Url", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/decodePublicKey", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isAuthenticatorAssertionResponse", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasskeyCredentials", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPasskeyCredentials", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/registerPasskeyAutofill", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPollingControl", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/internalPoll", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/startPolling", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/stopPolling", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isRunning", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/parseErrorMessage", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createResendControl", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validatePassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validateUsername" + ] + } + ] + }, + { + "group": "@auth0/auth0-acul-react", + "pages": [ + { + "group": "Classes", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ErrorStore", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ContextHooks" + ] + }, + { + "group": "Interfaces", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorsResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorsResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithLoginIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/MfaPollingResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendReturn", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithResendManager", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithSignupIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidatePassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidateUsername", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem" + ] + }, + { + "group": "Types", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ErrorKind", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Bucket", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Listener", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ScreenConstructor" + ] + }, + { + "group": "Functions", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/classifyKind", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toErrorObject", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/filterByField", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/withError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/listsEqual", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/registerScreen", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getScreen", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/clearScreen", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/acceptInvitation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAcceptInvitation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/accept", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/deny", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useConsent", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCustomizedConsent", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationAllowed", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationDenied", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirm", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/cancel", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeConfirmation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailOTPChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailVerificationResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useInterstitialCaptcha", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginEmailVerification", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/passkeyLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitOTP", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendOTP", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutAborted", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutComplete", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirmLogout", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogout", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaBeginEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectCountryCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaCountryCodes", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/detectCapabilities", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaDetectBrowserCapabilities", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickEmail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaEmail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailList", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEnrollResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toggleView", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickPhone", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendPushNotification", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enterCodeManually", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickAuthenticator", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaPushDevice", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushList", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushWelcome", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallengeNewCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickSms", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getACall", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneNumber", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backAction", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsList", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToSms", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneCountryCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithNewNickname", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnChangeKeyNickname", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnEnrollmentSuccess", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAgain", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/noThanks", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnNotAvailableError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/verify", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPasskeyCredential", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/snoozeEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/refuseEnrollmentOnThisDevice", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportWebAuthnError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/showError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectOrganization", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/skipOrganizationSelection", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationPicker", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithOrganizationName", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationSelection", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/abortPasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollmentLocal", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToVoice", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToText", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePhoneEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useRedeemTicket", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendEmail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordEmail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaRecoveryCodeChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithPasskey", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSecurityKey", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resetPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backToLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordSuccess", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignup" + ] + }, + { + "group": "Screens", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/accept-invitation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/consent", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/customized-consent", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-allowed", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-denied", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-confirmation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-identifier-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-otp-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-verification-result", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/interstitial-captcha", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-email-verification", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-id", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-password", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-email-code", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-sms-otp", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-aborted", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-complete", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-begin-enroll-options", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-country-codes", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-detect-browser-capabilities", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-list", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-enroll-result", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-login-options", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-code", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-qr", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-challenge-push", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-enrollment-qr", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-list", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-welcome", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge-new-code", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-list", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-change-key-nickname", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-enrollment-success", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-error", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-not-available-error", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-picker", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-selection", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment-local", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/redeem-ticket", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-email", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-error", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-email-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-otp-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-phone-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-push-challenge-push", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-recovery-code-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-sms-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-voice-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-platform-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-roaming-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-request", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-success", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-id", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-password", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup" + ] + } + ] } ] } @@ -24187,8 +24929,8 @@ "destination": "/docs/ja-jp/get-started/auth0-for-ai-agents" }, { - "source": "/docs/secure/security-guidance/measures-against-application-impersonation", + "source": "/docs/secure/security-guidance/measures-against-application-impersonation", "destination": "/docs/secure/security-guidance/measures-against-app-impersonation" } ] -} +} \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/README.md b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/README.md new file mode 100644 index 000000000..6a71459ab --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/README.md @@ -0,0 +1,46 @@ +# Auth0 ACUL JS Documentation + +Generated on 11/11/2025, 10:36:08 AM + +## Classes (162) + +- [BaseContext](./classes/BaseContext.mdx) +- [Branding](./classes/Branding.mdx) +- [Client](./classes/Client.mdx) +- [Organization](./classes/Organization.mdx) +- [Prompt](./classes/Prompt.mdx) +- [Screen](./classes/Screen.mdx) +- [Tenant](./classes/Tenant.mdx) +- [Transaction](./classes/Transaction.mdx) +- [UntrustedData](./classes/UntrustedData.mdx) +- [User](./classes/User.mdx) +- ... and 152 more + +## Interfaces (332) + +- [CustomOptions](./interfaces/CustomOptions.mdx) +- [WebAuthnErrorDetails](./interfaces/WebAuthnErrorDetails.mdx) +- [CurrentScreenOptions](./interfaces/CurrentScreenOptions.mdx) +- [FlattenedTheme](./interfaces/FlattenedTheme.mdx) +- [BaseContext](./interfaces/BaseContext.mdx) +- [BaseMembers](./interfaces/BaseMembers.mdx) +- [BrandingContext](./interfaces/BrandingContext.mdx) +- [BrandingSettings](./interfaces/BrandingSettings.mdx) +- [BrandingThemes](./interfaces/BrandingThemes.mdx) +- [BrandingMembers](./interfaces/BrandingMembers.mdx) +- ... and 322 more + +## Functions (56) + +- [getCurrentScreen](./functions/getCurrentScreen.mdx) +- [getCurrentScreenOptions](./functions/getCurrentScreenOptions.mdx) +- [getErrors](./functions/getErrors.mdx) +- [updatePayloadByIdentifier](./functions/updatePayloadByIdentifier.mdx) +- [getSignupLink](./functions/getSignupLink.mdx) +- [getBackLink](./functions/getBackLink.mdx) +- [getLoginLink](./functions/getLoginLink.mdx) +- [getResetPasswordLink](./functions/getResetPasswordLink.mdx) +- [getForgotPasswordLink](./functions/getForgotPasswordLink.mdx) +- [getEditIdentifierLink](./functions/getEditIdentifierLink.mdx) +- ... and 46 more + diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AcceptInvitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AcceptInvitation.mdx new file mode 100644 index 000000000..1d9442952 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AcceptInvitation.mdx @@ -0,0 +1,131 @@ +--- +title: "AcceptInvitation" +description: "Class implementing the accept-invitation screen functionality. This screen is displayed when a user needs to accept an invitation to an organization." +--- + + + +```tsx React Component Example with TailwindCSS lines +import React from 'react'; +import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation'; + +const AcceptInvitationScreen: React.FC = () => { + const acceptInvitationManager = new AcceptInvitation(); + const { screen, transaction } = acceptInvitationManager; + + const handleAcceptInvitation = async () => { + await acceptInvitationManager.acceptInvitation(); + }; + + return ( +
+
+

{screen?.texts?.title ?? "You've Been Invited!"}

+

+ {screen?.texts?.description ?? 'XXXXXX has invited you (XXXXXXX) to join Second XXXXXX on XXXXXX.'} +

+

+ Inviter: {screen.data?.inviter} +

+

+ Email: {screen.data?.email} +

+ + + {transaction?.errors?.length && ( +
+ {transaction?.errors.map((err, index) => ( +

+ {err.message} +

+ ))} +
+ )} +
+
+ ); +}; + +export default AcceptInvitationScreen; +``` + +```typescript Accept Invitation lines +import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation'; + +const acceptInvitation = new AcceptInvitation(); + +// Accept the invitation +await acceptInvitation.acceptInvitation(); +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Accepts the invitation to the organization. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/accept-invitation/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/accept-invitation/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AculError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AculError.mdx new file mode 100644 index 000000000..5e8a69d44 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AculError.mdx @@ -0,0 +1,16 @@ +--- +title: "AculError" +description: "" +--- + +## Properties + +string} required> + + +string}> + + +--- + +**File:** [src/utils/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Auth0ServerError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Auth0ServerError.mdx new file mode 100644 index 000000000..22059f8e2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Auth0ServerError.mdx @@ -0,0 +1,16 @@ +--- +title: "Auth0ServerError" +description: "" +--- + +## Properties + +any} required> + + +string}> + + +--- + +**File:** [src/utils/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BaseContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BaseContext.mdx new file mode 100644 index 000000000..34b192f43 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BaseContext.mdx @@ -0,0 +1,60 @@ +--- +title: "BaseContext" +description: "" +--- + +## Properties + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +string} required> + Identifier for the current screen, used to verify correct screen imports + + +## Methods + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/models/base-context.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/base-context.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding.mdx new file mode 100644 index 000000000..2e80bc5e8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding.mdx @@ -0,0 +1,38 @@ +--- +title: "Branding" +description: "" +--- + +## Properties + +BrandingMembers['settings']} required> + Branding settings like colors, logo URLs, etc. + + +BrandingMembers['themes']} required> + Branding themes defining the visual appearance + + +## Methods + +BrandingMembers['settings']}> + @static + + + BrandingContext | undefined}> + + + + +BrandingMembers['themes']}> + @static + + + BrandingContext | undefined}> + + + + +--- + +**File:** [src/models/branding.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/branding.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblock.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblock.mdx new file mode 100644 index 000000000..bc160be3d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblock.mdx @@ -0,0 +1,151 @@ +--- +title: "BruteForceProtectionUnblock" +description: "Represents the BruteForceProtectionUnblock screen. This class provides methods to interact with the brute-force protection unblock screen, such as submitting the unblock request." +--- + + + +```typescript unblock Account lines +import BruteForceProtectionUnblock from '@auth0/auth0-acul-js/brute-force-protection-unblock'; + +const unblockScreen = new BruteForceProtectionUnblock(); +unblockScreen.unblockAccount({}).then(() => { + console.log('Account unblock request submitted successfully.'); +}).catch((error) => { + console.error('Failed to submit account unblock request:', error); +}); +``` + +```tsx React Component Example with TailwindCSS lines +import React, { useState } from 'react'; +import BruteForceProtectionUnblock from '@auth0/auth0-acul-js/brute-force-protection-unblock'; + +const UnblockAccountScreen: React.FC = () => { + const [loading, setLoading] = useState(false); + const [error, setError] = useState(null); + const [success, setSuccess] = useState(false); + const unblockScreen = new BruteForceProtectionUnblock(); + + const handleUnblockAccount = async () => { + setLoading(true); + setError(null); + setSuccess(false); + + try { + await unblockScreen.unblockAccount(); + setSuccess(true); + } catch (e: any) { + setError(e.message || 'Failed to unblock account.'); + } finally { + setLoading(false); + } + }; + + return ( +
+
+

+ Unblock Account +

+ + { + error && ( +
+ Error! + {error} +
+ ) + } + + { + success && ( +
+ Success! + Account unblocked successfully. +
+ ) + } + + +
+
+ ); +}; + +export default UnblockAccountScreen; +``` + + + +## Properties + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +string} required> + Identifier for the current screen, used to verify correct screen imports + + +## Methods + +Promise<void>}> + Submits the unblock request. This method sends a request to unblock the account associated with the current transaction. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/brute-force-protection-unblock/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/brute-force-protection-unblock/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockFailure.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockFailure.mdx new file mode 100644 index 000000000..248fb7f7d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockFailure.mdx @@ -0,0 +1,89 @@ +--- +title: "BruteForceProtectionUnblockFailure" +description: "Represents the Brute Force Protection Unblock Failure screen." +--- + + + +```tsx React Component Example with TailwindCSS lines +import React from 'react'; +import BruteForceProtectionUnblockFailure from '@auth0/auth0-acul-js/brute-force-protection-unblock-failure'; + +const BruteForceProtectionUnblockFailureScreen: React.FC = () => { + const bruteForceProtectionUnblockFailure = new BruteForceProtectionUnblockFailure(); + const { screen } = bruteForceProtectionUnblockFailure; + const errorType = screen.data?.errorType; + + return ( +
+
+

Brute Force Protection

+

+ {errorType ? `Error Type: ${errorType}` : 'Unknown Error'} +

+
+
+ ); +}; + +export default BruteForceProtectionUnblockFailureScreen; +``` + + + +## Properties + +ScreenOptions} required> + The screen interface for the Brute Force Protection Unblock Failure screen. + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +string} required> + Identifier for the current screen, used to verify correct screen imports + + +## Methods + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/brute-force-protection-unblock-failure/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/brute-force-protection-unblock-failure/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockSuccess.mdx new file mode 100644 index 000000000..945395e73 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockSuccess.mdx @@ -0,0 +1,86 @@ +--- +title: "BruteForceProtectionUnblockSuccess" +description: "Represents the Brute Force Protection Unblock Success screen. This screen is displayed when a user successfully unblocks their account after brute force protection measures were triggered." +--- + + + +```typescript typescript lines +import BruteForceProtectionUnblockSuccess from '@auth0/auth0-acul-js/brute-force-protection-unblock-success'; + +const BruteForceProtectionUnblockSuccessManager = new BruteForceProtectionUnblockSuccess(); +const { screen } = BruteForceProtectionUnblockSuccessManager; + +const BruteForceProtectionUnblockSuccessScreen = () => { + return ( +
+
+

Brute Force Protection Unblock Success Screen

+
+

The account has been unblocked successfully.

+
+
+
+ ); +}; + +export default BruteForceProtectionUnblockSuccessScreen; +``` + + + +## Properties + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +string} required> + Identifier for the current screen, used to verify correct screen imports + + +## Methods + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/brute-force-protection-unblock-success/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/brute-force-protection-unblock-success/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Client.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Client.mdx new file mode 100644 index 000000000..fdb4eac8a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Client.mdx @@ -0,0 +1,30 @@ +--- +title: "Client" +description: "" +--- + +## Properties + +ClientMembers['id']} required> + The unique identifier of the client + + +ClientMembers['name']} required> + The name of the client + + +ClientMembers['logoUrl']} required> + URL to the client's logo, if available + + +ClientMembers['description']} required> + Description of the client, if available + + +ClientMembers['metadata']} required> + @property | null} metadata - Custom metadata associated with the client + + +--- + +**File:** [src/models/client.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/client.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Consent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Consent.mdx new file mode 100644 index 000000000..d8df3ad08 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Consent.mdx @@ -0,0 +1,273 @@ +--- +title: "Consent" +description: "" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useMemo } from 'react'; +import Consent from '@auth0/auth0-acul-js/consent'; +import type { Scope } from '@auth0/auth0-acul-js/consent'; // Import Scope type + +const ConsentScreen: React.FC = () => { + // Instantiate the SDK class for the Consent screen. + // useMemo ensures it's only created once per component instance. + const consentManager = useMemo(() => new Consent(), []); + + const { client, organization, screen, transaction, user } = consentManager; + const texts = screen.texts ?? {}; // UI texts from Auth0 dashboard + + const handleAccept = () => { + consentManager.accept(); + }; + + const handleDecline = () => { + consentManager.deny(); + }; + + const pageTitle = texts.title ?? 'Authorize Application'; + const description = texts.description ?? `${client.name || 'The application'} is requesting access to your account.`; + const acceptButtonText = texts.acceptButtonText ?? 'Allow'; + const declineButtonText = texts.declineButtonText ?? 'Deny'; + + return ( +
+
+ {/* Client Logo and Name */} +
+ {client.logoUrl && ( + {`${client.name + )} +

{pageTitle}

+
+ + {/* User and Organization Info */} +
+

{description}

+ {user.email &&

You are logged in as {user.email}.

} + {organization?.name && ( +

+ This access is being requested on behalf of the organization: {organization.displayName || organization.name}. +

+ )} +
+ + {/* Scopes (Permissions) Section */} + {!screen?.hideScopes && screen.scopes.length > 0 && ( +
+

+ {texts.scopesTitle ?? 'This application will be ableto:'} +

+
    + {screen.scopes.map((scope: Scope) => ( +
  • + + + +
    +

    {scope.value}

    +

    {scope.description}

    +
    +
    • + ))} +
+
+ )} + {screen?.hideScopes && ( +

+ {texts.scopesHiddenMessage ?? 'This application is requesting standard permissions.'} +

+ )} + + + {/* Display transaction errors (e.g., from server validation) */} + {transaction.errors && transaction.errors.length > 0 && ( +
+

{texts.alertListTitle ?? 'Errors:'}

+
    + {transaction.errors.map((err, index) => ( +
  • {err.message}
    • + ))} +
+
+ )} + + {/* Action Buttons */} +
+ + +
+
+
+ ); +}; + +export default ConsentScreen; +``` + +```typescript Initialize the SDK Class lines +import Consent from '@auth0/auth0-acul-js/consent'; + +const consentManager = new Consent(); + +// You can now access screen, client information, user details, etc. +const clientName = consentManager.client.name; +const userEmail = consentManager.user.email; +const requestedScopes = consentManager.screen?.scopes; +const shouldHideScopes = consentManager.screen?.hideScopes; + +console.log(`${clientName} is requesting consent from ${userEmail}.`); +if (shouldHideScopes) { + console.log("Scope details are hidden."); +} else if (requestedScopes) { + console.log("Requested permissions:"); + requestedScopes.forEach(scope => { + console.log(`- ${scope.description} (${scope.value})`); + }); +} + +// Check for errors from a previous submission attempt: +const errors = consentManager.transaction.errors; +if (errors && errors.length > 0) { + errors.forEach(err => console.error(`Error: ${err.message}`)); +} +``` + +```typescript Accept Consent lines +import Consent from '@auth0/auth0-acul-js/consent'; +import type { CustomOptions } from '@auth0/auth0-acul-js'; // For payload type + +const consentManager = new Consent(); + +async function grantConsent() { + // Optionally, provide custom parameters if your flow requires them + const payload: CustomOptions = { + // custom_param: "value" + }; + + try { + await consentManager.accept(payload); + // If successful, Auth0 will typically redirect the user. + } catch (error: any) { + // This catch block handles unexpected errors during the submission itself (e.g., network issues). + // Specific validation errors from Auth0 will be available in + // `consentManager.transaction.errors` after the promise resolves or the page reloads. + console.error('Failed to accept consent:', error.message); + } +} + +// Call this function, for example, when the user clicks an "Allow" or "Accept" button. +// grantConsent(); +``` + +```typescript Deny Consent lines +import Consent from '@auth0/auth0-acul-js/consent'; +import type { CustomOptions } from '@auth0/auth0-acul-js'; // For payload type + +const consentManager = new Consent(); + +async function denyConsent() { + // Optionally, provide custom parameters + const payload: CustomOptions = { + // denial_reason_code: "user_rejected" + }; + + try { + await consentManager.deny(payload); + // If successful, Auth0 will typically redirect the user, + // possibly to an error page or back to the application with an access_denied error. + } catch (error: any) { + console.error('Failed to deny consent:', error.message); + } +} + +// Call this function, for example, when the user clicks a "Deny" or "Cancel" button. +// denyConsent(); +``` + + + +## Properties + +string} required> + + +ScreenMembersOnConsent} required> + Holds the specific screen data and properties for the Consent screen, processed by `ScreenOverride`. This includes the list of `scopes` being requested and the `hideScopes` flag. + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Submits the user's decision to accept (grant) the requested permissions. This method prepares and posts form data to the `/u/consent?state=` endpoint with `action: "accept"`. The transaction state is automatically included in both the URL query parameter and the form body. + + + CustomOptions}> + + + + +Promise<void>}> + Submits the user's decision to deny (reject) the requested permissions. This method prepares and posts form data to the `/u/consent?state=` endpoint with `action: "deny"`. The transaction state is automatically included in both the URL query parameter and the form body. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/consent/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/consent/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/CustomizedConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/CustomizedConsent.mdx new file mode 100644 index 000000000..258676fec --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/CustomizedConsent.mdx @@ -0,0 +1,319 @@ +--- +title: "CustomizedConsent" +description: "" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useMemo } from 'react'; +import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent'; +import type { Scope, AuthorizationDetail } from '@auth0/auth0-acul-js/customized-consent'; + +const CustomizedConsentScreen: React.FC = () => { + // Instantiate the SDK class for the Customized Consent screen. + // useMemo ensures it's only created once per component instance. + const consentManager = useMemo(() => new CustomizedConsent(), []); + + const { client, organization, screen, transaction, user } = consentManager; + const texts = screen.texts ?? {}; // UI texts from Auth0 dashboard + const screenData = screen; // Access parsed scopes and authorizationDetails + + const handleAccept = () => { + consentManager.accept(); + }; + + const handleDecline = () => { + consentManager.deny(); + }; + + const pageTitle = texts.title ?? 'Authorize Application'; + const description = texts.description ?? `${client.name || 'The application'} is requesting access to your account and specific resources.`; + const acceptButtonText = texts.acceptButtonText ?? 'Allow Access'; + const declineButtonText = texts.declineButtonText ?? 'Deny Access'; + + return ( +
+
+ {/* Client Logo and Name */} +
+ {client.logoUrl && ( + {`${client.name + )} +

{pageTitle}

+
+ + {/* User and Organization Info */} +
+

{description}

+ {user.email &&

You are logged in as {user.email}.

} + {organization?.name && ( +

+ This access is being requested on behalf of the organization: {organization.displayName || organization.name}. +

+ )} +
+ + {/* Scopes (Permissions) Section */} + {screenData.scopes.length > 0 && ( +
+

+ {texts.scopesTitle ?? 'This application will be able to:'} +

+
    + {screenData.scopes.map((scope: Scope) => ( +
  • + + + +
    +

    {scope.value}

    +

    {scope.description}

    +
    +
    • + ))} +
+
+ )} + + {/* Authorization Details Section */} + {screenData.authorizationDetails.length > 0 && ( +
+

+ {texts.authorizationDetailsTitle ?? 'Specific Authorization Details:'} +

+
+ {screenData.authorizationDetails.map((detail: AuthorizationDetail, index: number) => ( +
+

+ {detail.type.replace(/_/g, ' ')} +

+
    + {Object.entries(detail).map(([key, value]) => { + if (key === 'type') return null; // Skip the type, already displayed + return ( +
  • + {key.replace(/_/g, ' ')}: {value} +
    • + ); + })} +
+
+ ))} +
+
+ )} + + {/* Display transaction errors */} + {transaction.errors && transaction.errors.length > 0 && ( +
+

{texts.alertListTitle ?? 'Errors:'}

+
    + {transaction.errors.map((err, index) => ( +
  • {err.message}
    • + ))} +
+
+ )} + + {/* Action Buttons */} +
+ + +
+
+
+ ); +}; + +export default CustomizedConsentScreen; +``` + +```typescript Initialize the SDK Class and get screen related properties lines +import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent'; + +const consentManager = new CustomizedConsent(); + +// Access client information +const clientName = consentManager.client.name; +const clientLogo = consentManager.client.logoUrl; + +// Access user information +const userEmail = consentManager.user.email; + +// Access organization information (if available) +const organizationName = consentManager.organization?.displayName || consentManager.organization?.name; + +// Access screen-specific data +const requestedScopes = consentManager.screen.scopes; +const authorizationDetails = consentManager.screen.authorizationDetails; +const pageTitleFromTexts = consentManager.screen.texts?.title; + +console.log(`${clientName} is requesting consent from ${userEmail}.`); +if (organizationName) { + console.log(`This request is on behalf of ${organizationName}.`); +} + +console.log("Requested Scopes:"); +requestedScopes.forEach(scope => { + console.log(`- ${scope.description || scope.name} (${scope.name})`); + if (scope.values && scope.values.length > 0) { + console.log(` Values: ${scope.values.join(', ')}`); + } +}); + +console.log("Authorization Details:"); +authorizationDetails.forEach(detail => { + console.log(`- Type: ${detail.type}`); + Object.entries(detail).forEach(([key, value]) => { + if (key !== 'type') { + console.log(` ${key}: ${value}`); + } + }); +}); + +// Check for errors from a previous submission attempt: +const errors = consentManager.transaction.errors; +if (errors && errors.length > 0) { + errors.forEach(err => console.error(`Error: ${err.message} (Code: ${err.code})`)); +} +``` + +```typescript Accept Consent lines +import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent'; +import type { CustomOptions } from '@auth0/auth0-acul-js'; // For payload type + +const consentManager = new CustomizedConsent(); + +async function grantConsent() { + // Optionally, provide custom parameters if your flow requires them + const payload: CustomOptions = { + // custom_param_on_accept: "value" + }; + + try { + await consentManager.accept(payload); + // If successful, Auth0 will typically redirect the user. + } catch (error: any) { + // This catch block handles unexpected errors during the submission itself (e.g., network issues). + // Specific validation errors from Auth0 will be available in + // `consentManager.transaction.errors` after the promise resolves or the page reloads. + console.error('Failed to accept consent:', error.message); + } +} + +// Call this function, for example, when the user clicks an "Allow" or "Accept" button. +// grantConsent(); +``` + +```typescript Decline Consent lines +import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent'; +import type { CustomOptions } from '@auth0/auth0-acul-js'; // For payload type + +const consentManager = new CustomizedConsent(); + +async function denyConsent() { + // Optionally, provide custom parameters + const payload: CustomOptions = { + denial_reason_code: "user_rejected_specifics" + }; + + try { + await consentManager.deny(payload); + // If successful, Auth0 will typically redirect the user, + // possibly to an error page or back to the application with an access_denied error. + } catch (error: any) { + console.error('Failed to deny consent:', error.message); + } +} + +// Call this function, for example, when the user clicks a "Deny" or "Cancel" button. +// denyConsent(); +``` + + + +## Properties + +string} required> + The unique identifier for the Customized Consent screen. This static property is used by the SDK's `BaseContext` to ensure that the class is instantiated in the correct screen context. + + +ScreenMembersOnCustomizedConsent} required> + Holds the specific screen data and properties for the Customized Consent screen, processed by `ScreenOverride`. This includes `scopes` and `authorizationDetails`. + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Submits the user's decision to accept (grant) the requested permissions and authorization details. This method prepares and posts form data to the `/u/customized-consent?state=` endpoint with `action: "accept"`. The transaction state is automatically included in both the URL query parameter and the form body. + + + CustomOptions}> + + + + +Promise<void>}> + Submits the user's decision to deny (reject) the requested permissions and authorization details. This method prepares and posts form data to the `/u/customized-consent?state=` endpoint with `action: "deny"`. The transaction state is automatically included in both the URL query parameter and the form body. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/customized-consent/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/customized-consent/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivation.mdx new file mode 100644 index 000000000..8bed5afc0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivation.mdx @@ -0,0 +1,140 @@ +--- +title: "DeviceCodeActivation" +description: "Class implementing the Device Code Activation screen functionality. This screen is displayed when the user needs to enter the code on their device to activate it." +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useState } from 'react'; +import DeviceCodeActivation from '@auth0/auth0-acul-js/device-code-activation'; + +const DeviceCodeActivationScreen: React.FC = () => { + const [code, setCode] = useState(''); + const deviceCodeActivationManager = new DeviceCodeActivation(); + const { screen, transaction: { errors } } = deviceCodeActivationManager; + const texts = screen.texts ?? {}; + + const handleContinue = () => { + deviceCodeActivationManager.continue({ code }); + }; + + return ( +
+
+

+ {texts.title ?? 'Device Activation'} +

+

+ {texts.description ?? 'Enter the code displayed on your device'} +

+ + setCode(e.target.value)} + /> + + {errors?.length && ( +
+ {errors.map((err, index) => ( +

+ {err.message} +

+ ))} +
+ )} + + +
+
+ ); +}; + +export default DeviceCodeActivationScreen; +``` + +```typescript Continue with Code lines +import DeviceCodeActivation from '@auth0/auth0-acul-js/device-code-activation'; + +const deviceCodeActivation = new DeviceCodeActivation(); + +deviceCodeActivation.continue({ + code: 'HXNL-XWMT', +}); +``` + + + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Submits the device code entered by the user. This action is triggered when the user enters the code displayed on their device and submits the form. + + + ContinueOptions} required> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/device-code-activation/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/device-code-activation/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationAllowed.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationAllowed.mdx new file mode 100644 index 000000000..cda777b9f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationAllowed.mdx @@ -0,0 +1,89 @@ +--- +title: "DeviceCodeActivationAllowed" +description: "Class implementing the Device Code Activation Allowed screen functionality. This screen is displayed when the device code activation is allowed." +--- + + + +```tsx React Component Example with TailwindCSS lines +import React from 'react'; +import DeviceCodeActivationAllowed from '@auth0/auth0-acul-js/device-code-activation-allowed'; + +const DeviceCodeActivationAllowedScreen: React.FC = () => { + const deviceCodeActivationAllowedManager = new DeviceCodeActivationAllowed(); + const { client, screen, organization, prompt, transaction } = deviceCodeActivationAllowedManager; + + return ( +
+
+

Device Code Activation Allowed

+

Client ID: {client.id}

+

Client Name: {client.name}

+ {organization?.id &&

Organization ID: {organization.id}

} +

Prompt Name: {prompt.name}

+

Transaction State: {transaction.state}

+

Screen Name: {screen.name}

+
+
+ ); +}; + +export default DeviceCodeActivationAllowedScreen; +``` + + + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/device-code-activation-allowed/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/device-code-activation-allowed/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationDenied.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationDenied.mdx new file mode 100644 index 000000000..14eb579b4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationDenied.mdx @@ -0,0 +1,84 @@ +--- +title: "DeviceCodeActivationDenied" +description: "Class implementing the Device Code Activation Denied screen functionality. This screen is displayed when the device code activation is denied." +--- + + + +```tsx React Component Example with TailwindCSS lines +import React from 'react'; +import DeviceCodeActivationDenied from '@auth0/auth0-acul-js/device-code-activation-denied'; + +const DeviceCodeActivationDeniedScreen: React.FC = () => { + const deviceCodeActivationDeniedManager = new DeviceCodeActivationDenied(); + const { client, screen, organization, prompt, transaction } = deviceCodeActivationDeniedManager; + + return ( +
+
+

Device Code Activation Denied

+

We are not able to activate your device.

+
+
+ ); +}; + +export default DeviceCodeActivationDeniedScreen; +``` + + + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/device-code-activation-denied/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/device-code-activation-denied/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeConfirmation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeConfirmation.mdx new file mode 100644 index 000000000..07d4a42d8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeConfirmation.mdx @@ -0,0 +1,179 @@ +--- +title: "DeviceCodeConfirmation" +description: "Class implementing the Device Code Confirmation screen functionality. This screen is displayed when the user needs to confirm the device code." +--- + + + +```tsx React Component Example with TailwindCSS lines +import React from 'react'; +import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation'; + +const DeviceCodeConfirmationScreen: React.FC = () => { + const deviceCodeConfirmationManager = new DeviceCodeConfirmation(); + const { screen, transaction: { errors } } = deviceCodeConfirmationManager; + const texts = screen?.texts || {}; + + const handleConfirm = async () => { + await deviceCodeConfirmationManager.confirm(); + }; + + const handleCancel = async () => { + await deviceCodeConfirmationManager.cancel(); + }; + + return ( +
+
+

+ {texts.title ?? 'Device Confirmation'} +

+ + {texts.description && ( +

+ {texts.description} +

+ )} + +
+ + +
+ + {texts.confirmationText && ( +

+ {texts.confirmationText} +

+ )} + + {errors?.length && ( +
+ {errors.map((error, idx) => ( +

+ {error.message} +

+ ))} +
+ )} + +
+ + +
+
+
+ ); +}; + +export default DeviceCodeConfirmationScreen; +``` + +```typescript Confirm Device Code lines +import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation'; + +const deviceCodeConfirmation = new DeviceCodeConfirmation(); + +// Confirm the device code +await deviceCodeConfirmation.confirm(); +``` + +```typescript Cancel Device Code lines +import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation'; + +const deviceCodeConfirmation = new DeviceCodeConfirmation(); + +// Cancel the device code flow +await deviceCodeConfirmation.cancel(); +``` + + + +## Properties + +string} required> + + +screenOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Confirms the device code. + + + CustomOptions}> + + + + +Promise<void>}> + Cancels the device code flow. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/device-code-confirmation/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailIdentifierChallenge.mdx new file mode 100644 index 000000000..9e8a12c01 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailIdentifierChallenge.mdx @@ -0,0 +1,285 @@ +--- +title: "EmailIdentifierChallenge" +description: "" +--- + + + +```typescript submitEmailChallenge lines +import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; + +const emailIdentifierChallenge = new EmailIdentifierChallenge(); +emailIdentifierChallenge.submitEmailChallenge({ + code:"dummyCode" +}); +``` + +```typescript resendCode lines +import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; + +const emailIdentifierChallenge = new EmailIdentifierChallenge(); +emailIdentifierChallenge.resendCode(); +``` + +```typescript returnToPrevious lines +import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; + +const emailIdentifierChallenge = new EmailIdentifierChallenge(); +emailIdentifierChallenge.returnToPrevious(); +``` + +```typescript resendManager lines +import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; + +const emailIdentifierChallenge = new EmailIdentifierChallenge(); + +function handleStatusChange(remainingSeconds: number) { + console.log('Remaining seconds:', remainingSeconds); +} + +function handleTimeout() { + console.log('Resend timeout completed'); +} + +const resendManager = emailIdentifierChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout, +}); + +const { startResend } = resendManager; + +// Use startResend() to initiate the resend with cooldown +startResend(); +``` + +```typescript EmailIdentifierChallenge React Example lines +import React, { useState, useMemo } from 'react'; +import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; + +const EmailIdentifierChallengeScreen: React.FC = () => { + const [code, setCode] = useState(''); + const [error, setError] = useState(''); + const [success, setSuccess] = useState(false); + const [resent, setResent] = useState(false); + const [returned, setReturned] = useState(false); + const [disabled, setDisabled] = useState(false); + + const emailIdentifierChallenge = useMemo(() => new EmailIdentifierChallenge(), []); + + function handleStatusChange(remainingSeconds: number) { + setDisabled(remainingSeconds > 0); + } + + function handleonTimeout() { + console.log('Resend timeout completed'); + } + + const resendManager = useMemo( + () => + emailIdentifierChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleonTimeout, + }), + [emailIdentifierChallenge] + ); + + const { startResend } = resendManager; + + const handleSubmit = async (e: React.FormEvent) => { + e.preventDefault(); + setError(''); + setSuccess(false); + setResent(false); + setReturned(false); + + if (!code) { + setError('Code is required.'); + return; + } + try { + await emailIdentifierChallenge.submitEmailChallenge({ code }); + setSuccess(true); + } catch { + setError('Invalid code. Please try again.'); + } + }; + + const handleResend = async (e: React.FormEvent) => { + e.preventDefault(); + try { + await startResend(); + setResent(true); + } catch (err: any) { + setError(err.message || 'Failed to resend code.'); + } + }; + + const handleReturn = async (e: React.FormEvent) => { + e.preventDefault(); + setError(''); + setSuccess(false); + setResent(false); + setReturned(false); + + try { + await emailIdentifierChallenge.returnToPrevious(); + setReturned(true); + } catch { + setError('Failed to return to previous step. Please try again later.'); + } + }; + + return ( +
+
+

+ Email Identifier Challenge +

+
+
+
+
+
+ +
+ setCode(e.target.value)} + className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> +
+
+ +
+ {/* ✅ Resend with cooldown */} +
+ +
+
+ +
+ {error &&
{error}
} + {success &&
Challenge submitted successfully!
} + {resent &&
Code resent to your email.
} + {returned &&
Returned to previous step.
} +
+
+
+ ); +}; + +export default EmailIdentifierChallengeScreen; +``` + + + +## Properties + +ScreenOptions} required> + + +string} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + + EmailChallengeOptions} required> + + + + +Promise<void>}> + + CustomOptions}> + + + + +Promise<void>}> + + CustomOptions}> + + + + +ResendControl}> + Gets resend functionality with timeout management for this screen + + + StartResendOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/email-identifier-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailOTPChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailOTPChallenge.mdx new file mode 100644 index 000000000..cf54a1f34 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailOTPChallenge.mdx @@ -0,0 +1,86 @@ +--- +title: "EmailOTPChallenge" +description: "Represents the Email OTP Challenge screen." +--- + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Submits the OTP code entered by the user. + + + OtpCodeOptions} required> + + + + +Promise<void>}> + Requests a new OTP code to be sent to the user's email. + + + CustomOptions}> + + + + +ResendControl}> + Gets resend functionality with timeout management for this screen + + + StartResendOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/email-otp-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailVerificationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailVerificationResult.mdx new file mode 100644 index 000000000..57ceecaca --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailVerificationResult.mdx @@ -0,0 +1,184 @@ +--- +title: "EmailVerificationResult" +description: "" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React from 'react'; +import EmailVerificationResult from '@auth0/auth0-acul-js/email-verification-result'; + +const EmailVerificationResultScreen: React.FC = () => { + // Instantiate the SDK class for the Email Verification Result screen + const emailVerificationResultManager = new EmailVerificationResult(); + const { client, screen, transaction, organization } = emailVerificationResultManager; + + // Determine the message and styling based on the verification status + let statusMessage = 'An unexpected error occurred.'; + let statusColor = 'text-gray-700'; // Default color + let title = screen.texts?.title ?? 'Email Verification'; // Default title + + const verificationStatus = screen.data?.status; + const loginLink = screen.loginLink; + + if (verificationStatus === 'success') { + statusMessage = screen.texts?.descriptionSuccess ?? 'Your email has been successfully verified.'; + statusColor = 'text-green-600'; + title = screen.texts?.titleSuccess ?? 'Verification Successful'; + } else if (verificationStatus === 'failure') { + statusMessage = screen.texts?.descriptionFailure ?? 'There was an issue verifying your email. Please try again or contact support.'; + statusColor = 'text-red-600'; + title = screen.texts?.titleFailure ?? 'Verification Failed'; + } else if (verificationStatus === 'already_verified') { + statusMessage = screen.texts?.descriptionAlreadyVerified ?? 'This email address has already been verified.'; + statusColor = 'text-blue-600'; + title = screen.texts?.titleAlreadyVerified ?? 'Email Already Verified'; + } + // Add more status checks as needed based on actual possible values + + const handleGoToLogin = (): void => { + if (loginLink) { + window.location.href = loginLink; + } + }; + + return ( +
+
+ {client.logoUrl && ( + {client.name + )} +

+ {title} +

+ +

+ {statusMessage} +

+ + {organization?.name && ( +

+ Organization: {organization.displayName || organization.name} +

+ )} + + {transaction.errors && transaction.errors.length > 0 && ( +
+ Error(s): + {transaction.errors.map((err, index) => ( +

{err.message}

+ ))} +
+ )} + + {loginLink && ( + + )} +
+
+ ); +}; + +export default EmailVerificationResultScreen; +``` + +```typescript Accessing Screen Information lines +import EmailVerificationResult from '@auth0/auth0-acul-js/email-verification-result'; + +const screenManager = new EmailVerificationResult(); + +// Access client information +console.log('Client Name:', screenManager.client.name); + +// Access organization information (if available) +if (screenManager.organization) { + console.log('Organization Name:', screenManager.organization.name); +} + +// Access prompt information +console.log('Prompt Name:', screenManager.prompt.name); + +// Access screen-specific data +const verificationStatus = screenManager.screen.data?.status; +console.log('Verification Status:', verificationStatus); + +const loginLink = screenManager.screen.loginLink; +if (loginLink) { + console.log('Login Link:', loginLink); + // You can use this link to redirect the user: + // window.location.href = loginLink; +} + +// Access transaction details +console.log('Transaction State:', screenManager.transaction.state); +if (screenManager.transaction.hasErrors && screenManager.transaction.errors) { + screenManager.transaction.errors.forEach(error => { + console.error('Transaction Error:', error.message); + }); +} +``` + + + +## Properties + +string} required> + static + + +ScreenOptions} required> + Holds the specific screen data and properties for the This includes the verification status and the login link. + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/email-verification-result/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/email-verification-result/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/FormHandler.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/FormHandler.mdx new file mode 100644 index 000000000..0874875fd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/FormHandler.mdx @@ -0,0 +1,36 @@ +--- +title: "FormHandler" +description: "" +--- + +## Properties + +FormOptions} required> + + +## Methods + +Promise<void>}> + + T} required> + + + + +HTMLFormElement}> + + PostPayloadOptions} required> + + + + +HTMLFormElement}> + + HTMLFormElement} required> + + + + +--- + +**File:** [src/utils/form-handler.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/form-handler.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/InterstitialCaptcha.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/InterstitialCaptcha.mdx new file mode 100644 index 000000000..d6b040b5f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/InterstitialCaptcha.mdx @@ -0,0 +1,152 @@ +--- +title: "InterstitialCaptcha" +description: "" +--- + + + +```typescript submitCaptcha lines +import InterstitialCaptcha from "@auth0/auth0-acul-js/intersitial-captcha"; + +const interstitialCaptcha = new InterstitialCaptcha(); +interstitialCaptcha.submitCaptcha({ + captcha: "captchaValue", +}); +``` + +```typescript InterstitialCaptcha React Example lines +import React, { useState } from 'react'; +import InterstitialCaptcha from '@auth0/auth0-acul-js/intersitial-captcha'; + +const InterstitialCaptchaScreen: React.FC = () => { + const [captcha, setCaptcha] = useState(''); + const [error, setError] = useState(''); + const [success, setSuccess] = useState(false); + + const interstitialCaptcha = new InterstitialCaptcha(); + + const handleSubmit = async (e) => { + e.preventDefault(); + setError(''); + setSuccess(false); + if (!captcha) { + setError('Captcha is required.'); + return; + } + try { + await interstitialCaptcha.submitCaptcha({ captcha }); + setSuccess(true); + } catch (err) { + setError('Invalid captcha. Please try again.'); + } + }; + + return ( +
+
+

+ Interstitial Captcha +

+
+
+
+
+
+ +
+ setCaptcha(e.target.value)} + className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> +
+
+ +
+ {error &&
{error}
} + {success &&
Captcha submitted successfully!
} +
+
+
+ ); +}; + +export default InterstitialCaptchaScreen; +``` + + + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + This methods handles InterstitialCaptcha related configuration. + + + SubmitCaptchaOptions} required> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/interstitial-captcha/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/interstitial-captcha/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Login.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Login.mdx new file mode 100644 index 000000000..76cb0f300 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Login.mdx @@ -0,0 +1,280 @@ +--- +title: "Login" +description: "Login screen implementation class" +--- + + + +```typescript Basic Login with Username/Password lines +import Login from '@auth0/auth0-acul-js/login'; + +const loginManager = new Login(); + +// Handle form submission and error handling +const errors = loginManager.getErrors(); +const handleSubmit = async (e: React.FormEvent) => { + e.preventDefault(); + + try { + await loginManager.login({ + username: 'user@example.com', + password: 'myPassword123' + }); + } catch (error) { + console.error('Login failed:', error); + } +}; + +return ( +
+ {/* Render the login ID screen content */} + +
+ + + {transaction.alternateConnections && transaction.alternateConnections.length > 0 && ( +
+
+
+
+
+
+ + Or continue with + +
+
+ +
+ {transaction.alternateConnections.map((connection) => ( + + ))} +
+
+ )} +
+ + + ); +}; + +export default LoginScreen; +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + + +TransactionOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Performs login with username/password + + + LoginOptions} required> + + + + +Promise<void>}> + Performs login with social provider + + + FederatedLoginOptions} required> + + + + +Promise<void>}> + Picks country code for phone number input + + + CustomOptions}> + + + + +IdentifierType[] | null}> + Gets the active identifier types for the login screen + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/login/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/login/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginEmailVerification.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginEmailVerification.mdx new file mode 100644 index 000000000..424ba5965 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginEmailVerification.mdx @@ -0,0 +1,378 @@ +--- +title: "LoginEmailVerification" +description: "classdesc Manages interactions for the \"login-email-verification\" screen. This screen prompts the user to enter a one-time code sent to their email address to verify their identity during the login process. It provides methods to submit the entered code (`continueWithCode`) or to request a new code if the original one was not received or has expired (`resendCode`). Inherits from `BaseContext` to access shared authentication flow data like transaction state, client information, and internationalization texts." +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useState, FormEvent, ChangeEvent, useMemo } from 'react'; +import LoginEmailVerification, { ContinueWithCodeOptions, ResendCodeOptions } from '@auth0/auth0-acul-js/login-email-verification'; // Adjust path as necessary + +const LoginEmailVerificationScreen: React.FC = () => { + const [code, setCode] = useState(''); + const [isSubmitting, setIsSubmitting] = useState(false); + const [uiMessages, setUiMessages] = useState<{ type: 'error' | 'success', text: string }[]>([]); + const [disabled, setDisabled] = useState(false); + const [remainingSeconds, setRemainingSeconds] = useState(0); + + // Instantiate the SDK class for the Login Email Verification screen + // This should be done once per component instance. + const [loginEmailVerificationManager] = useState(() => new LoginEmailVerification()); + const { screen, transaction, client } = loginEmailVerificationManager; + + function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { + setDisabled(isDisabled); + setRemainingSeconds(remainingSeconds); + } + + function handleTimeout() { + console.log('Resend timeout completed'); + } + + const resendManager = useMemo( + () => + loginEmailVerificationManager.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout, + }), + [loginEmailVerificationManager] + ); + + const { startResend } = resendManager; + + /** + * Handles the change in the code input field. + */ + const handleCodeChange = (event: ChangeEvent): void => { + setCode(event.target.value); + }; + + /** + * Handles the submission of the verification code. + */ + const handleSubmitCode = async (event: FormEvent): Promise => { + event.preventDefault(); + if (!code.trim()) { + setUiMessages([{ type: 'error', text: screen.texts?.noCodeError || 'Please enter a code.' }]); + return; + } + setIsSubmitting(true); + setUiMessages([]); // Clear previous messages + + try { + const payload: ContinueWithCodeOptions = { code }; + await loginEmailVerificationManager.continueWithCode(payload); + // On successful submission, Auth0 typically handles redirection. + // If the page reloads with errors (e.g., invalid code), the useEffect hook will update uiMessages. + } catch (error: any) { + // Handles unexpected errors (e.g., network issues during form submission) + setUiMessages([{ type: 'error', text: error.message || 'An unexpected error occurred. Please try again.' }]); + } finally { + setIsSubmitting(false); + } + }; + + /** + * Handles the request to resend the verification code. + */ + const handleResendCode = async (): Promise => { + try { + await startResend(); + } catch (error: any) { + setUiMessages([{ type: 'error', text: error.message || 'Failed to resend code. Please try again.' }]); + } + }; + + // Extract texts for UI elements, providing default fallbacks + const texts = screen?.texts ?? {}; + const title = texts.title ?? 'Verify Your Email'; + const description = texts.description ?? `We've sent a verification code to your email address. Please enter it below to continue.`; + const codeLabel = texts.codeLabel ?? 'Verification Code'; + const codePlaceholder = texts.codePlaceholder ?? 'Enter 6-digit code'; + const continueButtonText = texts.buttonText ?? 'Continue'; + const resendButtonText = texts.resendActionText ?? 'Resend Code'; + const submittingText = texts.submittingText ?? 'Processing...'; + + + return ( +
+
+ {client.logoUrl && ( + {client.name + )} +
+

+ {title} +

+

+ {description} +

+
+ +
+
+ + +
+ + {/* Display errors from the transaction object (e.g., invalid state) */} + {transaction.errors && transaction.errors.length > 0 && ( +
+ {transaction.errors.map((err, index) => ( +

{err.message}

+ ))} +
+ )} + + {/* Display errors/success caught during form submission */} + {uiMessages.length > 0 && ( +
+ {uiMessages.map((msg, idx) => ( +
+ {msg.text} +
+ ))} +
+ )} + +
+ +
+
+ +
+ +
+
+
+ ); +}; + +export default LoginEmailVerificationScreen; +``` + +```typescript resendManager lines +import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification'; + +const loginEmailVerification = new LoginEmailVerification(); + +function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); +} + +function handleTimeout() { + console.log('Resend timeout completed'); +} + +const resendManager = loginEmailVerification.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout, +}); + +const { startResend } = resendManager; + +// Use startResend() to initiate the resend with cooldown +startResend(); +``` + +```jsx Initialize the SDK Class lines +import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification'; + +const loginEmailVerificationManager = new LoginEmailVerification(); + +// You can now access screen data, transaction details, etc. +// For example, to get the page title defined in Auth0 dashboard: +const pageTitle = loginEmailVerificationManager.screen.texts?.title; + +// To check for errors from a previous submission attempt: +const errors = loginEmailVerificationManager.transaction.errors; +if (errors && errors.length > 0) { + errors.forEach(err => console.log(`Error: ${err.message}`)); +} +``` + +```jsx Submit Verification Code lines +import LoginEmailVerification, { ContinueWithCodeOptions } from '@auth0/auth0-acul-js/login-email-verification'; + +const loginEmailVerificationManager = new LoginEmailVerification(); +const userEnteredCode = "123456"; // Example code from user input + +const payload: ContinueWithCodeOptions = { + code: userEnteredCode, + // You can add any custom options here if needed + // customParam: "customValue" +}; + +async function submitCode() { + try { + await loginEmailVerificationManager.continueWithCode(payload); + // If the submission is successful and the code is valid, + // Auth0 will typically redirect the user to the next step in the flow. + } catch (error) { + // This catch block handles unexpected errors during the submission itself (e.g., network issues). + // Specific validation errors from Auth0 (like "invalid-code") will be available in + // `loginEmailVerificationManager.transaction.errors` after the promise resolves or the page reloads. + console.error('Failed to submit verification code:', error); + } +} + +submitCode(); +``` + +```jsx Resend Verification Code lines +import LoginEmailVerification, { ResendCodeOptions } from '@auth0/auth0-acul-js/login-email-verification'; + +const loginEmailVerificationManager = new LoginEmailVerification(); + +// Optional: Define any custom options for the resend request +const payload: ResendCodeOptions = { + // customParam: "anotherCustomValue" +}; + +async function resendVerificationCode() { + try { + await loginEmailVerificationManager.resendCode(payload); + // A new code will be sent to the user's email. + // The UI should ideally provide feedback to the user (e.g., "A new code has been sent."). + // If Auth0 encounters an issue (e.g., "too-many-emails"), it will be reflected in + // `loginEmailVerificationManager.transaction.errors` after the page re-renders or the promise resolves. + } catch (error) { + // Handles unexpected errors during the resend request (e.g., network issues). + console.error('Failed to resend verification code:', error); + } +} + +resendVerificationCode(); +``` + + + +## Properties + +string} required> + The unique identifier for the Login Email Verification screen. This static property is used by the SDK's `BaseContext` to ensure that the class is instantiated in the correct screen context. + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Submits the email verification code entered by the user to Auth0. This method prepares and posts the form data, including the verification code and the required `action: "default"`, to the `/u/login-email-verification` endpoint. + + + ContinueWithCodeOptions} required> + + + + +Promise<void>}> + Requests Auth0 to send a new verification code to the user's email address. This is typically used when the user didn't receive the original code, or it has expired. This method posts form data with `action: "resend-code"` to the `/u/login-email-verification` endpoint. + + + ResendCodeOptions}> + + + + +ResendControl}> + Gets resend functionality with timeout management for this screen + + + StartResendOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/login-email-verification/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/login-email-verification/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginId.mdx new file mode 100644 index 000000000..7bc03f8b4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginId.mdx @@ -0,0 +1,178 @@ +--- +title: "LoginId" +description: "" +--- + + + +```typescript login lines +import LoginId from "@auth0/auth0-acul-js/login-id" + +const loginIdManager = new LoginId(); + +loginIdManager.login({ + username: "testUser" +}) +``` + +```typescript error handling lines +import LoginId from "@auth0/auth0-acul-js/login-id" + +const loginIdManager = new LoginId(); +const errors = loginIdManager.getErrors(); + +loginIdManager.login({ + username: "testUser" +}) + +return ( +
+ {/* Render the login ID screen content */} + + +
+ + + + + ); +}; + +export default LoginPasswordlessEmailCodeScreen; +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + + +TransactionOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + + SubmitCodeOptions} required> + + + + +Promise<void>}> + + CustomOptions}> + + + + +ResendControl}> + Creates a resend control manager for handling email code resend operations. + + + StartResendOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/login-passwordless-email-code/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessSmsOtp.mdx new file mode 100644 index 000000000..1fd2d8429 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessSmsOtp.mdx @@ -0,0 +1,264 @@ +--- +title: "LoginPasswordlessSmsOtp" +description: "" +--- + + + +```typescript submitOTP lines +//Creates an instance of LoginPasswordlessSmsOtp and calls the method with sample data. +import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; +const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); + +loginPasswordlessSmsOtp.submitOTP({ + username: "test@domain.com"; + otp: "testOTP"; +}); +``` + +```typescript resendOTP lines +import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; + +const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); +loginPasswordlessSmsOtp.resendOTP(); +``` + +```typescript resendManager lines +import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; + +const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); + +function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); +} + +function handleTimeout() { + console.log('Resend timeout completed'); +} + +const resendManager = loginPasswordlessSmsOtp.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout, +}); + +const { startResend } = resendManager; + +// Use startResend() to initiate the resend with cooldown +startResend(); +``` + +```typescript LoginPasswordlessSmsOtp React Example lines +import React, { useState, useMemo } from 'react'; +import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; + +const LoginPasswordlessSmsOtpScreen: React.FC = () => { + const [username, setUsername] = useState(''); + const [otp, setOtp] = useState(''); + const [error, setError] = useState(''); + const [success, setSuccess] = useState(false); + const [disabled, setDisabled] = useState(false); + const [remainingSeconds, setRemainingSeconds] = useState(0); + + const loginPasswordlessSmsOtp = useMemo(() => new LoginPasswordlessSmsOtp(), []); + + function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { + setDisabled(isDisabled); + setRemainingSeconds(remainingSeconds); + } + + function handleTimeout() { + console.log('Resend timeout completed'); + } + + const resendManager = useMemo( + () => + loginPasswordlessSmsOtp.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout, + }), + [loginPasswordlessSmsOtp] + ); + + const { startResend } = resendManager; + + const handleSubmit = async (e) => { + e.preventDefault(); + setError(''); + setSuccess(false); + + if (!username || !otp) { + setError('Username and OTP are required.'); + return; + } + + try { + await loginPasswordlessSmsOtp.submitOTP({ username, otp }); + setSuccess(true); + } catch (err) { + setError('Invalid OTP or username. Please try again.'); + } + }; + + const handleResend = async () => { + try { + await startResend(); + } catch (err) { + setError('Failed to resend OTP. Please try again later.'); + } + }; + + return ( +
+
+

+ Continue with SMS OTP +

+
+
+
+
+
+ +
+ setUsername(e.target.value)} + className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> +
+
+
+ +
+ setOtp(e.target.value)} + className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> +
+
+ {error &&
{error}
} + {success &&
Login successful!
} +
+ + +
+
+
+
+
+ ); +}; + +export default LoginPasswordlessSmsOtpScreen; +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + + +TransactionOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + + SubmitOTPOptions} required> + + + + +Promise<void>}> + + CustomOptions}> + + + + +ResendControl}> + Gets resend functionality with timeout management for this screen + + + StartResendOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/login-passwordless-sms-otp/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Logout.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Logout.mdx new file mode 100644 index 000000000..a2073b207 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Logout.mdx @@ -0,0 +1,168 @@ +--- +title: "Logout" +description: "Class implementing the logout screen functionality. This screen allows users to confirm or deny the logout action." +--- + + + +```tsx Basic Usage lines +import Logout, { type ConfirmLogoutOptions } from '@auth0/auth0-acul-js/logout'; + +const logout = new Logout(); + +// Confirm logout (yes) +await logout.confirmLogout({ action: 'accept' }); + +// Or cancel logout (no) +await logout.confirmLogout({ action: 'deny' }); +``` + +```tsx React Component Example with TailwindCSS lines +import React, {useEffect } from 'react'; +import Logout, { type ConfirmLogoutOptions} from '@auth0/auth0-acul-js/logout'; + +const LogoutScreen: React.FC = () => { + const logout = new Logout(); + const { screen, transaction: { errors } } = logout; + const texts = screen.texts ?? {}; + + // Update the document title if provided + useEffect(() => { + if (texts.pageTitle) { + document.title = texts.pageTitle; + } + }, [texts.pageTitle]); + + const handleAction = async (action: ConfirmLogoutOptions['action']) => { + await logout.confirmLogout({ action } as ConfirmLogoutOptions); + }; + + return ( +
+
+

+ {texts.title ?? 'Logout'} +

+ + {texts.userSalute && ( +

+ {texts.userSalute} +

+ )} + +

+ {texts.description ?? 'Are you sure you want to log out?'} +

+ + {errors?.length && ( +
+ {errors.map((error, idx) => ( +

+ {error.message} +

+ ))} +
+ )} + +
+ + + +
+ + {/* Auth0 badge/link */} + {texts.badgeUrl && ( +
+ + {texts.badgeAltText ?? 'Auth0'} + +
+ )} +
+
+ ); +}; + +export default LogoutScreen; +``` + + + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Confirms the logout action (accept or deny). + + + ConfirmLogoutOptions} required> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/logout/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/logout/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutAborted.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutAborted.mdx new file mode 100644 index 000000000..ec14789ed --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutAborted.mdx @@ -0,0 +1,123 @@ +--- +title: "LogoutAborted" +description: "Class implementing the logout-aborted screen functionality This screen is displayed when a user aborts the logout process." +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useEffect } from 'react'; +import LogoutAborted from '@auth0/auth0-acul-js/logout-aborted'; + +const LogoutAbortedScreen: React.FC = () => { + const logoutAborted = new LogoutAborted(); + const { screen, transaction: { errors } } = logoutAborted; + const texts = screen.texts ?? {}; + + // Update the document title if provided by the spec + useEffect(() => { + if (texts.pageTitle) { + document.title = texts.pageTitle; + } + }, [texts.pageTitle]); + + return ( +
+
+

+ {texts.eventTitle ?? 'You have not been logged out.'} +

+ + {texts.userSalute && ( +

+ {texts.userSalute} +

+ )} + + {errors?.length && ( +
+ {errors.map((error, idx) => ( +

+ {error.message} +

+ ))} +
+ )} + + {/* Auth0 badge/link */} + {texts.badgeUrl && ( +
+ + {texts.badgeAltText ?? 'Auth0'} + +
+ )} +
+
+ ); +}; + +export default LogoutAbortedScreen; +``` + + + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/logout-aborted/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/logout-aborted/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutComplete.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutComplete.mdx new file mode 100644 index 000000000..1e8961a75 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutComplete.mdx @@ -0,0 +1,123 @@ +--- +title: "LogoutComplete" +description: "Class implementing the logout-complete screen functionality This screen is displayed when a user aborts the logout process." +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useEffect } from 'react'; +import LogoutComplete from '@auth0/auth0-acul-js/logout-complete'; + +const LogoutCompleteScreen: React.FC = () => { + const logoutComplete = new LogoutComplete(); + const { screen, transaction: { errors } } = logoutComplete; + const texts = screen.texts ?? {}; + + // Update the document title if provided by the spec + useEffect(() => { + if (texts.pageTitle) { + document.title = texts.pageTitle; + } + }, [texts.pageTitle]); + + return ( +
+
+

+ {texts.eventTitle ?? 'You have successfully logged out.'} +

+ + {texts.userSalute && ( +

+ {texts.userSalute} +

+ )} + + {errors?.length && ( +
+ {errors.map((error, idx) => ( +

+ {error.message} +

+ ))} +
+ )} + + {/* Auth0 badge/link */} + {texts.badgeUrl && ( +
+ + {texts.badgeAltText ?? 'Auth0'} + +
+ )} +
+
+ ); +}; + +export default LogoutCompleteScreen; +``` + + + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/logout-complete/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/logout-complete/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaBeginEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaBeginEnrollOptions.mdx new file mode 100644 index 000000000..c861248e2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaBeginEnrollOptions.mdx @@ -0,0 +1,168 @@ +--- +title: "MfaBeginEnrollOptions" +description: "MFA Begin Enroll Options screen implementation class Handles the selection and enrollment of MFA factors" +--- + + + +```typescript Basic Usage lines +import MfaBeginEnrollOptions from '@auth0/auth0-acul-js/mfa-begin-enroll-options'; + +const mfaBeginEnrollOptions = new MfaBeginEnrollOptions(); + +// Get available factors from tenant configuration +const { tenant } = mfaBeginEnrollOptions; +const availableFactors = tenant.enabledFactors; + +// Continue with selected factor enrollment +const handleFactorSelection = async (factor: string) => { + try { + await mfaBeginEnrollOptions.enroll({ + action: factor // e.g. 'push-notification', 'otp', 'sms', etc. + }); + } catch (error) { + console.error('Error enrolling factor:', error); + } +}; +``` + +```tsx React Component Example with TailwindCSS lines +import React, { useCallback } from 'react'; +import MfaBeginEnrollOptions, { type FactorType } from '@auth0/auth0-acul-js/mfa-begin-enroll-options'; + +/** Enum for Factor Types */ +enum FactorTypeEnum { + PUSH_NOTIFICATION = 'push-notification', + OTP = 'otp', + SMS = 'sms', + PHONE = 'phone', + VOICE = 'voice', + WEBAUTHN_ROAMING = 'webauthn-roaming' +} + +const MfaBeginEnrollOptionsScreen: React.FC = () => { + const mfaBeginEnrollOptions = new MfaBeginEnrollOptions(); + const { tenant, screen: { texts } } = mfaBeginEnrollOptions; + + /** Dynamically map factor IDs to display names */ + const factorDisplayNames: Record = { + [FactorTypeEnum.PUSH_NOTIFICATION]: texts?.authenticatorNamesPushNotification ?? 'Push Notification (Auth0 Guardian)', + [FactorTypeEnum.OTP]: texts?.authenticatorNamesOTP ?? 'One-Time Password (Google Authenticator)', + [FactorTypeEnum.SMS]: texts?.authenticatorNamesSMS ?? 'SMS', + [FactorTypeEnum.PHONE]: texts?.authenticatorNamesPhone ?? 'Phone Call', + [FactorTypeEnum.VOICE]: texts?.authenticatorNamesVoice ?? 'Voice Call', + [FactorTypeEnum.WEBAUTHN_ROAMING]: texts?.authenticatorNamesWebauthnRoaming ?? 'Security Key' + }; + + /** Handles user selection of an MFA factor */ + const handleFactorSelection = useCallback(async (factor: FactorTypeEnum) => { + try { + await mfaBeginEnrollOptions.enroll({ + action: factor as FactorType + }); + } catch (error) { + console.error(`Error enrolling factor [${factor}]:`, error); + } + }, []); + + return ( +
+
+

+ {texts?.title ?? 'Multi-factor Authentication'} +

+

+ {texts?.description ?? 'Choose a Multi-factor Authentication Method'} +

+
+ +
+
+
+ {tenant.enabledFactors?.map((factor) => { + const factorEnum = factor as FactorTypeEnum; + return ( + + ); + })} +
+
+
+
+ ); +}; + +export default MfaBeginEnrollOptionsScreen; +``` + + + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Continues the enrollment process with the selected factor + + + MfaEnrollOptions} required> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-begin-enroll-options/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-begin-enroll-options/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaCountryCodes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaCountryCodes.mdx new file mode 100644 index 000000000..5bdc380ce --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaCountryCodes.mdx @@ -0,0 +1,173 @@ +--- +title: "MfaCountryCodes" +description: "Class implementing the mfa-country-codes screen functionality This screen allows users to select a country code for MFA phone number verification" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React from 'react'; +import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes'; + +const MfaCountryCodesScreen: React.FC = () => { + const mfaCountryCodes = new MfaCountryCodes(); + const { screen } = mfaCountryCodes; + const { phone_prefixes } = screen.data || {}; + const handleCountrySelect = async (countryCode: string, phonePrefix: string) => { + try { + await mfaCountryCodes.selectCountryCode({ + country_code: countryCode, + phone_prefix: phonePrefix + }); + } catch (error) { + console.error('Failed to select country code:', error); + } + }; + + const handleGoBack = async () => { + try { + await mfaCountryCodes.goBack(); + } catch (error) { + console.error('Failed to go back:', error); + } + }; + + return ( +
+
+

+ Select Your Country Code +

+
+ +
+
+
+ {phone_prefixes?.map((prefix, index) => ( + + ))} +
+ +
+ +
+
+
+
+ ); +}; + +export default MfaCountryCodesScreen; +``` + +```typescript Select Country Code lines +import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes'; + + const mfaCountryCodes = new MfaCountryCodes(); + + // Get the available country codes and phone prefixes + const { screen } = mfaCountryCodes; + const { phone_prefixes } = screen.data + const {country_code, phone_prefix} = phone_prefixes[0] + + await mfaCountryCodes.selectCountryCode({ + country_code: 'US', + phone_prefix: '+1', + }); +``` + +```typescript Go Back lines +import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes'; + +const mfaCountryCodes = new MfaCountryCodes(); + +// Navigate back to the previous screen +await mfaCountryCodes.goBack(); +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Selects a country code from the available options + + + SelectCountryCodeOptions} required> + + + + +Promise<void>}> + Navigates back to the previous screen + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-country-codes/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaDetectBrowserCapabilities.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaDetectBrowserCapabilities.mdx new file mode 100644 index 000000000..2f91bb44e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaDetectBrowserCapabilities.mdx @@ -0,0 +1,165 @@ +--- +title: "MfaDetectBrowserCapabilities" +description: "Class implementing the mfa-detect-browser-capabilities screen functionality This screen detects browser capabilities for MFA authentication methods" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useEffect, useState } from 'react'; +import MfaDetectBrowserCapabilities from '@auth0/auth0-acul-js/mfa-detect-browser-capabilities'; + +const MfaDetectBrowserCapabilitiesScreen: React.FC = () => { + const [isLoading, setIsLoading] = useState(true); + const [error, setError] = useState(null); + const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); + + useEffect(() => { + const detectCapabilities = async () => { + try { + setIsLoading(true); + setError(null); + + await mfaDetectBrowserCapabilities.detectCapabilities(); + } catch (err) { + setError('Failed to detect browser capabilities. Please try again.'); + console.error('Error:', err); + } finally { + setIsLoading(false); + } + }; + + detectCapabilities(); + }, []); + + if (isLoading) { + return ( +
+
+
+
+
+
+

+ Detecting browser capabilities... +

+
+
+
+ ); + } + + if (error) { + return ( +
+
+
+
+
+
+ + + +
+
+

{error}

+
+
+
+
+
+
+ ); + } + + return null; // The screen will automatically redirect after successful capability detection +}; + +export default MfaDetectBrowserCapabilitiesScreen; +``` + +```typescript Detect Browser Capabilities lines +import MfaDetectBrowserCapabilities from '@auth0/auth0-acul-js/mfa-detect-browser-capabilities'; + +const detectBrowserCapabilities = async () => { + const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); + + // Submit capabilities + await mfaDetectBrowserCapabilities.detectCapabilities(); +}; +``` + + + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Picks an authenticator based on browser capabilities + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-detect-browser-capabilities/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-detect-browser-capabilities/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailChallenge.mdx new file mode 100644 index 000000000..db547b7be --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailChallenge.mdx @@ -0,0 +1,343 @@ +--- +title: "MfaEmailChallenge" +description: "Class implementing the mfa-email-challenge screen functionality This screen is shown when a user needs to verify their email during MFA" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useState, useEffect, useMemo } from 'react'; +import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + +const MfaEmailChallengeScreen: React.FC = () => { + const [code, setCode] = useState(''); + const [rememberDevice, setRememberDevice] = useState(false); + const [error, setError] = useState(''); + const [disabled, setDisabled] = useState(false); + const [remainingSeconds, setRemainingSeconds] = useState(0); + + const mfaEmailChallenge = useMemo(() => new MfaEmailChallenge(), []); + const { screen } = mfaEmailChallenge; + + function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { + setDisabled(isDisabled); + setRemainingSeconds(remainingSeconds); + } + + function handleTimeout() { + console.log('Resend timeout completed'); + } + + const resendManager = useMemo( + () => + mfaEmailChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout, + }), + [mfaEmailChallenge] + ); + + const { startResend } = resendManager; + + // Initialize form values from untrustedData + useEffect(() => { + // Use untrustedData to prepopulate form fields if available + const savedFormData = mfaEmailChallenge.untrustedData.submittedFormData; + if (savedFormData?.rememberDevice !== undefined) { + setRememberDevice(savedFormData.rememberDevice); + } + }, [mfaEmailChallenge]); + + const handleSubmit = async (e: React.FormEvent) => { + e.preventDefault(); + setError(''); + + try { + await mfaEmailChallenge.continue({ + code, + rememberDevice, + }); + } catch (err) { + setError('Failed to verify code. Please try again.'); + } + }; + + const handleResendCode = async () => { + try { + await startResend(); + } catch (err) { + setError('Failed to resend code. Please try again.'); + } + }; + const handlePickEmail = async () => { + try { + await mfaEmailChallenge.pickEmail(); + } catch (err) { + setError('Failed pick email. Please try again.'); + } + }; + + const handleTryAnotherMethod = async () => { + try { + await mfaEmailChallenge.tryAnotherMethod(); + } catch (err) { + setError('Failed to try another method. Please try again.'); + } + }; + + return ( +
+
+

+ Verify Your Email +

+

+ Enter the code sent to {screen.data?.email} +

+
+ +
+
+
+
+ +
+ setCode(e.target.value)} + className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> +
+
+ + {screen.data?.showRememberDevice && ( +
+ setRememberDevice(e.target.checked)} + /> + +
+ )} + + + +
+ +
+
+ +
+
+ + + +
+
+ + {error &&
{error}
} +
+
+
+ ); +}; + +export default MfaEmailChallengeScreen; +``` + +```typescript resendManager lines +import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + +const mfaEmailChallenge = new MfaEmailChallenge(); + +function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); +} + +function handleTimeout() { + console.log('Resend timeout completed'); +} + +const resendManager = mfaEmailChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout, +}); + +const { startResend } = resendManager; + +// Use startResend() to initiate the resend with cooldown +startResend(); +``` + +```typescript Continue with Code lines +import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + +const mfaEmailChallenge = new MfaEmailChallenge(); + +// Access untrustedData to prepopulate form fields +const { rememberDevice } = mfaEmailChallenge.untrustedData.submittedFormData || {}; + +mfaEmailChallenge.continue({ + code: '123456', + rememberDevice: rememberDevice || false, +}); +``` + +```typescript Resend Code lines +import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + +const mfaEmailChallenge = new MfaEmailChallenge(); + +mfaEmailChallenge.resendCode(); +``` + +```typescript Try Another Method lines +import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + +const mfaEmailChallenge = new MfaEmailChallenge(); + +mfaEmailChallenge.tryAnotherMethod(); +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + + +UntrustedDataOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Continues with the email challenge using the provided code + + + ContinueOptions} required> + + + + +Promise<void>}> + Resends the email code + + + ResendCodeOptions}> + + + + +Promise<void>}> + Allows the user to try another MFA method + + + TryAnotherMethodOptions}> + + + + +Promise<void>}> + Submits the action to pick a different Email configuration, if available. + + + CustomOptions}> + + + + +ResendControl}> + Gets resend functionality with timeout management for this screen + + + StartResendOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-email-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailList.mdx new file mode 100644 index 000000000..fc7ac4f16 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailList.mdx @@ -0,0 +1,167 @@ +--- +title: "MfaEmailList" +description: "Class implementing the mfa-email-list screen functionality This screen allows users to select an enrolled email address for MFA" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React from 'react'; +import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list'; + +const MfaEmailListScreen: React.FC = () => { + const mfaEmailList = new MfaEmailList(); + const { user } = mfaEmailList; + + const handleSelectEmail = async (index: number) => { + try { + await mfaEmailList.selectMfaEmail({ + index: index, + }); + } catch (error) { + console.error('Failed to select email:', error); + } + }; + + const handleGoBack = async () => { + try { + await mfaEmailList.goBack(); + } catch (error) { + console.error('Failed to go back:', error); + } + }; + + return ( +
+
+

Select an Email Address

+ { + user.enrolledEmails ? ( +
    + {user.enrolledEmails.map((email, index) => ( +
  • + +
    • + ))} +
+ ) : ( +

No email addresses enrolled.

+ ) + } + +
+
+ ); +}; + +export default MfaEmailListScreen; +``` + +```typescript Select MFA Email lines +import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list'; + +const mfaEmailList = new MfaEmailList(); +const getEnrolledEmails = mfaSmsList.user.enrolledEmails; +// select any email from list, for demonstration we will pick up first email +const selectedEmail = getEnrolledEmails[0] + +// Select the first email address (index 0) +await mfaEmailList.selectMfaEmail({ + index: selectedEmail +}); +``` + +```typescript Go Back lines +import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list'; + +const mfaEmailList = new MfaEmailList(); + +// Navigate back to the previous screen +await mfaEmailList.goBack(); +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + The screen object for the mfa-email-list screen + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Selects an enrolled email address from the list + + + SelectMfaEmailOptions} required> + + + + +Promise<void>}> + Navigates back to the previous screen + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-email-list/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEnrollResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEnrollResult.mdx new file mode 100644 index 000000000..7fa8ac67b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEnrollResult.mdx @@ -0,0 +1,221 @@ +--- +title: "MfaEnrollResult" +description: "" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React from 'react'; +import MfaEnrollResult from '@auth0/auth0-acul-js/mfa-enroll-result'; + +const MfaEnrollResultScreen: React.FC = () => { + const mfaEnrollResult = new MfaEnrollResult(); + const { screen } = mfaEnrollResult; + + // Determine message and styling based on enrollment status + let title = screen.texts?.title ?? 'MFA Enrollment'; + + let description = screen.texts?.description ?? 'Your multi-factor authentication status.'; + let iconComponent = null; + let textColorClass = 'text-gray-900'; + let iconColorClass = 'text-gray-500'; + + // Use data.status to determine the enrollment result + const enrollmentStatus = screen.data?.status; + + if (enrollmentStatus === 'success') { + title = screen.texts?.titleSuccess ?? 'MFA Enrollment Complete'; + description = screen.texts?.descriptionSuccess ?? 'Your multi-factor authentication has been successfully set up.'; + textColorClass = 'text-green-700'; + iconColorClass = 'text-green-500'; + iconComponent = ( + + + + ); + } else if (enrollmentStatus === 'failure') { + title = screen.texts?.titleFailure ?? 'MFA Enrollment Failed'; + description = screen.texts?.descriptionFailure ?? 'There was a problem setting up your multi-factor authentication.'; + textColorClass = 'text-red-700'; + iconColorClass = 'text-red-500'; + iconComponent = ( + + + + ); + } else if (enrollmentStatus === 'already-enrolled') { + title = screen.texts?.titleAlreadyEnrolled ?? 'Already Enrolled'; + description = screen.texts?.alreadyEnrolledDescription ?? 'Two-factor Verification has Already Been Enabled.'; + textColorClass = 'text-blue-700'; + iconColorClass = 'text-blue-500'; + iconComponent = ( + + + + ); + } else if (enrollmentStatus === 'already-used') { + title = screen.texts?.alreadyUsedTitle ?? 'Already Used'; + description = screen.texts?.alreadyUsedDescription ?? 'This link has already been used. Please get a new link to enroll with Multi-factor Authentication.'; + textColorClass = 'text-orange-700'; + iconColorClass = 'text-orange-500'; + iconComponent = ( + + + + ); + } else { + // Default or unknown status + iconComponent = ( + + + + ); + } + + return ( +
+
+

+ {title} +

+

+ {description} +

+
+ +
+
+
+ {iconComponent} +
+ +
+

+ {screen.texts?.badgeAltText && ( + {screen.texts.badgeAltText} + )} +

+
+
+
+
+ ); +}; + +export default MfaEnrollResultScreen; +``` + + + +## Properties + +string} required> + static + + +ScreenOptions} required> + Holds the specific screen data and properties for the MFA Enroll Result screen, including the enrollment `status`. + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-enroll-result/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-enroll-result/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaLoginOptions.mdx new file mode 100644 index 000000000..64e62baff --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaLoginOptions.mdx @@ -0,0 +1,184 @@ +--- +title: "MfaLoginOptions" +description: "Class implementing the mfa-login-options screen functionality This screen allows users to select which MFA factor they want to use for login" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useCallback } from 'react'; +import MfaBeginEnrollOptions, { type LoginFactorType } from '@auth0/auth0-acul-js/mfa-login-options'; + +/** Enum for Factor Types */ +enum FactorTypeEnum { + PUSH_NOTIFICATION = 'push-notification', + OTP = 'otp', + SMS = 'sms', + PHONE = 'phone', + VOICE = 'voice', + EMAIL = 'email', + RECOVERY_CODE = 'recovery-code', + WEBAUTHN_ROAMING = 'webauthn-roaming', + WEBAUTHN_PLATFORM = 'webauthn-platform', + DUO = 'duo' +} + +const MfaLoginOptionsScreen: React.FC = () => { + const mfaBeginEnrollOptions = new MfaBeginEnrollOptions(); + const { tenant, screen: { texts } } = mfaBeginEnrollOptions; + + /** Dynamically map factor IDs to display names */ + const factorDisplayNames: Record = { + [FactorTypeEnum.PUSH_NOTIFICATION]: texts?.authenticatorNamesPushNotification ?? 'Push Notification (Auth0 Guardian)', + [FactorTypeEnum.OTP]: texts?.authenticatorNamesOTP ?? 'One-Time Password (Google Authenticator)', + [FactorTypeEnum.SMS]: texts?.authenticatorNamesSMS ?? 'SMS', + [FactorTypeEnum.PHONE]: texts?.authenticatorNamesPhone ?? 'Phone Call', + [FactorTypeEnum.VOICE]: texts?.authenticatorNamesVoice ?? 'Voice Call', + [FactorTypeEnum.EMAIL]: texts?.authenticatorNamesEmail ?? 'Email', + [FactorTypeEnum.RECOVERY_CODE]: texts?.authenticatorNamesRecoveryCode ?? 'Recovery Code', + [FactorTypeEnum.WEBAUTHN_PLATFORM]: texts?.authenticatorNamesWebauthnPlatform ?? 'Platform Authenticator', + [FactorTypeEnum.WEBAUTHN_ROAMING]: texts?.authenticatorNamesWebauthnRoaming ?? 'Security Key', + [FactorTypeEnum.DUO]: texts?.authenticatorNamesDuo ?? 'Notification via DUO app' + }; + + /** Handles user selection of an MFA factor */ + const handleFactorSelection = useCallback(async (factor: FactorTypeEnum) => { + try { + await mfaBeginEnrollOptions.enroll({ + action: factor as LoginFactorType + }); + } catch (error) { + console.error(`Error enrolling factor [${factor}]:`, error); + } + }, []); + + return ( +
+
+

+ {texts?.title ?? 'Multi-factor Authentication'} +

+

+ {texts?.description ?? 'Choose a Multi-factor Authentication Method'} +

+
+ +
+
+
+ {tenant.enabledFactors?.map((factor) => { + const factorEnum = factor as FactorTypeEnum; + return ( + + ); + })} +
+
+
+
+ ); +}; + +export default MfaLoginOptionsScreen; +``` + +```typescript Continue with Selected Factor lines +import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options'; + +const mfaLoginOptions = new MfaLoginOptions(); + +// Continue with push notification +await mfaLoginOptions.enroll({ + action: 'push-notification' +}); + +// Continue with SMS +await mfaLoginOptions.enroll({ + action: 'sms' +}); + +// Continue with OTP +await mfaLoginOptions.enroll({ + action: 'otp' +}); +``` + + + +## Properties + +string} required> + + +ScreenMembersOnMfaLoginOptions} required> + The screen object for the mfa-login-options screen + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Continues the login process with the selected MFA factor + + + LoginEnrollOptions} required> + + + + +Promise<void>}> + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-login-options/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpChallenge.mdx new file mode 100644 index 000000000..3189babf2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpChallenge.mdx @@ -0,0 +1,244 @@ +--- +title: "MfaOtpChallenge" +description: "Class implementing the mfa-otp-challenge screen functionality This screen is shown when a user needs to enter an OTP code during MFA" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useState, useEffect } from 'react'; +import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge'; + +const MfaOtpChallengeScreen: React.FC = () => { + const [code, setCode] = useState(''); + const [rememberDevice, setRememberDevice] = useState(false); + const [error, setError] = useState(''); + + const mfaOtpChallenge = new MfaOtpChallenge(); + const { + screen: { texts, data }, + transaction, + } = mfaOtpChallenge; + + // Initialize form values from untrustedData + useEffect(() => { + // Use untrustedData to prepopulate form fields if available + const savedFormData = mfaOtpChallenge.untrustedData.submittedFormData; + if (savedFormData?.rememberDevice !== undefined) { + setRememberDevice(savedFormData.rememberDevice); + } + }, []); + + const handleSubmit = async (e: React.FormEvent) => { + e.preventDefault(); + setError(''); + + try { + await mfaOtpChallenge.continue({ + code, + rememberDevice, + }); + } catch (err) { + setError('Failed to verify code. Please try again.'); + console.error(err); + } + }; + + const handleTryAnotherMethod = async () => { + try { + await mfaOtpChallenge.tryAnotherMethod(); + } catch (err) { + setError('Failed to try another method. Please try again.'); + console.error(err); + } + }; + + return ( +
+
+

+ {texts?.title ?? 'Verify Your Identity'} +

+

+ {texts?.description ?? + 'Check your preferred one-time password application for a code.'} +

+
+ +
+
+
+
+ +
+ setCode(e.target.value)} + className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> +
+
+ + {transaction?.errors?.length && ( +
+ {transaction.errors.map((err, index) => ( +

{err.message}

+ ))} +
+ )} + + {data?.showRememberDevice && ( +
+ setRememberDevice(e.target.checked)} + /> + +
+ )} + + {error &&
{error}
} + +
+ +
+
+ +
+
+ +
+
+
+
+
+ ); +}; + +export default MfaOtpChallengeScreen; +``` + +```typescript Continue with Code lines +import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge'; + +const mfaOtpChallenge = new MfaOtpChallenge(); + +mfaOtpChallenge.continue({ + code: '123456', + rememberDevice: true, +}); +``` + +```typescript Try Another Method lines +import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge'; + +const mfaOtpChallenge = new MfaOtpChallenge(); + +mfaOtpChallenge.tryAnotherMethod(); +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + + +UntrustedDataOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Continues with the OTP challenge using the provided code + + + ContinueOptions} required> + + + + +Promise<void>}> + Allows the user to try another MFA method + + + TryAnotherMethodOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-otp-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentCode.mdx new file mode 100644 index 000000000..60bd0b609 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentCode.mdx @@ -0,0 +1,194 @@ +--- +title: "MfaOtpEnrollmentCode" +description: "Class implementing the mfa-otp-enrollment-code screen functionality. This screen is displayed when the user needs to enter the OTP code received during MFA enrollment." +--- + + + +```typescript continue lines +import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; + +const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); +mfaOtpEnrollmentCode.continue({ + code:"123546" +}); +``` + +```typescript tryAnotherMethod lines +import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; + +const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); +mfaOtpEnrollmentCode.tryAnotherMethod(); +``` + +```tsx React Component Example with TailwindCSS lines +import React, { useState } from 'react'; +import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; + +const MfaOtpEnrollmentCodeScreen: React.FC = () => { + const [code, setCode] = useState(''); + + const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); + const { screen, transaction } = mfaOtpEnrollmentCode; + + const handleSubmit = async (e: React.FormEvent) => { + e.preventDefault(); + await mfaOtpEnrollmentCode.continue({ + code, + }); + }; + + const handleTryAnotherMethod = async () => { + await mfaOtpEnrollmentCode.tryAnotherMethod(); + }; + + return ( +
+
+

+ { screen?.texts?.title ?? 'Secure Your Account' } +

+

+ { screen?.texts?.description ?? 'Manually enter the following code into your preferred authenticator app and then enter the provided one-time code below.' } +

+

+ Code: {screen.data?.text_code} +

+
+ +
+
+
+
+ +
+ setCode(e.target.value)} + className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> +
+
+ + {transaction?.errors?.length && ( +
+ {transaction?.errors.map((err, index) => ( +

+ {err.message} +

+ ))} +
+ )} + +
+ +
+
+ +
+
+ +
+
+
+
+
+ ); +}; + +export default MfaOtpEnrollmentCodeScreen; +``` + + + +## Properties + +string} required> + Screen identifier for validation and telemetry + + +ScreenOptions} required> + The screen properties for the mfa-otp-enrollment-code screen. + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Continues the MFA OTP enrollment process by submitting the OTP code. + + + ContinueOptions} required> + + + + +Promise<void>}> + Allows the user to try another MFA method. + + + TryAnotherMethodOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-otp-enrollment-code/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentQr.mdx new file mode 100644 index 000000000..f3ed29dd4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentQr.mdx @@ -0,0 +1,211 @@ +--- +title: "MfaOtpEnrollmentQr" +description: "Class implementing the mfa-otp-enrollment-qr screen functionality" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useState } from 'react'; +import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; + +const MfaOtpEnrollmentQrScreen: React.FC = () => { + const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); + const { screen, transaction } = mfaOtpEnrollmentQr; + const { qr_code } = screen.data || {}; + + const [otpCode, setOtpCode] = useState(''); + + const handleToggleView = async () => { + try { + await mfaOtpEnrollmentQr.toggleView(); + } catch (error) { + console.error('Failed to toggle view:', error); + } + }; + + const handleTryAnotherMethod = async () => { + try { + await mfaOtpEnrollmentQr.tryAnotherMethod(); + } catch (error) { + console.error('Failed to pick authenticator:', error); + } + }; + + const handleContinue = async () => { + await mfaOtpEnrollmentQr.continue({ code: otpCode }); + }; + + return ( +
+
+

{screen.texts?.title ?? 'Secure Your Account'}

+

{screen.texts?.description ?? 'Scan the QR Code below using your preferred authenticator app and then enter the provided one-time code below.'}

+ + {qr_code ? ( +
+ QR Code +
+ ) : ( +

Loading QR Code...

+ )} + + + +
+ setOtpCode(e.target.value)} + className="w-64 px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> + + + {transaction?.errors?.length && ( +
+ {transaction?.errors.map((err, index) => ( +

+ {err.message} +

+ ))} +
+ )} +
+ +
+ +
+ + + +
+ +
+
+ ); +}; + +export default MfaOtpEnrollmentQrScreen; +``` + +```typescript Toggle View lines +import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; + +const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); + +mfaOtpEnrollmentQr.toggleView(); +``` + +```typescript Try Another Method lines +import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; + +const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); + +mfaOtpEnrollmentQr.tryAnotherMethod(); +``` + + + +## Properties + +string} required> + Screen identifier for validation and telemetry + + +ScreenOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Navigates to the authenticator selection screen. + + + CustomOptions}> + + + + +Promise<void>}> + Continues with the default action. + + + ContinueOptions} required> + + + + +Promise<void>}> + Navigates to the authenticator selection screen. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-otp-enrollment-qr/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneChallenge.mdx new file mode 100644 index 000000000..24d335a17 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneChallenge.mdx @@ -0,0 +1,302 @@ +--- +title: "MfaPhoneChallenge" +description: "" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useState } from 'react'; +import MfaPhoneChallenge, { type ContinueOptions } from '@auth0/auth0-acul-js/mfa-phone-challenge'; + +const MfaPhoneChallengeScreen: React.FC = () => { + // Instantiate the SDK class for the MFA Phone Challenge screen + const mfaPhoneChallenge = new MfaPhoneChallenge(); + const { screen, transaction } = mfaPhoneChallenge; + + // State to handle potential errors during submission + const [error, setError] = useState(null); + // State to manage loading state during submission + const [isLoading, setIsLoading] = useState(false); + + /** + * Handles the submission when the user selects SMS or Voice Call. + * @param {'sms' | 'voice'} type - The selected delivery method. + */ + const handleContinue = async (type: ContinueOptions['type']) => { + setIsLoading(true); + setError(null); + try { + await mfaPhoneChallenge.continue({ type }); + // On success, the page will typically redirect automatically. + // No need to set loading to false here. + } catch (err: any) { + setError(err.message || 'An unexpected error occurred. Please try again.'); + setIsLoading(false); + } + }; + + /** + * Handles the submission when the user wants to try a different MFA method. + */ + const handleTryAnotherMethod = async () => { + setIsLoading(true); + setError(null); + try { + await mfaPhoneChallenge.tryAnotherMethod(); + // On success, the page will typically redirect automatically. + } catch (err: any) { + setError(err.message || 'Failed to switch methods. Please try again.'); + setIsLoading(false); + } + }; + + // Extract texts for UI elements, providing default fallbacks + const texts = screen?.texts ?? {}; + const title = texts.title ?? 'Verify Your Identity'; + const description = texts.description ?? `How would you like to get the verification code sent to ${screen.data?.phoneNumber ?? 'your phone'}?`; + const smsButtonText = texts.smsButtonText ?? 'Send code via SMS'; + const voiceButtonText = texts.voiceButtonText ?? 'Send code via Voice Call'; + const tryAnotherMethodText = texts.pickAuthenticatorText ?? 'Try Another Method'; + + return ( +
+
+

+ {title} +

+

+ {description} +

+ + {/* Display errors from the transaction object (e.g., invalid state) */} + {transaction.errors && transaction.errors.length > 0 && ( +
+ {transaction.errors.map((err, index) => ( +

{err.message}

+ ))} +
+ )} + + {/* Display errors caught during form submission */} + {error && ( +
+

{error}

+
+ )} + +
+ {/* SMS Button */} + + + {/* Voice Call Button */} + +
+ + {/* Separator */} +
+ + {/* Try Another Method Button */} + + + {/* Note: The 'pickPhone' action is less common for this specific screen */} + {/* but could be added similarly if needed: */} + +
+
+ ); +}; + +export default MfaPhoneChallengeScreen; +``` + +```typescript Initialize the SDK Class lines +import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + +const mfaPhoneChallenge = new MfaPhoneChallenge(); + +// You can access screen data like the phone number +const phoneNumber = mfaPhoneChallenge.screen.data?.phoneNumber; +console.log('Phone number for challenge:', phoneNumber); + +// Access transaction details like errors +const errors = mfaPhoneChallenge.transaction.errors; +if (errors) { + console.error('Transaction errors:', errors); +} +``` + +```typescript Send Code via SMS lines +import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + +const mfaPhoneChallenge = new MfaPhoneChallenge(); + +try { + await mfaPhoneChallenge.continue({ type: 'sms' }); + // If successful, the user will be redirected to the code entry screen. +} catch (error) { + console.error('Failed to request SMS code:', error); + // Handle the error, e.g., display a message to the user. +} +``` + +```typescript Send Code via Voice Call lines +import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + +const mfaPhoneChallenge = new MfaPhoneChallenge(); + +try { + await mfaPhoneChallenge.continue({ type: 'voice' }); + // If successful, the user will be redirected to the code entry screen. +} catch (error) { + console.error('Failed to request voice call:', error); + // Handle the error. +} +``` + +```typescript Try Another MFA Method lines +import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + +const mfaPhoneChallenge = new MfaPhoneChallenge(); + +try { + await mfaPhoneChallenge.tryAnotherMethod(); + // If successful, the user will be redirected to the authenticator selection screen. +} catch (error) { + console.error('Failed to switch MFA method:', error); + // Handle the error. +} +``` + +```typescript Pick a Different Phone (Less Common) lines +import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + +const mfaPhoneChallenge = new MfaPhoneChallenge(); + +try { + await mfaPhoneChallenge.pickPhone(); + // If successful, the user will be redirected to a phone selection screen. +} catch (error) { + console.error('Failed to initiate picking a different phone:', error); + // Handle the error. +} +``` + + + +## Properties + +string} required> + The unique identifier for this screen. + + +ScreenOptions} required> + Holds the specific screen data for the MFA Phone Challenge. + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Submits the user's choice of receiving the MFA code via SMS or voice call. It uses the phone number provided in the screen context. + + + ContinueOptions} required> + + + + +Promise<void>}> + Initiates the process for the user to select a different phone number (if applicable). This typically triggers a navigation to a phone selection screen. + + + PickPhoneOptions}> + + + + +Promise<void>}> + Allows the user to choose a different MFA method (e.g., OTP, Recovery Code). This typically triggers navigation to the authenticator selection screen. + + + PickAuthenticatorOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-phone-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneEnrollment.mdx new file mode 100644 index 000000000..8ad8cdc37 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneEnrollment.mdx @@ -0,0 +1,233 @@ +--- +title: "MfaPhoneEnrollment" +description: "Class implementing the mfa-phone-enrollment screen functionality. This screen allows users to enroll using a phone number for MFA." +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useState } from 'react'; +import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; + +const MfaPhoneEnrollmentScreen: React.FC = () => { + const [phone, setPhone] = useState(''); + const [type, setType] = useState<'sms' | 'voice'>('sms'); + const mfaPhoneEnrollment = new MfaPhoneEnrollment(); + const { screen, transaction: { errors } } = mfaPhoneEnrollment; + const texts = screen.texts ?? {}; + + const handlePickCountryCode = async () => { + await mfaPhoneEnrollment.pickCountryCode(); + }; + + const handleContinueEnrollment = async () => { + await mfaPhoneEnrollment.continueEnrollment({ phone, type }); + }; + + const handleTryAnotherMethod = async () => { + await mfaPhoneEnrollment.tryAnotherMethod(); + }; + + return ( +
+
+

+ {texts.title ?? 'Secure Your Account'} +

+

+ {texts.description ?? 'Enter your country code and phone number to which we can send a 6-digit code:'} +

+ + + +
+ + setPhone(e.target.value)} + /> + {errors?.length && ( +
+ {errors.map((error, idx) => ( +

+ {error.message} +

+ ))} +
+ )} +
+ +
+ +
+ + +
+
+ + + + +
+
+ ); +}; + +export default MfaPhoneEnrollmentScreen; +``` + +```typescript Pick Country Code lines +import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; + +const mfaPhoneEnrollment = new MfaPhoneEnrollment(); + +// Call the pickCountryCode method +mfaPhoneEnrollment.pickCountryCode(); +``` + +```typescript Continue Enrollment lines +import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; + +const mfaPhoneEnrollment = new MfaPhoneEnrollment(); + +// Call the continueEnrollment method with a phone number and type +mfaPhoneEnrollment.continueEnrollment({ + phone: "1234567890", + type: "sms" // or "voice" +}); +``` + +```typescript Try Another Method lines +import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; + +const mfaPhoneEnrollment = new MfaPhoneEnrollment(); + +// Call the tryAnotherMethod +mfaPhoneEnrollment.tryAnotherMethod(); +``` + + + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Navigates to the country code selection screen. + + + CustomOptions}> + + + + +Promise<void>}> + Continues the enrollment process with the provided phone number and type (SMS or voice). + + + ContinueOptions} required> + + + + +Promise<void>}> + Allows the user to try another MFA method. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-phone-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushChallengePush.mdx new file mode 100644 index 000000000..99665c5c7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushChallengePush.mdx @@ -0,0 +1,424 @@ +--- +title: "MfaPushChallengePush" +description: "Class implementing the mfa-push-challenge-push screen functionality This screen is shown when a user needs to confirm a push notification during MFA" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { + useState, + useEffect, + useRef, + useMemo, +} from 'react'; +import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; + +const MfaPushChallengePushScreen: React.FC = () => { + const [isLoading, setIsLoading] = useState(false); + const [rememberDevice, setRememberDevice] = useState(false); + const [isPolling, setIsPolling] = useState(false); + const mfaPushChallengePush = useMemo(() => new MfaPushChallengePush(), []); + const { screen, transaction } = mfaPushChallengePush; + const { deviceName, showRememberDevice } = + mfaPushChallengePush.screen.data || {}; + const pollingControl = useRef | null>(null); + + useEffect(() => { + const savedFormData = mfaPushChallengePush.untrustedData.submittedFormData; + if (savedFormData?.rememberDevice !== undefined) { + setRememberDevice(savedFormData.rememberDevice); + } + }, [mfaPushChallengePush.untrustedData.submittedFormData]); + + const screenText = { + title: screen.texts?.title ?? 'Push Notification Sent', + description: + screen.texts?.description ?? + "We've sent a push notification to your device", + rememberMe: + screen.texts?.rememberMeText ?? 'Remember this device for 30 days', + resend: screen.texts?.resendActionText ?? 'Resend Push Notification', + enterCode: screen.texts?.enterOtpCode ?? 'Enter Code Manually', + tryAnother: screen.texts?.pickAuthenticatorText ?? 'Try Another Method', + waiting: + screen.texts?.spinner_push_notification_label ?? + 'Waiting for you to accept the push notification...', + errorResend: 'Failed to resend push notification. Please try again.', + errorManualCode: 'Failed to switch to manual code entry. Please try again.', + errorAnotherMethod: + 'Failed to switch authentication method. Please try again.', + }; + + useEffect(() => { + return () => { + if (pollingControl.current) { + pollingControl.current?.stopPolling(); + } + setIsPolling(false); + }; + }, []); + + const handleResend = async () => { + setIsLoading(true); + try { + await mfaPushChallengePush.resendPushNotification({ rememberDevice }); + } catch (err) { + console.log(err); + } finally { + setIsLoading(false); + } + }; + + const handleEnterCodeManually = async () => { + setIsLoading(true); + try { + await mfaPushChallengePush.enterCodeManually({ rememberDevice }); + } catch (err) { + console.log(err); + } finally { + setIsLoading(false); + } + }; + + const handleTryAnotherMethod = async () => { + setIsLoading(true); + try { + await mfaPushChallengePush.tryAnotherMethod({ rememberDevice }); + } catch (err) { + console.log(err); + } finally { + setIsLoading(false); + } + }; + + const handleStartPolling = () => { + if (!isPolling) { + pollingControl.current = mfaPushChallengePush.pollingManager( + 5000, + () => { + mfaPushChallengePush.continue({ rememberDevice }); + setIsPolling(false); + } + ); + pollingControl.current?.startPolling(); + setIsPolling(true); + } + }; + + const handleStopPolling = () => { + if (pollingControl.current) { + pollingControl.current?.stopPolling(); + setIsPolling(false); + } +}; + + return ( +
+
+

+ {screenText.title} +

+

+ {screenText.description} + {deviceName && ({deviceName})} +

+
+ +
+
+
+
+
+
+ +

+ {isPolling ? screenText.waiting : 'Polling stopped.'} +

+ + {showRememberDevice && ( +
+ setRememberDevice(e.target.checked)} + className="h-4 w-4 text-blue-600 border-gray-300 rounded focus:ring-blue-500" + /> + +
+ )} + + {transaction?.errors?.length && ( +
+ {transaction.errors.map((err, index) => ( +

+ {err.message} +

+ ))} +
+ )} + + + + + + + + + + +
+
+
+
+ ); +}; + +export default MfaPushChallengePushScreen; +``` + +```tsx Polling Usage Example (with stop/start) lines +import React, { useEffect, useRef } from 'react'; +import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; + +const mfaPushChallengePush = new MfaPushChallengePush(); +const pollerRef = useRef(null); + +useEffect(() => { + // Start polling for push notification acceptance + pollerRef.current = mfaPushChallengePush.pollingManager(5000, () => { + mfaPushChallengePush.continue(); + }); + + // To stop polling when component unmounts + return () => { + if (pollerRef.current) pollerRef.current.stopPolling(); + }; +}, []); + +// To manually stop polling +// pollerRef.current.stopPolling(); + +// To restart polling: +// pollerRef.current.startPolling(); + +// To check if polling is running: +// const isPolling = pollerRef.current.isRunning(); +``` + +```javascript Plain JavaScript Usage lines +import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; + +const mfaPushChallengePush = new MfaPushChallengePush(); + +// Get polling object +const polling = mfaPushChallengePush.pollingManager(5000, async () => { + await mfaPushChallengePush.continue(); +}); + +// Start polling +polling.startPolling(); + +polling.stopPolling(); + +console.log(polling.isRunning()); // true or false +``` + +```tsx React Usage Example lines +import React, { useEffect, useRef } from 'react'; +import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; + +const MfaPushChallengePushScreen: React.FC = () => { + const mfaPushChallengePush = React.useMemo(() => new MfaPushChallengePush(), []); + const pollingRef = useRef(null); + + useEffect(() => { + // Get polling object + pollingRef.current = mfaPushChallengePush.pollingManager(5000, async () => { + await mfaPushChallengePush.continue(); + }); + // Start polling + pollingRef.current.startPolling(); + return () => { + pollingRef.current?.stopPolling(); + }; + }, [mfaPushChallengePush]); + + + return
...
; +}; +``` + +```typescript Continue (Poll for Push Notification Acceptance) lines +import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; + +const mfaPushChallengePush = new MfaPushChallengePush(); + +// Poll for push notification acceptance +const pollInterval = setInterval(async () => { + try { + await mfaPushChallengePush.continue(); + clearInterval(pollInterval); + } catch (error) { + + } +}, 5000); +``` + +```typescript Resend Push Notification lines +import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; + +const mfaPushChallengePush = new MfaPushChallengePush(); +mfaPushChallengePush.resendPushNotification(); +``` + +```typescript Enter Code Manually lines +import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; + +const mfaPushChallengePush = new MfaPushChallengePush(); +mfaPushChallengePush.enterCodeManually(); +``` + +```typescript Try Another Method lines +import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; + +const mfaPushChallengePush = new MfaPushChallengePush(); +mfaPushChallengePush.tryAnotherMethod(); +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + + +UntrustedDataOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Continues with the push notification challenge + + + WithRememberOptions}> + + + + +Promise<void>}> + Resends the push notification + + + WithRememberOptions}> + + + + +Promise<void>}> + Switches to entering the verification code manually + + + CustomOptions}> + + + + +Promise<void>}> + Allows trying another authentication method + + + CustomOptions}> + + + + +MfaPushPollingControl}> + Starts and manages polling for an MFA push challenge. Creates a polling session that repeatedly checks the MFA push challenge endpoint at the specified interval until the challenge is approved or an error occurs. When the approval condition is met, the provided callback is invoked and polling stops automatically. Use the returned to start, stop, or check the status of the polling process at any time. + + + MfaPollingOptions} required> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-push-challenge-push/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushEnrollmentQr.mdx new file mode 100644 index 000000000..fe76de66c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushEnrollmentQr.mdx @@ -0,0 +1,165 @@ +--- +title: "MfaPushEnrollmentQr" +description: "Class implementing the mfa-push-enrollment-qr screen functionality" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React from 'react'; +import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr'; + +const MfaPushEnrollmentQrScreen: React.FC = () => { + const mfaPushEnrollmentQr = new MfaPushEnrollmentQr(); + const { screen } = mfaPushEnrollmentQr; + const { qrCode, qrUri, showCodeCopy } = screen.data || {}; + + const handlePickAuthenticator = async () => { + try { + await mfaPushEnrollmentQr.pickAuthenticator(); + } catch (error) { + console.error('Failed to pick authenticator:', error); + } + }; + + const handleCopyCode = () => { + if (qrUri) { + navigator.clipboard.writeText(qrUri) + .then(() => { + alert('Code copied to clipboard'); + }) + .catch((error) => { + console.error('Failed to copy code:', error); + }); + } + }; + + return ( +
+
+

{ screen.texts?.title ?? 'Enroll with Push Notification' }

+

{ screen.texts?.description ?? '' }

+ { + qrCode ? ( +
+ QR Code + + {showCodeCopy && qrUri && ( +
+

Or copy this code to your authenticator app:

+
+ + {qrUri} + + +
+
+ )} +
+ ) : ( +

Loading QR Code...

+ ) + } + +
+
+ ); +}; + +export default MfaPushEnrollmentQrScreen; +``` + +```typescript Pick Authenticator lines +import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr'; + +const mfaPushEnrollmentQr = new MfaPushEnrollmentQr(); + +mfaPushEnrollmentQr.pickAuthenticator(); +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Navigates to the authenticator selection screen. + + + CustomOptions}> + + + + +MfaPushPollingControl}> + Starts and manages polling for an MFA push challenge. Creates a polling session that repeatedly checks the MFA push challenge endpoint at the specified interval until the challenge is approved or an error occurs. When the approval condition is met, the provided callback is invoked and polling stops automatically. Use the returned to start, stop, or check the status of the polling process at any time. + + + MfaPollingOptions} required> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-push-enrollment-qr/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushList.mdx new file mode 100644 index 000000000..1b0fec3cf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushList.mdx @@ -0,0 +1,167 @@ +--- +title: "MfaPushList" +description: "Class implementing the mfa-push-list screen functionality" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React from 'react'; +import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; + +const MfaPushListScreen: React.FC = () => { + const mfaPushList = new MfaPushList(); + const { screen, user } = mfaPushList; + const { enrolledDevices } = user || {}; + + const handleSelectDevice = async (deviceIndex: number) => { + try { + await mfaPushList.selectMfaPushDevice({ deviceIndex }); + } catch (error) { + console.error('Failed to select device:', error); + } + }; + + const handleGoBack = async () => { + try { + await mfaPushList.goBack(); + } catch (error) { + console.error('Failed to go back:', error); + } + }; + + return ( +
+
+

{ screen.texts?.title ?? 'Select a Device for MFA Push' }

+

{ screen.texts?.description }

+ { + enrolledDevices && enrolledDevices.length > 0 ? ( +
    + {enrolledDevices.map((device, index) => ( +
  • + +
    • + ))} +
+ ) : ( +

No enrolled devices found.

+ ) + } + +
+
+ ); +}; + +export default MfaPushListScreen; +``` + +```typescript Select MFA Push Device lines +import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; + +const mfaPushList = new MfaPushList(); + +const enrolledDevices = mfaSmsList.user.enrolledDevices; +// select any device from list, for demonstration we will pick up first device +const selectedEmail = enrolledDevices[0] + +// Select the first device (index 0) +await mfaPushList.selectMfaPushDevice({ deviceIndex: 0 }); +``` + +```typescript Go Back lines +import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; + +const mfaPushList = new MfaPushList(); + +// Navigate back to the previous screen +await mfaPushList.goBack(); +``` + + + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Selects a registered device from the list to initiate MFA push. + + + SelectMfaPushDeviceOptions} required> + + + + +Promise<void>}> + Navigates back to the previous screen. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-push-list/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushWelcome.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushWelcome.mdx new file mode 100644 index 000000000..f78562d0f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushWelcome.mdx @@ -0,0 +1,160 @@ +--- +title: "MfaPushWelcome" +description: "@extends Implements the mfa-push-welcome screen functionality." +--- + + + +```typescript Enroll lines +import React, { useCallback } from 'react'; +import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome'; + +const MfaPushWelcomeScreen: React.FC = () => { + const mfaPushWelcome = new MfaPushWelcome(); + const { screen } = mfaPushWelcome; + + /** Button Styles */ + const buttonBase = + "py-2 px-4 font-bold rounded focus:outline-none focus:shadow-outline transition"; + const primaryButton = `${buttonBase} bg-blue-500 hover:bg-blue-700 text-white`; + const secondaryButton = `${buttonBase} bg-gray-500 hover:bg-gray-700 text-white`; + const linkStyle = "text-blue-600 hover:text-blue-800 hover:underline transition"; + + /** Handle Enroll */ + const handleEnroll = useCallback(async () => { + try { + await mfaPushWelcome.enroll(); + } catch (error) { + console.error('Failed to enroll:', error); + } + }, []); + + /** Handle Pick Authenticator */ + const handlePickAuthenticator = useCallback(async () => { + try { + await mfaPushWelcome.pickAuthenticator(); + } catch (error) { + console.error('Failed to pick authenticator:', error); + } + }, []); + + return ( +
+
+

+ {screen.texts?.title ?? 'Secure Your Account'} +

+

+ {screen.texts?.description ?? + 'To continue, install the Auth0 Guardian app from your mobile device’s app store.'} +

+ + {/* Buttons */} +
+ + +
+ + {/* App Download Links */} +
+ {screen.links?.ios && ( +

+ + Download iOS App + +

+ )} + {screen.links?.android && ( +

+ + Download Android App + +

+ )} +
+
+
+ ); +}; + +export default MfaPushWelcomeScreen; +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Navigates to the enrollment screen. + + + CustomOptions}> + + + + +Promise<void>}> + Navigates to the authenticator selection screen. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-push-welcome/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallenge.mdx new file mode 100644 index 000000000..fdc457eb8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallenge.mdx @@ -0,0 +1,175 @@ +--- +title: "MfaRecoveryCodeChallenge" +description: "Class implementing the MFA Recovery Code Challenge screen functionality." +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useState } from 'react'; +import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge'; + +const MfaRecoveryCodeChallengeScreen: React.FC = () => { + const [code, setCode] = useState(''); + const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge(); + const { screen, transaction: { errors } } = mfaRecoveryCodeChallenge; + const texts = screen.texts ?? {}; + + const handleSubmit = (e: React.FormEvent) => { + e.preventDefault(); + mfaRecoveryCodeChallenge.continue(code); + }; + + const handleTryAnotherMethod = () => { + mfaRecoveryCodeChallenge.tryAnotherMethod(); + }; + + return ( +
+
+

+ {texts.title ?? 'Verify Your Identity'} +

+

+ {texts.description ?? 'Enter the recovery code you were provided during your initial enrollment.'} +

+ +
+
+ + setCode(e.target.value)} + className="shadow appearance-none border rounded w-full py-2 px-3 text-gray-700 leading-tight focus:outline-none focus:shadow-outline" + required + /> + {errors && errors?.length && ( +
+ {errors.map((error, idx) => ( +

+ {error.message} +

+ ))} +
+ )} +
+ + +
+ + +
+
+ ); +}; + +export default MfaRecoveryCodeChallengeScreen; +``` + +```typescript Continue with Code lines +import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge'; + +const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge(); + +mfaRecoveryCodeChallenge.continue('PJVLZM6MS8DP6JYRT97XYZM2'); +``` + +```typescript Try Another Method lines +import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge'; + +const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge(); + +mfaRecoveryCodeChallenge.tryAnotherMethod(); +``` + + + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Continues with the provided recovery code. + + + ContinueOptions} required> + + + + +Promise<void>}> + Navigates to the screen where the user can pick another MFA method. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-recovery-code-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallengeNewCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallengeNewCode.mdx new file mode 100644 index 000000000..8383cf4bc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallengeNewCode.mdx @@ -0,0 +1,213 @@ +--- +title: "MfaRecoveryCodeChallengeNewCode" +description: "" +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useState, useCallback } from 'react'; +import MfaRecoveryCodeChallengeNewCode from '@auth0/auth0-acul-js/mfa-recovery-code-challenge-new-code'; + +const MfaRecoveryCodeChallengeNewCodeScreen: React.FC = () => { + // Instantiate the SDK class for the screen + const screenManager = new MfaRecoveryCodeChallengeNewCode(); + const { screen, transaction } = screenManager; + + // State to track if the user has confirmed saving the code + const [hasSavedCode, setHasSavedCode] = useState(false); + // State for loading indicator during submission + const [isLoading, setIsLoading] = useState(false); + // State for potential submission errors + const [error, setError] = useState(null); + + // Get the recovery code from the screen data, provide fallback + const recoveryCode = screen?.data?.textCode ?? 'CODE-NOT-AVAILABLE'; + const texts = screen?.texts ?? {}; + + // Handler for the checkbox change + const handleCheckboxChange = (event: React.ChangeEvent): void => { + setHasSavedCode(event.target.checked); + setError(null); // Clear error when checkbox state changes + }; + + // Handler for the continue button click + const handleContinue = useCallback(async () => { + if (!hasSavedCode) { + setError('Please confirm you have saved the recovery code.'); + return; + } + setIsLoading(true); + setError(null); + try { + // Call the continue method - no payload needed unless passing custom options + await screenManager.continue(); + // On success, Auth0 handles the redirect automatically. + // No need to set isLoading to false here. + } catch (err: any) { + // Check for specific server-side errors if needed + const serverError = transaction.errors?.find(e => e.code === 'no-confirmation'); + if (serverError) { + setError(serverError.message); + } else { + setError(err.message || 'An unexpected error occurred. Please try again.'); + } + setIsLoading(false); // Stop loading only on error + } + }, [hasSavedCode, screenManager, transaction.errors]); + + return ( +
+
+

+ {texts.title ?? 'Save Your Recovery Code'} +

+

+ {texts.description ?? 'Save this recovery code in a safe place. You will need it to log in if you lose access to your other multi-factor authentication methods.'} +

+ + {/* Display the Recovery Code */} +
+

+ {recoveryCode} +

+
+ + {/* Confirmation Checkbox */} +
+ + +
+ + {/* Display errors (transaction errors or client-side errors) */} + {(transaction.errors?.length || error) && ( +
+ {error &&

{error}

} + {transaction.errors?.map((err, index) => ( +

{err.message}

+ ))} +
+ )} + + {/* Continue Button */} + +
+
+ ); +}; + +export default MfaRecoveryCodeChallengeNewCodeScreen; +``` + +```jsx Confirm Saving the Code and Continue lines +import MfaRecoveryCodeChallengeNewCode from '@auth0/auth0-acul-js/mfa-recovery-code-challenge-new-code'; + +const screenManager = new MfaRecoveryCodeChallengeNewCode(); + +// This should typically be called after the user confirms saving the code, +// e.g., by checking a box and clicking a button. +async function confirmAndContinue() { + try { + // The SDK handles sending the required 'saved=on' parameter internally. + await screenManager.continue(); + // If successful, the browser will redirect. + } catch (error) { + console.error("Failed to confirm saving the recovery code:", error); + // Handle potential errors, e.g., display error messages from screenManager.transaction.errors + if (screenManager.transaction.errors?.length) { + screenManager.transaction.errors.forEach(err => console.log(err.message)); + } + } +} + +// Example trigger (replace with actual UI interaction) +// if (userConfirmedSavingCode) { +// confirmAndContinue(); +// } +``` + + + +## Properties + +string} required> + The unique identifier for this screen, used internally and for telemetry. + + +ScreenMembersOnMfaRecoveryCodeChallengeNewCode} required> + Holds the specific screen data and properties, processed by ScreenOverride. + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Confirms that the user has saved the new recovery code and continues the authentication flow. This method sends a POST request to the `/u/mfa-recovery-code-challenge-new-code` endpoint with the required `state`, `action`, and `saved` parameters. + + + ContinueOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-recovery-code-challenge-new-code/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeEnrollment.mdx new file mode 100644 index 000000000..04f7098c8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeEnrollment.mdx @@ -0,0 +1,138 @@ +--- +title: "MfaRecoveryCodeEnrollment" +description: "Class implementing the Mfa Recovery Code Enrollment screen functionality. This screen is displayed when the user needs to enroll with a recovery code for MFA." +--- + + + +```tsx React Component Example with TailwindCSS lines +import React from 'react'; +import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment'; + +const MfaRecoveryCodeEnrollmentScreen: React.FC = () => { + const mfaRecoveryCodeEnrollment = new MfaRecoveryCodeEnrollment(); + const { screen, transaction } = mfaRecoveryCodeEnrollment; + const texts = screen?.texts ?? {}; + + const handleContinue = async () => { + try { + await mfaRecoveryCodeEnrollment.continue(); + } catch (error) { + console.error('Failed to continue:', error); + } + }; + + return ( +
+
+

+ {texts.title ?? 'MFA Recovery Code Enrollment'} +

+ +

+ {texts.description ?? 'Please save this recovery code in a safe place:'} +

+ +

+ {screen?.data?.textCode ?? '******-******'} +

+ + {transaction?.errors?.length && ( +
+ {transaction.errors.map((err, index) => ( +

+ {err.message} +

+ ))} +
+ )} + + +
+
+ ); +}; + +export default MfaRecoveryCodeEnrollmentScreen; +``` + +```typescript Continue lines +import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment'; + +const mfaRecoveryCodeEnrollment = new MfaRecoveryCodeEnrollment(); + +// Declare that the user saved the recovery code +await mfaRecoveryCodeEnrollment.continue(); +``` + + + +## Properties + +string} required> + + +ScreenMembersOnMfaRecoveryCodeEnrollment} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Declares that the user saved the recovery code. This action is triggered when the user declares that they have saved the recovery code. It redirects to the next screen in the authentication flow. + + + MfaRecoveryCodeEnrollmentContinueOptions} required> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-recovery-code-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsChallenge.mdx new file mode 100644 index 000000000..a2a0df206 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsChallenge.mdx @@ -0,0 +1,335 @@ +--- +title: "MfaSmsChallenge" +description: "This class provides methods to handle the mfa-sms-challenge screen." +--- + + + +```typescript resendManager lines +import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; + +const mfaSmsChallenge = new MfaSmsChallenge(); + +function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); +} + +function handleTimeout() { + console.log('Resend timeout completed'); +} + +const resendManager = mfaSmsChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout, +}); + +const { startResend } = resendManager; + +// Use startResend() to initiate the resend with cooldown +startResend(); +``` + +```jsx React Component Example with TailwindCSS lines +import { useState, useEffect, useMemo } from 'react'; +import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; + +const MfaSmsChallengeScreen = () => { + const mfaSmsChallenge = useMemo(() => new MfaSmsChallenge(), []); + const [code, setCode] = useState(''); + const [rememberDevice, setRememberDevice] = useState(false); + const [disabled, setDisabled] = useState(false); + const [remainingSeconds, setRemainingSeconds] = useState(0); + const { phoneNumber, showRememberDevice, showLinkVoice } = mfaSmsChallenge.screen.data || {}; + + function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { + setDisabled(isDisabled); + setRemainingSeconds(remainingSeconds); + } + + function handleTimeout() { + console.log('Resend timeout completed'); + } + + const resendManager = useMemo( + () => + mfaSmsChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout, + }), + [mfaSmsChallenge] + ); + + const { startResend } = resendManager; + + // Initialize form values from untrustedData + useEffect(() => { + // Use untrustedData to prepopulate form fields if available + const savedFormData = mfaSmsChallenge.untrustedData.submittedFormData; + if (savedFormData?.rememberDevice !== undefined) { + setRememberDevice(savedFormData.rememberDevice); + } + }, [mfaSmsChallenge]); + + const handleSubmit = async (e: { preventDefault: () => void; }) => { + e.preventDefault(); + try { + await mfaSmsChallenge.continueMfaSmsChallenge({ + code, + rememberDevice, + }); + } catch (error) { + console.error('MFA SMS Challenge failed:', error); + } + }; + + const handlePickSms = async () => { + try { + await mfaSmsChallenge.pickSms(); + } catch (error) { + console.error('Pick SMS failed:', error); + } + }; + + const handleResendCode = async () => { + try { + await startResend(); + } catch (error) { + console.error('Resend code failed:', error); + } + }; + + const handleTryAnotherMethod = async () => { + try { + await mfaSmsChallenge.tryAnotherMethod(); + } catch (error) { + console.error('Try another method failed:', error); + } + }; + + const handleGetACall = async () => { + try { + await mfaSmsChallenge.getACall(); + } catch (error) { + console.error('Get a call failed:', error); + } + }; + + return ( +
+
+

+ MFA SMS Challenge +

+ {phoneNumber && ( +

+ Enter the code sent to {phoneNumber} +

+ )} +
+ +
+
+
+
+ +
+ setCode(e.target.value)} + className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> +
+
+ + {showRememberDevice && ( +
+ setRememberDevice(e.target.checked)} + /> + +
+ )} + +
+ +
+
+ +
+ + + + {showLinkVoice && ( + + )} +
+
+
+
+ ); +}; + +export default MfaSmsChallengeScreen; +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + + +UntrustedDataOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Submits the MFA SMS challenge with the provided code and rememberDevice option. + + + MfaSmsChallengeOptions} required> + + + + +Promise<void>}> + Submits the action to pick a different SMS configuration, if available. + + + CustomOptions}> + + + + +Promise<void>}> + Submits the action to resend the SMS code. + + + CustomOptions}> + + + + +Promise<void>}> + Submits the action to try another MFA method. + + + CustomOptions}> + + + + +Promise<void>}> + Submits the action to switch to voice call verification. + + + CustomOptions}> + + + + +ResendControl}> + Gets resend functionality with timeout management for this screen + + + StartResendOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-sms-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsEnrollment.mdx new file mode 100644 index 000000000..bcbac8b53 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsEnrollment.mdx @@ -0,0 +1,189 @@ +--- +title: "MfaSmsEnrollment" +description: "Represents the MFA SMS Enrollment screen." +--- + + + +```typescript Pick Country Code lines +import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; + +const mfaSmsEnrollment = new MfaSmsEnrollment(); + +// Call the pickCountryCode method +mfaSmsEnrollment.pickCountryCode(); +``` + +```typescript Continue Enrollment lines +import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; + +const mfaSmsEnrollment = new MfaSmsEnrollment(); + +// Call the continueEnrollment method with a phone number +mfaSmsEnrollment.continueEnrollment({ + phone: "1234567890" +}); +``` + +```typescript Try Another Method lines +import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; + +const mfaSmsEnrollment = new MfaSmsEnrollment(); + +// Call the tryAnotherMethod +mfaSmsEnrollment.tryAnotherMethod(); +``` + +```jsx React Component Example with TailwindCSS lines +import React, { useState } from 'react'; +import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; + +const MFASmsEnrollmentScreen = () => { + const [phone, setPhone] = useState(''); + const mfaSmsEnrollment = new MfaSmsEnrollment(); + + const handlePickCountryCode = async () => { + await mfaSmsEnrollment.pickCountryCode(); + }; + + const handleContinueEnrollment = async () => { + await mfaSmsEnrollment.continueEnrollment({ phone }); + }; + + const handleTryAnotherMethod = async () => { + await mfaSmsEnrollment.tryAnotherMethod(); + }; + + return ( +
+
+

MFA SMS Enrollment

+ +
+ + setPhone(e.target.value)} + /> +
+ +
+ + + +
+
+
+ ); +}; + +export default MFASmsEnrollmentScreen; +``` + + + +## Properties + +string} required> + + +ScreenMembersOnMfaSmsEnrollment} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Handles the action to pick a country code for SMS enrollment. + + + CustomOptions}> + + + + +Promise<void>}> + Continues the SMS enrollment process with the provided phone number. + + + MfaSmsEnrollmentOptions} required> + + + + +Promise<void>}> + Handles the action to try another method for MFA. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-sms-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsList.mdx new file mode 100644 index 000000000..d3e08659f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsList.mdx @@ -0,0 +1,154 @@ +--- +title: "MfaSmsList" +description: "Class for handling the mfa-sms-list screen." +--- + + + +```typescript Select Phone Number lines +import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list'; + +const mfaSmsList = new MfaSmsList(); + +const getEnrolledPhoneNumbers = mfaSmsList.user.enrolledPhoneNumbers; +// select any phone number from list, for demonstration we will pick up first number +const selectedNumber = getEnrolledPhoneNumbers[0] + +// Select the first phone number in the list +mfaSmsList.selectPhoneNumber({index: selectedNumber}); +``` + +```typescript Back Action lines +import React from 'react'; +import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list'; + +const MFASmsListScreen: React.FC = () => { + const mfaSmsList = new MfaSmsList(); + const { user } = mfaSmsList; + + const handleSelectPhoneNumber = async (index: number) => { + try { + await mfaSmsList.selectPhoneNumber({index}); + } catch (error) { + console.error('Failed to select phone number:', error); + } + }; + + const handleBackAction = async () => { + try { + await mfaSmsList.backAction(); + } catch (error) { + console.error('Failed to go back:', error); + } + }; + + return ( +
+
+

Select a Phone Number

+ { + user.enrolledPhoneNumbers ? ( +
    + {user.enrolledPhoneNumbers?.map((phoneNumber, index) => ( +
  • + +
    • + ))} +
+ ) : ( +

No phone numbers enrolled.

+ ) + } + +
+
+ ); +}; + +export default MFASmsListScreen; +``` + + + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Selects a phone number from the list of enrolled phone numbers. + + + MfaSmsListOptions}> + + + + +Promise<void>}> + Navigates back to the previous screen. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-sms-list/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceChallenge.mdx new file mode 100644 index 000000000..eb00e544a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceChallenge.mdx @@ -0,0 +1,508 @@ +--- +title: "MfaVoiceChallenge" +description: "MFA Voice Challenge screen implementation. This screen is displayed when a user needs to verify their identity using a voice call as part of a multi-factor authentication flow." +--- + + + +```typescript Continue with Voice Code Verification lines +import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; + +const mfaVoiceChallenge = new MfaVoiceChallenge(); + +// Submit the verification code the user received via voice call +mfaVoiceChallenge.continue({ + code: '123456', + rememberDevice: true // Optional: to remember this device for 30 days +}); +``` + +```typescript Pick a Different Phone Number lines +import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; + +const mfaVoiceChallenge = new MfaVoiceChallenge(); + +// Navigate to the screen for selecting a different phone number +mfaVoiceChallenge.pickPhone(); +``` + +```typescript Switch to SMS Verification Instead lines +import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; + +const mfaVoiceChallenge = new MfaVoiceChallenge(); + +// Switch to SMS verification instead of voice call +mfaVoiceChallenge.switchToSms(); +``` + +```typescript Resend Voice Call with Verification Code lines +import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; + +const mfaVoiceChallenge = new MfaVoiceChallenge(); + +// Request a new voice call with verification code +mfaVoiceChallenge.resendCode(); +``` + +```typescript Try Another MFA Method lines +import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; + +const mfaVoiceChallenge = new MfaVoiceChallenge(); + +// Navigate to the screen for selecting an alternative MFA method +mfaVoiceChallenge.tryAnotherMethod(); +``` + +```typescript resendManager lines +import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; + +const mfaVoiceChallenge = new MfaVoiceChallenge(); + +function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); +} + +function handleTimeout() { + console.log('Resend timeout completed'); +} + +const resendManager = mfaVoiceChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout, +}); + +const { startResend } = resendManager; + +// Use startResend() to initiate the resend with cooldown +startResend(); +``` + +```typescript Below is a complete React component implementing the MFA Voice Challenge screen with TailwindCSS: lines +import React, { useState, useEffect, FormEvent, ChangeEvent, useMemo } from 'react'; +import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; + +/** + * MFA Voice Challenge Screen Component + * + * This component renders a form for users to submit their voice verification code + * received during multi-factor authentication. + */ +const MfaVoiceChallengeScreen: React.FC = () => { + // State for form inputs + const [code, setCode] = useState(''); + const [rememberDevice, setRememberDevice] = useState(false); + + // UI state + const [isLoading, setIsLoading] = useState(false); + const [error, setError] = useState(null); + const [phoneNumber, setPhoneNumber] = useState(''); + const [showRememberDevice, setShowRememberDevice] = useState(false); + const [showLinkSms, setShowLinkSms] = useState(false); + const [disabled, setDisabled] = useState(false); + const [remainingSeconds, setRemainingSeconds] = useState(0); + + // Initialize MFA Voice Challenge SDK + const mfaVoiceChallenge = useMemo(() => new MfaVoiceChallenge(), []); + + function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { + setDisabled(isDisabled); + setRemainingSeconds(remainingSeconds); + } + + function handleTimeout() { + console.log('Resend timeout completed'); + } + + const resendManager = useMemo( + () => + mfaVoiceChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout, + }), + [mfaVoiceChallenge] + ); + + const { startResend } = resendManager; + + useEffect(() => { + // Get data from the screen when component mounts + if (mfaVoiceChallenge.screen.data) { + if (mfaVoiceChallenge.screen.data.phoneNumber) { + setPhoneNumber(mfaVoiceChallenge.screen.data.phoneNumber); + } + if (mfaVoiceChallenge.screen.data.showRememberDevice !== undefined) { + setShowRememberDevice(mfaVoiceChallenge.screen.data.showRememberDevice); + } + if (mfaVoiceChallenge.screen.data.showLinkSms !== undefined) { + setShowLinkSms(mfaVoiceChallenge.screen.data.showLinkSms); + } + } + + // Use untrustedData to prepopulate form fields if available + const savedFormData = mfaVoiceChallenge.untrustedData.submittedFormData; + if (savedFormData?.rememberDevice !== undefined) { + setRememberDevice(savedFormData.rememberDevice); + } + }, [mfaVoiceChallenge]); + + /** + * Handles the form submission to verify the voice code + */ + const handleSubmit = async (e: FormEvent): Promise => { + e.preventDefault(); + setIsLoading(true); + setError(null); + + try { + await mfaVoiceChallenge.continue({ + code, + rememberDevice, + }); + } catch (err) { + setError(err instanceof Error ? err.message : 'Failed to verify code'); + } finally { + setIsLoading(false); + } + }; + + /** + * Handles the resend code action + */ + const handleResendCode = async (): Promise => { + try { + await startResend(); + } catch (err) { + setError(err instanceof Error ? err.message : 'Failed to resend code'); + } + }; + + /** + * Handles the change event for the code input field + */ + const handleCodeChange = (e: ChangeEvent): void => { + setCode(e.target.value); + }; + + /** + * Handles the change event for the remember browser checkbox + */ + const handleRememberDeviceChange = ( + e: ChangeEvent + ): void => { + setRememberDevice(e.target.checked); + }; + + /** + * Handles switching to SMS verification + */ + const handleSwitchToSms = async (): Promise => { + setIsLoading(true); + try { + await mfaVoiceChallenge.switchToSms(); + } catch (err) { + setError(err instanceof Error ? err.message : 'Failed to switch to SMS'); + setIsLoading(false); + } + }; + + /** + * Handles navigating to pick a different phone number + */ + const handlePickPhone = async (): Promise => { + setIsLoading(true); + try { + await mfaVoiceChallenge.pickPhone(); + } catch (err) { + setError( + err instanceof Error + ? err.message + : 'Failed to navigate to phone selection' + ); + setIsLoading(false); + } + }; + + /** + * Handles navigating to try another MFA method + */ + const handleTryAnotherMethod = async (): Promise => { + setIsLoading(true); + try { + await mfaVoiceChallenge.tryAnotherMethod(); + } catch (err) { + setError( + err instanceof Error + ? err.message + : 'Failed to navigate to method selection' + ); + setIsLoading(false); + } + }; + + return ( +
+
+

+ Voice Verification +

+

+ {phoneNumber ? ( + <> + We've called {phoneNumber}{' '} + with your verification code. + + ) : ( + "We've called your phone with a verification code." + )} +

+
+ +
+
+
+
+ +
+ +
+
+ + {showRememberDevice && ( +
+ + +
+ )} + + {error && ( +
+
+
+

Error

+
{error}
+
+
+
+ )} + +
+ +
+
+ +
+
+
+
+
+
+ Options +
+
+ +
+ + + {showLinkSms && ( + + )} + + + + +
+
+
+
+
+ ); +}; + +export default MfaVoiceChallengeScreen; +``` + + + +## Properties + +string} required> + Screen identifier for validation and telemetry + + +ScreenOptions} required> + Screen-specific properties and data. + + +UntrustedDataOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Submits the voice verification code to validate the MFA challenge. + + + MfaVoiceChallengeContinueOptions} required> + + + + +Promise<void>}> + Navigates to the screen for selecting a different phone number. + + + CustomOptions}> + + + + +Promise<void>}> + Switches to SMS verification method instead of voice call. + + + CustomOptions}> + + + + +Promise<void>}> + Requests a new voice call with a verification code. + + + CustomOptions}> + + + + +Promise<void>}> + Navigates to the screen for selecting an alternative MFA method. + + + CustomOptions}> + + + + +ResendControl}> + Gets resend functionality with timeout management for this screen + + + StartResendOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-voice-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceEnrollment.mdx new file mode 100644 index 000000000..6bdbf6466 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceEnrollment.mdx @@ -0,0 +1,205 @@ +--- +title: "MfaVoiceEnrollment" +description: "Class implementing the mfa-voice-enrollment screen functionality." +--- + + + +```tsx React Component Example with TailwindCSS lines +import React, { useState } from 'react'; +import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; + +const MfaVoiceEnrollmentScreen: React.FC = () => { + const [phone, setPhone] = useState(''); + const mfaVoiceEnrollment = new MfaVoiceEnrollment(); + const { screen, transaction: { errors } } = mfaVoiceEnrollment; + const texts = screen.texts ?? {}; + + const handlePickCountryCode = async () => { + await mfaVoiceEnrollment.selectPhoneCountryCode(); + }; + + const handleContinueEnrollment = async () => { + await mfaVoiceEnrollment.continue({ phone }); + }; + + const handleTryAnotherMethod = async () => { + await mfaVoiceEnrollment.tryAnotherMethod(); + }; + + return ( +
+
+

+ {texts.title ?? 'Secure Your Account'} +

+

+ {texts.description ?? 'Enter your phone number below. A voice call will be placed on that number with a code to enter on the next screen.'} +

+ + + +
+ + setPhone(e.target.value)} + /> + {errors?.length > 0 && ( +
+ {errors.map((error, idx) => ( +

+ {error.message} +

+ ))} +
+ )} +
+ + + + +
+
+ ); +}; + +export default MfaVoiceEnrollmentScreen; +``` + +```typescript Pick Country Code lines +import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; + +const mfaVoiceEnrollment = new MfaVoiceEnrollment(); + +// Call the pickCountryCode method +mfaVoiceEnrollment.selectPhoneCountryCode(); +``` + +```typescript Continue Enrollment lines +import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; + +const mfaVoiceEnrollment = new MfaVoiceEnrollment(); + +// Call the continue method with a phone number +mfaVoiceEnrollment.continue({ + phone: "1234567890" +}); +``` + +```typescript Try Another Method lines +import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; + +const mfaVoiceEnrollment = new MfaVoiceEnrollment(); + +// Call the tryAnotherMethod +mfaVoiceEnrollment.tryAnotherMethod(); +``` + + + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Continues with the default action. + + + ContinueOptions} required> + + + + +Promise<void>}> + Allows trying another authentication method + + + CustomOptions}> + + + + +Promise<void>}> + Allows picking a country code for the phone number + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-voice-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnChangeKeyNickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnChangeKeyNickname.mdx new file mode 100644 index 000000000..50a9e4a8c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnChangeKeyNickname.mdx @@ -0,0 +1,69 @@ +--- +title: "MfaWebAuthnChangeKeyNickname" +description: "" +--- + +## Properties + +string} required> + + +ScreenOptions} required> + Holds the specific screen data and properties for this screen, processed by `ScreenOverride`. This includes the current `nickname` of the key. + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Submits the new nickname provided by the user for their WebAuthn security key. This method prepares and posts the form data, including the new `nickname` and the required `action: "default"`, to the `/u/mfa-webauthn-change-key-nickname` endpoint. + + + ContinueOptions} required> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-webauthn-change-key-nickname/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnEnrollmentSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnEnrollmentSuccess.mdx new file mode 100644 index 000000000..a21056937 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnEnrollmentSuccess.mdx @@ -0,0 +1,70 @@ +--- +title: "MfaWebAuthnEnrollmentSuccess" +description: "" +--- + +## Properties + +string} required> + static + + +ScreenOptions} required> + Holds the specific screen data and properties for this screen, processed by `ScreenOverride`. This includes the enrolled authenticator's `nickname` and `webauthnType`. + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Allows the user to continue the authentication flow after a successful WebAuthn enrollment. This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` endpoint with the action set to "default", indicating the user is proceeding from this success screen. + + + ContinueOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-webauthn-enrollment-success/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnError.mdx new file mode 100644 index 000000000..2c45f40f2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnError.mdx @@ -0,0 +1,97 @@ +--- +title: "MfaWebAuthnError" +description: "" +--- + +## Properties + +string} required> + static + + +ScreenOptions} required> + Holds the specific screen data and properties, processed by `ScreenOverride` for the MFA WebAuthn Error screen. This includes details like `errorType` and `webauthnType`. + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Allows the user to retry the previous WebAuthn operation. This action typically redirects the user to the screen where the WebAuthn process was initially attempted (e.g., back to the MFA challenge or enrollment screen for WebAuthn). + + + CustomOptions}> + + + + +Promise<void>}> + Allows the user to attempt authentication using their password, if this alternative is configured and appropriate for the current flow (e.g., if password was a prior authentication step or is a valid MFA bypass). + + + CustomOptions}> + + + + +Promise<void>}> + Allows the user to choose a different Multi-Factor Authentication method. This action navigates the user to a screen where they can select from other available/enrolled MFA factors. + + + CustomOptions}> + + + + +Promise<void>}> + Allows the user to decline the current WebAuthn operation (e.g., refuse to add a device during enrollment). This action signifies the user's choice not to proceed with the WebAuthn step at this time. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-webauthn-error/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnNotAvailableError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnNotAvailableError.mdx new file mode 100644 index 000000000..3561ac962 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnNotAvailableError.mdx @@ -0,0 +1,69 @@ +--- +title: "MfaWebAuthnNotAvailableError" +description: "" +--- + +## Properties + +string} required> + static + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Allows the user to select a different Multi-Factor Authentication method because WebAuthn is not available or supported on their current device/browser. This action navigates the user to a screen where they can choose from other available/enrolled MFA factors. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-webauthn-not-available-error/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-not-available-error/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformChallenge.mdx new file mode 100644 index 000000000..5b0529eb5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,88 @@ +--- +title: "MfaWebAuthnPlatformChallenge" +description: "" +--- + +## Properties + +string} required> + static + + +ScreenOptions} required> + Holds the specific screen data and properties for this screen, processed by `ScreenOverride`. This includes `publicKey` for the WebAuthn API call and `showRememberDevice`. + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Initiates the WebAuthn platform authenticator challenge. Internally, this method retrieves the challenge options from `this.screen.publicKey`, calls `navigator.credentials.get()` (via the `getPasskeyCredentials` utility), and then submits the resulting credential assertion to the Auth0 server. + + + VerifyPlatformAuthenticatorOptions}> + + + + +Promise<void>}> + Reports a browser-side error encountered during the WebAuthn `navigator.credentials.get()` operation. This method should be called when `verify()` fails due to a WebAuthn API error (e.g., user cancellation). It sends the error details to the server with a specific action format. + + + ReportBrowserErrorOptions} required> + + + + +Promise<void>}> + Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate the user to an MFA factor selection screen. + + + TryAnotherMethodOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-webauthn-platform-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformEnrollment.mdx new file mode 100644 index 000000000..a902f38e9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformEnrollment.mdx @@ -0,0 +1,97 @@ +--- +title: "MfaWebAuthnPlatformEnrollment" +description: "" +--- + +## Properties + +string} required> + static + + +ScreenOptions} required> + Holds the specific screen data and properties, processed by `ScreenOverride` for the MFA WebAuthn Platform Enrollment screen. This includes convenient access to `screen.publicKey`. + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Initiates the WebAuthn platform credential creation process using the public key options available on `this.screen.publicKey` and submits the resulting credential to the server. This method internally calls `createPasskeyCredentials` (which wraps `navigator.credentials.create()`). + + + SubmitPasskeyCredentialOptions}> + + + + +Promise<void>}> + Reports a browser-side error encountered during the WebAuthn `navigator.credentials.create()` operation. + + + ReportBrowserErrorOptions} required> + + + + +Promise<void>}> + Allows the user to choose to snooze the WebAuthn platform enrollment. + + + CustomOptions}> + + + + +Promise<void>}> + Allows the user to refuse WebAuthn platform enrollment on the current device. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-webauthn-platform-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingChallenge.mdx new file mode 100644 index 000000000..bbeff9e9e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,82 @@ +--- +title: "MfaWebAuthnRoamingChallenge" +description: "" +--- + +## Properties + +string} required> + static + + +ScreenOptions} required> + Holds the specific screen data and properties, processed by `ScreenOverride`. This includes `publicKeyChallengeOptions` for the WebAuthn API call. + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + + VerifySecurityKeyOptions}> + + + + +Promise<void>}> + + ReportWebAuthnErrorOptions} required> + + + + +Promise<void>}> + + TryAnotherMethodOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-webauthn-roaming-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingEnrollment.mdx new file mode 100644 index 000000000..2fd81ffba --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingEnrollment.mdx @@ -0,0 +1,86 @@ +--- +title: "MfaWebAuthnRoamingEnrollment" +description: "Class implementing the mfa-webauthn-roaming-enrollment screen functionality. This screen is displayed when a user needs to enroll a WebAuthn roaming authenticator (like a security key)." +--- + +## Properties + +string} required> + + +ScreenOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Initiates the WebAuthn credential creation and submits the result to the server. This corresponds to the user interacting with the FIDO Security Keys prompt. + + + CustomOptions} required> + + + + +Promise<void>}> + Submits details about a WebAuthn browser error to the server. This is used when the browser's WebAuthn API encounters an error. + + + ShowErrorOptions} required> + + + + +Promise<void>}> + Allows the user to try another MFA method. This corresponds to the "Try Another Method" button. + + + TryAnotherMethodOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/mfa-webauthn-roaming-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Organization.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Organization.mdx new file mode 100644 index 000000000..33471930a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Organization.mdx @@ -0,0 +1,34 @@ +--- +title: "Organization" +description: "" +--- + +## Properties + +OrganizationMembers['id']} required> + The unique identifier of the organization + + +OrganizationMembers['name']} required> + The name of the organization + + +OrganizationMembers['usage']} required> + How the organization is used in the authentication flow + + +OrganizationMembers['displayName']} required> + The display name of the organization + + +OrganizationMembers['branding']} required> + Organization-specific branding settings + + +OrganizationMembers['metadata']} required> + @property | null} metadata - Custom metadata associated with the organization + + +--- + +**File:** [src/models/organization.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/organization.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationPicker.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationPicker.mdx new file mode 100644 index 000000000..815320969 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationPicker.mdx @@ -0,0 +1,164 @@ +--- +title: "OrganizationPicker" +description: "Class implementing the organization-picker screen functionality. This screen allows users to select an organization from a list of available organizations." +--- + + + +```tsx React Component Example with TailwindCSS lines +import React from 'react'; +import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; + +const OrganizationPickerScreen: React.FC = () => { + const organizationPicker = new OrganizationPicker(); + const { screen, user } = organizationPicker; + + const handleSelectOrganization = async (organizationId: string) => { + try { + await organizationPicker.selectOrganization({ organization: organizationId, state: organizationPicker.transaction.state }); + } catch (error) { + console.error('Failed to select organization:', error); + } + }; + + const handleSkipOrganization = async () => { + try { + await organizationPicker.skipOrganizationSelection(); + } catch (error) { + console.error('Failed to skip organization selection:', error); + } + }; + + return ( +
+
+

{ `${ screen.texts?.title ?? 'Choose an Organization' }` }

+

{ `${ user.email } ${ screen.texts?.loggedInText ?? 'is used as a personal account and is a part of multiple organizations.' }` }

+ { + user.organizations ? ( +
    + {user.organizations.map((org) => ( +
  • + +
    • + ))} +
+ ) : ( +

No organizations available.

+ ) + } + +
+
+ ); +}; + +export default OrganizationPickerScreen; +``` + +```typescript Select Organization lines +import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; + +const organizationPicker = new OrganizationPicker(); + +// Select an organization +await organizationPicker.selectOrganization({ + organization: 'org_1234567890123456', + state: organizationPicker.transaction.state +}); +``` + +```typescript Skip Organization Selection lines +import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; + +const organizationPicker = new OrganizationPicker(); + +// Skip organization selection +await organizationPicker.skipOrganizationSelection(); +``` + + + +## Properties + +string} required> + Screen identifier for validation and telemetry + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Submits the selected organization ID. + + + SelectOrganizationOptions} required> + + + + +Promise<void>}> + Submits the action to skip the organization selection. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/organization-picker/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/organization-picker/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationSelection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationSelection.mdx new file mode 100644 index 000000000..6c8c1767c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationSelection.mdx @@ -0,0 +1,142 @@ +--- +title: "OrganizationSelection" +description: "Class implementing the organization-selection screen functionality. This screen allows users to select an organization to continue with." +--- + + + +```jsx React Component Example with TailwindCSS lines +import React, { useState } from 'react'; +import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection'; + +const OrganizationSelectionScreen = () => { + const [organizationName, setOrganizationName] = useState(''); + const organizationSelectionManager = new OrganizationSelection(); + + const { screen } = organizationSelectionManager; + + const handleSubmit = async (e: React.FormEvent) => { + e.preventDefault(); + try { + await organizationSelectionManager.continueWithOrganizationName({ + organizationName, + }); + } catch (error) { + console.error('Organization Selection failed:', error); + } + }; + + return ( +
+
+

+ { `${ screen?.texts?.title ?? 'Select Organization' }` } +

+

{ `${ screen?.texts?.description ?? 'Enter your xxxxx-xxxxxx Organization Name to continue' }`}

+
+ + +
+
+
+
+ +
+ setOrganizationName(e.target.value)} + className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> +
+
+ +
+ +
+
+
+
+
+ ); +}; + +export default OrganizationSelectionScreen; +``` + + + +## Properties + +string} required> + Screen identifier for validation and telemetry + + +ScreenOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Continues with the selected organization name. + + + ContinueWithOrganizationNameOptions} required> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/organization-selection/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/organization-selection/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollment.mdx new file mode 100644 index 000000000..e44108c69 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollment.mdx @@ -0,0 +1,91 @@ +--- +title: "PasskeyEnrollment" +description: "" +--- + + + +```typescript Enroll with Passkey local lines +import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; + +const passkeyEnrollment = new PasskeyEnrollment(); +passkeyEnrollment.continuePasskeyEnrollment(); +``` + +```typescript Abort passkey enrolment local lines +import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; + +const passkeyEnrollment = new PasskeyEnrollment(); +passkeyEnrollment.abortPasskeyEnrollment(); +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + + CustomOptions}> + + + + +Promise<void>}> + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/passkey-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollmentLocal.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollmentLocal.mdx new file mode 100644 index 000000000..6e09a7351 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollmentLocal.mdx @@ -0,0 +1,187 @@ +--- +title: "PasskeyEnrollmentLocal" +description: "" +--- + + + +```typescript continuePasskeyEnrollment lines +import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment-local'; + +// Create an instance of PasskeyEnrollment to handle the enrollment process +const passkeyEnrollment = new PasskeyEnrollment(); + +// Begin the passkey enrollment process for local authentication +// This will trigger the necessary flow for the user to enroll their passkey +passkeyEnrollment.continuePasskeyEnrollment(); +``` + +```typescript Abort local passkey enrolment lines +import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment-local'; + +const passkeyEnrollment = new PasskeyEnrollmentLocal(); +passkeyEnrollment.abortPasskeyEnrollment({ + doNotShowAgain: +}); +``` + +```typescript PasskeyEnrollmentLocal React Example lines +import React, { useState } from 'react'; +import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local'; + +const PasskeyEnrollmentLocalScreen: React.FC = () => { + const [error, setError] = useState(''); + const [success, setSuccess] = useState(false); + const [aborted, setAborted] = useState(false); + const [doNotShowAgain, setDoNotShowAgain] = useState(false); + + const passkeyEnrollment = new PasskeyEnrollmentLocal(); + + const handleContinue = async (e) => { + e.preventDefault(); + setError(''); + setSuccess(false); + setAborted(false); + try { + await passkeyEnrollment.continuePasskeyEnrollment(); + setSuccess(true); + } catch (err) { + setError('Failed to enroll passkey. Please try again.'); + } + }; + + const handleAbort = async (e) => { + e.preventDefault(); + setError(''); + setSuccess(false); + setAborted(false); + try { + await passkeyEnrollment.abortPasskeyEnrollment({ doNotShowAgain }); + setAborted(true); + } catch (err) { + setError('Failed to abort enrollment. Please try again.'); + } + }; + + return ( +
+
+

+ Passkey Enrollment (Local) +

+
+
+
+
+
+ +
+
+
+
+ setDoNotShowAgain(e.target.checked)} + className="h-4 w-4 text-blue-600 focus:ring-blue-500 border-gray-300 rounded" + /> + +
+ +
+ {error &&
{error}
} + {success &&
Passkey enrollment successful!
} + {aborted &&
Passkey enrollment aborted.
} +
+
+
+ ); +}; + +export default PasskeyEnrollmentLocalScreen; +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + + CustomOptions}> + + + + +Promise<void>}> + + AbortEnrollmentOptions} required> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/passkey-enrollment-local/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierChallenge.mdx new file mode 100644 index 000000000..a99441731 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierChallenge.mdx @@ -0,0 +1,299 @@ +--- +title: "PhoneIdentifierChallenge" +description: "" +--- + + + +```typescript submitPhoneChallenge lines +import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + +const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); +phoneIdentifierChallenge.submitPhoneChallenge({ + code:"dummyCode" +}); +``` + +```typescript resendCode lines +import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + +const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); +phoneIdentifierChallenge.resendCode(); +``` + +```typescript returnToPrevious lines +import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + +const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); +phoneIdentifierChallenge.returnToPrevious(); +``` + +```typescript resendManager lines +import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + +const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); + +function handleStatusChange(remainingSeconds: number) { + console.log('Remaining seconds:', remainingSeconds); +} + +function handleTimeout() { + console.log('Resend timeout completed'); +} + +const resendManager = phoneIdentifierChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout, +}); + +const { startResend } = resendManager; + +// Use startResend() to initiate the resend with cooldown +startResend(); +``` + +```typescript PhoneIdentifierChallenge React Example lines +import React, { useState, useMemo } from 'react'; +import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + +const PhoneIdentifierChallengeScreen: React.FC = () => { + const [code, setCode] = useState(''); + const [error, setError] = useState(''); + const [success, setSuccess] = useState(false); + const [resent, setResent] = useState(false); + const [returned, setReturned] = useState(false); + const [disabled, setDisabled] = useState(false); + + const phoneIdentifierChallenge = useMemo(() => new PhoneIdentifierChallenge(), []); + + function handleStatusChange(remainingSeconds: number) { + setDisabled(remainingSeconds > 0); + } + + function handleTimeout() { + console.log('Resend timeout completed'); + } + + const resendManager = useMemo( + () => + phoneIdentifierChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleonTimeout, + }), + [phoneIdentifierChallenge] + ); + + const { startResend } = resendManager; + + const handleSubmit = async (e: React.FormEvent) => { + e.preventDefault(); + setError(''); + setSuccess(false); + setResent(false); + setReturned(false); + + if (!code) { + setError('Code is required.'); + return; + } + try { + await phoneIdentifierChallenge.submitPhoneChallenge({ code }); + setSuccess(true); + } catch { + setError('Invalid code. Please try again.'); + } + }; + + const handleResend = async (e: React.FormEvent) => { + e.preventDefault(); + try { + await startResend(); + setResent(true); + } catch (err: any) { + setError(err.message || 'Failed to resend code.'); + } + }; + + const handleReturn = async (e: React.FormEvent) => { + e.preventDefault(); + setError(''); + setSuccess(false); + setResent(false); + setReturned(false); + + try { + await phoneIdentifierChallenge.returnToPrevious(); + setReturned(true); + } catch { + setError('Failed to return to previous step. Please try again later.'); + } + }; + + return ( +
+
+

+ Phone Identifier Challenge +

+
+
+
+
+
+ +
+ setCode(e.target.value)} + className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> +
+
+ +
+ {/* ✅ Resend with cooldown */} +
+ +
+
+ +
+ {error &&
{error}
} + {success &&
Challenge submitted successfully!
} + {resent &&
Code resent to your phone.
} + {returned &&
Returned to previous step.
} +
+
+
+ ); +}; + +export default PhoneIdentifierChallengeScreen; +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + + PhoneChallengeOptions} required> + + + + +Promise<void>}> + + CustomOptions}> + + + + +Promise<void>}> + + CustomOptions}> + + + + +Promise<void>}> + + CustomOptions}> + + + + +Promise<void>}> + + CustomOptions}> + + + + +ResendControl}> + Gets resend functionality with timeout management for this screen + + + StartResendOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/phone-identifier-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierEnrollment.mdx new file mode 100644 index 000000000..ef644ee5d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierEnrollment.mdx @@ -0,0 +1,183 @@ +--- +title: "PhoneIdentifierEnrollment" +description: "" +--- + + + +```typescript continuePhoneEnrollment lines +import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment'; + +const phoneIdentifierEnrollment = new PhoneIdentifierEnrollment(); +phoneIdentifierChallenge.continuePhoneEnrollment({ + type:"" +}); +``` + +```typescript returnToPrevious lines +import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment'; + +const phoneIdentifierEnrollment = new PhoneIdentifierEnrollment(); +phoneIdentifierChallenge.returnToPrevious(); +``` + +```typescript PhoneIdentifierEnrollment React Example lines +import React, { useState } from 'react'; +import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment'; + +const PhoneIdentifierEnrollmentScreen: React.FC = () => { + const [type, setType] = useState('text'); + const [error, setError] = useState(''); + const [success, setSuccess] = useState(false); + const [returned, setReturned] = useState(false); + + const phoneIdentifierEnrollment = new PhoneIdentifierEnrollment(); + + const handleContinue = async (e) => { + e.preventDefault(); + setError(''); + setSuccess(false); + setReturned(false); + try { + await phoneIdentifierEnrollment.continuePhoneEnrollment({ type }); + setSuccess(true); + } catch (err) { + setError('Failed to continue phone enrollment. Please try again.'); + } + }; + + const handleReturn = async (e) => { + e.preventDefault(); + setError(''); + setSuccess(false); + setReturned(false); + try { + await phoneIdentifierEnrollment.returnToPrevious(); + setReturned(true); + } catch (err) { + setError('Failed to return to previous step. Please try again.'); + } + }; + + return ( +
+
+

+ Phone Identifier Enrollment +

+
+
+
+
+
+ + +
+ +
+
+ +
+ {error &&
{error}
} + {success &&
Phone enrollment continued successfully!
} + {returned &&
Returned to previous step.
} +
+
+
+ ); +}; + +export default PhoneIdentifierEnrollmentScreen; +``` + + + +## Properties + +string} required> + + +ScreenOptions} required> + + +BrandingMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + + PhoneEnrollmentOptions} required> + + + + +Promise<void>}> + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/phone-identifier-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Prompt.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Prompt.mdx new file mode 100644 index 000000000..208ded864 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Prompt.mdx @@ -0,0 +1,14 @@ +--- +title: "Prompt" +description: "" +--- + +## Properties + +PromptMembers['name']} required> + The name of the prompt (e.g., 'login', 'signup') + + +--- + +**File:** [src/models/prompt.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/prompt.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/RedeemTicket.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/RedeemTicket.mdx new file mode 100644 index 000000000..3d7be46a9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/RedeemTicket.mdx @@ -0,0 +1,147 @@ +--- +title: "RedeemTicket" +description: "Implements the redeem-ticket screen functionality." +--- + + + +```tsx React Component Example with TailwindCSS lines +import React from 'react'; +import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; + +const RedeemTicketScreen: React.FC = () => { + const redeemTicketManager = new RedeemTicket(); + const { screen, transaction } = redeemTicketManager; + const texts = screen?.texts ?? {}; + const prompt = screen?.data?.prompt; + + const getDescription = () => { + switch (prompt) { + case 'email-verification': + return texts.descriptionEmailVerify ?? 'Click Continue to Verify Your Email'; + case 'passwordless-auth': + return texts.descriptionPasswordlessVerify ?? 'Click Continue to Sign In'; + case 'mfa-enrollment': + return texts.description ?? 'Click Continue to Enroll in Multi-Factor Authentication'; + default: + return texts.description ?? 'Click Continue to proceed'; + } + }; + + const handleContinue = async () => { + try { + await redeemTicketManager.continue(); + } catch (error) { + console.error('Failed to continue:', error); + } + }; + + return ( +
+
+

+ {texts.pageTitle ?? 'Redeem Ticket'} +

+

+ {getDescription()} +

+ + {transaction?.errors?.length && ( +
+ {transaction.errors.map((err, index) => ( +

+ {err.message} +

+ ))} +
+ )} + + +
+
+ ); +}; + +export default RedeemTicketScreen; +``` + +```typescript Continue lines +import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; + +const redeemTicket = new RedeemTicket(); + +// Continue with the default action +await redeemTicket.continue(); +``` + + + +## Properties + +string} required> + + +BrandingMembers} required> + + +ScreenMembers} required> + + +TenantMembers} required> + + +PromptMembers} required> + + +OrganizationMembers} required> + + +ClientMembers} required> + + +TransactionMembers} required> + + +UserMembers} required> + + +UntrustedDataMembers} required> + + +UniversalLoginContext | null}> + + +## Methods + +Promise<void>}> + Performs the default action on the redeem-ticket screen, usually continuing the flow. + + + CustomOptions}> + + + + +UniversalLoginContext[K] | undefined}> + Retrieves a specific part of the Universal Login Context. + + + K} required> + + + + +TransactionError[]}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + + + +--- + +**File:** [src/screens/redeem-ticket/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/redeem-ticket/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPassword.mdx new file mode 100644 index 000000000..ca9d31f4f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPassword.mdx @@ -0,0 +1,205 @@ +--- +title: "ResetPassword" +description: "" +--- + + + +```typescript resetPassword lines +import React, { useRef, useState } from "react"; +import { useResetPasswordManager } from './hooks/useResetPasswordManager'; +import { Logo } from "../../components/Logo"; +import { Title } from './components/Title'; +import { ErrorMessages } from './components/ErrorMessages'; +import Button from '../../components/Button'; // Adjust the path if needed + +const ResetPasswordScreen: React.FC = () => { + const { resetPasswordManager, handleResetPassword } = useResetPasswordManager(); + + const newPasswordRef = useRef(null); + const confirmPasswordRef = useRef(null); + const captchaRef = useRef(null); + + const [isValid, setIsValid] = useState(true); + const [errors, setErrors] = useState>([]); + const [isValidConfirmPassword, setIsValidConfirmPassword] = useState(true); + const [confirmPasswordErrors, setConfirmPasswordErrors] = useState>([]); + + const getFormValues = () => ({ + newPassword: newPasswordRef.current?.value || '', + confirmPassword: confirmPasswordRef.current?.value || '', + captcha: captchaRef.current?.value || '', + }); + + const onLoginClick = () => { + const { newPassword, confirmPassword, captcha } = getFormValues(); + + const { isValid, errors } = resetPasswordManager.validatePassword(newPassword); + const { isValid: isValidConfirmPassword, errors: confirmPasswordErrors } = + resetPasswordManager.validatePassword(confirmPassword); + + setIsValid(isValid); + setErrors(errors); + setIsValidConfirmPassword(isValidConfirmPassword); + setConfirmPasswordErrors(confirmPasswordErrors); + + if (!isValid || !isValidConfirmPassword) { + return; + } + + handleResetPassword(newPassword, confirmPassword, captcha); + }; + + return ( +
+ + + + <div className="input-container"> + {/* New Password */} + <label>Enter your new password</label> + <input + type="password" + id="newPassword" + ref={newPasswordRef} + aria-invalid={!isValid} + placeholder="Enter your password" + required + className={`input w-full border px-4 py-2 rounded ${ + !isValid ? 'border-red-500' : 'border-gray-300' + }`} + /> + {!isValid && ( + <ul className="text-red-500 text-sm list-disc list-inside"> + {errors.map((err) => ( + <li key={err.code}>{err.message}</li> + ))} + </ul> + )} + + {/* Confirm Password */} + <label>Confirm your new password</label> + <input + type="password" + id="password" + ref={confirmPasswordRef} + aria-invalid={!isValidConfirmPassword} + placeholder="Re-enter your password" + required + className={`input w-full border px-4 py-2 rounded ${ + !isValidConfirmPassword ? 'border-red-500' : 'border-gray-300' + }`} + /> + {!isValidConfirmPassword && ( + <ul className="text-red-500 text-sm list-disc list-inside"> + {confirmPasswordErrors.map((err) => ( + <li key={err.code}>{err.message}</li> + ))} + </ul> + )} + + {/* Captcha */} + {resetPasswordManager.screen.isCaptchaAvailable && ( + <div className="captcha-container"> + <img src={resetPasswordManager.screen.captchaImage ?? ""} alt="Captcha" /> + <label>Enter the captcha</label> + <input + type="text" + id="captcha" + ref={captchaRef} + placeholder="Enter the captcha" + /> + </div> + )} + + {/* Submit Button */} + <div className="button-container"> + <Button id="continue" onClick={onLoginClick}> + Continue + </Button> + </div> + </div> + + {/* Transaction Errors */} + {resetPasswordManager.transaction.hasErrors && resetPasswordManager.transaction.errors && ( + <ErrorMessages errors={resetPasswordManager.transaction.errors!} /> + )} + </div> + ); +}; + +export default ResetPasswordScreen; +``` + +</RequestExample> + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> +</ParamField> + +<ParamField path="screen" type={<span>ScreenOptions</span>} required> +</ParamField> + +<ParamField path="transaction" type={<span>TransactionOptions</span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="resetPassword" type={<span>Promise<void></span>}> + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordOptions">ResetPasswordOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="validatePassword" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> + @param password + + <Expandable title="parameters"> + <ParamField path="password" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/reset-password/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordEmail.mdx new file mode 100644 index 000000000..6b33529e2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordEmail.mdx @@ -0,0 +1,112 @@ +--- +title: "ResetPasswordEmail" +description: "" +--- + +<RequestExample> + +```typescript typescript lines +import ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email'; + +const resetPasswordEmail = new ResetPasswordEmail(); +resetPasswordEmail.resendEmail(); +``` + +```jsx React Component Example with TailwindCSS lines +import ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email'; + +const ResetPasswordEmailScreen = () => { + const resetPasswordEmail = new ResetPasswordEmail(); + + + return ( + <div className="w-[100vw] min-h-screen bg-gray-100 flex items-center justify-center p-4"> + <div className="w-full max-w-md"> + <h2 className="text-3xl font-bold text-center mb-8"> + Resend Email + </h2> + + <div className="bg-white p-8 rounded-lg shadow"> + <form> + <div className="space-y-3"> + <button + type="button" + onClick={() => resetPasswordEmail?.resendEmail()} + className="w-full py-2 px-4 border text-gray-700 rounded-md hover:bg-gray-50" + > + Resend Email + </button> + </div> + </form> + </div> + </div> + </div> + ); +}; + +export default ResetPasswordEmailScreen; +``` + +</RequestExample> + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> +</ParamField> + +<ParamField path="screen" type={<span>ScreenOptions</span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="resendEmail" type={<span>Promise<void></span>}> + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/reset-password-email/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-email/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordError.mdx new file mode 100644 index 000000000..4dafd4075 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordError.mdx @@ -0,0 +1,98 @@ +--- +title: "ResetPasswordError" +description: "" +--- + +<RequestExample> + +```js js lines +import ResetPasswordError from '@auth0/auth0-acul-js/reset-password-error'; +const resetPasswordError = new ResetPasswordError(); + +const { screen } = resetPasswordError; +const data = screen.texts?.description; +console.log(data); +``` + +```typescript React Component Example with TailwindCSS lines +import React from 'react'; +import ResetPasswordError from '@auth0/auth0-acul-js/reset-password-error'; + +const ResetPasswordErrorComponent: React.FC = () => { + const resetPasswordSuccessManager = new ResetPasswordError(); + const { screen } = resetPasswordErrorManager; + const data = screen.texts?.description; + + return ( + <div className="w-[100vw] flex flex-col items-center justify-center min-h-screen bg-gray-100"> + <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4 flex flex-col"> + <h2 className="text-2xl font-bold mb-6">Reset Password Error Screen</h2> + {data && ( + <div className="mb-4"> + <p>Message: {data}</p> + </div> + )} + </div> + </div> + ); +}; + +export default ResetPasswordErrorComponent; +``` + +</RequestExample> + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> +</ParamField> + +<ParamField path="screen" type={<span>ScreenOptions</span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/reset-password-error/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-error/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaEmailChallenge.mdx new file mode 100644 index 000000000..91c5fafa7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaEmailChallenge.mdx @@ -0,0 +1,262 @@ +--- +title: "ResetPasswordMfaEmailChallenge" +description: "Class implementing the reset-password-mfa-email-challenge screen functionality" +--- + +<RequestExample> + +```tsx React Component Example with TailwindCSS lines +import React, { useState, useMemo } from 'react'; +import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; + +const ResetPasswordMfaEmailChallengeScreen: React.FC = () => { + const [code, setCode] = useState(''); + const [disabled, setDisabled] = useState(false); + const [remainingSeconds, setRemainingSeconds] = useState(0); + + const resetPasswordMfaEmailChallenge = useMemo(() => new ResetPasswordMfaEmailChallenge(), []); + const { screen, transaction } = resetPasswordMfaEmailChallenge; + + function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { + setDisabled(isDisabled); + setRemainingSeconds(remainingSeconds); + } + + function handleTimeout() { + console.log('Resend timeout completed'); + } + + const resendManager = useMemo( + () => + resetPasswordMfaEmailChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout, + }), + [resetPasswordMfaEmailChallenge] + ); + + const { startResend } = resendManager; + + const handleSubmit = async (e: React.FormEvent) => { + e.preventDefault(); + await resetPasswordMfaEmailChallenge.continue({ + code + }); + }; + + const handleResendCode = async () => { + try { + await startResend(); + } catch (error) { + console.error('Failed to resend code:', error); + } + }; + + const handleTryAnotherMethod = async () => { + await resetPasswordMfaEmailChallenge.tryAnotherMethod(); + }; + + return ( + <div className="min-h-screen bg-gray-100 flex flex-col py-12 sm:px-6 lg:px-8"> + <div className="sm:mx-auto sm:w-full sm:max-w-md"> + <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> + { screen?.texts?.title ?? 'Verify Your Identity' } + </h2> + <p className="mt-2 text-center text-sm text-gray-600"> + { (screen?.texts?.description ?? 'We\'ve sent an email with your code to') + screen.data?.email } + </p> + </div> + + <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> + <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> + <form className="space-y-6" onSubmit={handleSubmit}> + <div> + <label htmlFor="code" className="block text-sm font-medium text-gray-700"> + { screen?.texts?.placeholder ?? 'Enter the code' } + </label> + <div className="mt-1"> + <input + id="code" + name="code" + type="text" + required + placeholder={ screen?.texts?.placeholder ?? 'Enter the code' } + value={code} + onChange={(e) => setCode(e.target.value)} + className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> + </div> + {transaction?.errors?.length && ( + <div className="mt-2 mb-4"> + {transaction?.errors.map((err, index) => ( + <p key={index} className="text-red-500"> + {err.message} + </p> + ))} + </div> + )} + </div> + + <div> + <button + type="submit" + className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" + > + Verify Code + </button> + </div> + </form> + + <div className="mt-6"> + <div className="flex justify-between"> + <button + onClick={handleResendCode} + disabled={disabled} + className={`text-sm ${ + disabled + ? "text-gray-400 cursor-not-allowed" + : "text-blue-600 hover:text-blue-500" + }`} + > + {disabled + ? `${screen?.texts?.resendActionText ?? 'Resend Code'} (${remainingSeconds}s)` + : screen?.texts?.resendActionText ?? 'Resend Code' + } + </button> + <button + onClick={handleTryAnotherMethod} + className="text-sm text-blue-600 hover:text-blue-500" + > + { screen?.texts?.pickAuthenticatorText ?? 'Try another method' } + </button> + </div> + </div> + </div> + </div> + </div> + ); +}; + +export default ResetPasswordMfaEmailChallengeScreen; +``` + +```typescript Continue with Code lines +import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; + +const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); + +resetPasswordMfaEmailChallenge.continue({ + code: '123456', + rememberDevice: true, +}); +``` + +```typescript Resend Code lines +import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; + +const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); + +resetPasswordMfaEmailChallenge.resendCode(); +``` + +```typescript Try Another Method lines +import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; + +const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); + +resetPasswordMfaEmailChallenge.tryAnotherMethod(); +``` + +</RequestExample> + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> +</ParamField> + +<ParamField path="screen" type={<span>ScreenOptions</span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="continue" type={<span>Promise<void></span>}> + Continues with the email challenge using the provided code. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="resendCode" type={<span>Promise<void></span>}> + Resends the email code. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions">ResendCodeOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> + Allows the user to try another MFA method. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> + Gets resend functionality with timeout management for this screen + + <Expandable title="parameters"> + <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-email-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaOtpChallenge.mdx new file mode 100644 index 000000000..6330e561d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaOtpChallenge.mdx @@ -0,0 +1,193 @@ +--- +title: "ResetPasswordMfaOtpChallenge" +description: "Class implementing the reset-password-mfa-otp-challenge screen functionality" +--- + +<RequestExample> + +```tsx React Component Example with TailwindCSS lines +import React, { useState } from 'react'; +import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge'; + +const ResetPasswordMfaOtpChallengeScreen: React.FC = () => { + const [code, setCode] = useState(''); + // const [rememberDevice, setRememberDevice] = useState(false); + + const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge(); + const { screen, transaction } = resetPasswordMfaOtpChallenge; + + const handleSubmit = async (e: React.FormEvent) => { + e.preventDefault(); + await resetPasswordMfaOtpChallenge.continue({ + code, + }); + }; + + const handleTryAnotherMethod = async () => { + await resetPasswordMfaOtpChallenge.tryAnotherMethod(); + }; + + return ( + <div className="min-h-screen bg-gray-100 flex flex-col py-12 sm:px-6 lg:px-8"> + <div className="sm:mx-auto sm:w-full sm:max-w-md"> + <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> + { screen?.texts?.title ?? 'Verify Your Identity' } + </h2> + <p className="mt-2 text-center text-sm text-gray-600"> + { screen?.texts?.description ?? 'Check your preferred one-time password authenticator app for the code.' } + </p> + </div> + + <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> + <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> + <form className="space-y-6" onSubmit={handleSubmit}> + <div> + <label htmlFor="code" className="block text-sm font-medium text-gray-700"> + {screen?.texts?.placeholder ?? 'Enter your one-time code'} + </label> + <div className="mt-1"> + <input + id="code" + name="code" + type="text" + placeholder={screen?.texts?.placeholder ?? 'Enter your one-time code'} + required + value={code} + onChange={(e) => setCode(e.target.value)} + className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> + </div> + </div> + + {transaction?.errors?.length && ( + <div className="mt-2 mb-4"> + {transaction?.errors.map((err, index) => ( + <p key={index} className="text-red-500"> + {err.message} + </p> + ))} + </div> + )} + + <div> + <button + type="submit" + className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" + > + Verify Code + </button> + </div> + </form> + + <div className="mt-6"> + <div className="flex justify-center"> + <button + onClick={handleTryAnotherMethod} + className="text-sm text-blue-600 hover:text-blue-500" + > + { screen?.texts?.tryAnotherMethod ?? 'Try another method' } + </button> + </div> + </div> + </div> + </div> + </div> + ); +}; + +export default ResetPasswordMfaOtpChallengeScreen; +``` + +```typescript Continue with Code lines +import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge'; + +const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge(); + +resetPasswordMfaOtpChallenge.continue({ + code: '123456', +}); +``` + +```typescript Try Another Method lines +import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge'; + +const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge(); + +resetPasswordMfaOtpChallenge.tryAnotherMethod(); +``` + +</RequestExample> + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> + Screen identifier for validation and telemetry +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="continue" type={<span>Promise<void></span>}> + Continues with the OTP challenge using the provided code. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> + Allows the user to try another MFA method. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-otp-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPhoneChallenge.mdx new file mode 100644 index 000000000..92e7c476c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPhoneChallenge.mdx @@ -0,0 +1,273 @@ +--- +title: "ResetPasswordMfaPhoneChallenge" +description: "" +--- + +<RequestExample> + +```tsx React Component Example with TailwindCSS lines +import React, { useState } from 'react'; +import ResetPasswordMfaPhoneChallenge, { + type ContinueOptions, + type TryAnotherMethodOptions +} from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; + +const ResetPasswordMfaPhoneChallengeScreen: React.FC = () => { + // Instantiate the SDK class for the screen + const screenManager = new ResetPasswordMfaPhoneChallenge(); + const { screen, transaction } = screenManager; + + // State to manage loading indicators and potential errors + const [isLoading, setIsLoading] = useState<boolean>(false); + const [error, setError] = useState<string | null>(null); + // State to track the user's choice (needed for tryAnotherMethod) + // Default to 'sms' or 'voice' based on initial view, or let user select first + const [currentChallengeType, setCurrentChallengeType] = useState<'sms' | 'voice'>('sms'); // Example default + + /** + * Handles the action when the user chooses SMS or Voice Call. + * @param {'sms' | 'voice'} type - The selected delivery method. + */ + const handleContinue = async (type: ContinueOptions['type']) => { + setIsLoading(true); + setError(null); + setCurrentChallengeType(type); // Update the current type + try { + await screenManager.continue({ type }); + // On success, Auth0 usually handles the redirect to the next step (code entry). + } catch (err: any) { + setError(err.message || 'Failed to send verification code. Please try again.'); + setIsLoading(false); // Only stop loading on error + } + }; + + /** + * Handles the action when the user wants to try a different MFA method. + */ + const handleTryAnotherMethod = async () => { + setIsLoading(true); + setError(null); + try { + // Pass the current challenge type the user was viewing + await screenManager.tryAnotherMethod({ type: currentChallengeType }); + // On success, Auth0 usually handles the redirect to the authenticator selection screen. + } catch (err: any) { + setError(err.message || 'Failed to switch MFA methods. Please try again.'); + setIsLoading(false); // Only stop loading on error + } + }; + + // Extract texts for UI elements, providing default fallbacks + const texts = screen?.texts ?? {}; + const title = texts.title ?? 'Verify Your Identity'; + // Example: Modify description to include phone number securely + const description = texts.description ?? `To continue resetting your password, please verify your identity. How would you like to get the verification code sent to ${screen.data?.phoneNumber ?? 'your phone'}?`; + const smsButtonText = texts.smsButtonText ?? 'Send code via SMS'; + const voiceButtonText = texts.voiceButtonText ?? 'Send code via Voice Call'; + const tryAnotherMethodText = texts.pickAuthenticatorText ?? 'Try Another Method'; // Assuming this text key exists + + return ( + <div className="flex items-center justify-center min-h-screen bg-gray-100 p-4"> + <div className="w-full max-w-md bg-white rounded-lg shadow-md p-8"> + <h1 className="text-2xl font-semibold text-center text-gray-800 mb-4"> + {title} + </h1> + <p className="text-center text-gray-600 mb-6"> + {description} + </p> + + {/* Display errors from the transaction object (e.g., invalid state) */} + {transaction.errors && transaction.errors.length > 0 && ( + <div className="bg-red-100 border border-red-400 text-red-700 px-4 py-3 rounded relative mb-4" role="alert"> + <strong className="font-bold">Error: </strong> + {transaction.errors.map((err, index) => ( + <span key={`tx-error-${index}`} className="block sm:inline">{err.message}</span> + ))} + </div> + )} + + {/* Display errors caught during form submission */} + {error && ( + <div className="bg-red-100 border border-red-400 text-red-700 px-4 py-3 rounded relative mb-4" role="alert"> + <strong className="font-bold">Error: </strong> + <span className="block sm:inline">{error}</span> + </div> + )} + + <div className="space-y-4"> + {/* SMS Button */} + <button + onClick={() => handleContinue('sms')} + disabled={isLoading} + className={`w-full px-4 py-2 text-white bg-blue-600 rounded-md transition duration-150 ease-in-out ${isLoading ? 'opacity-50 cursor-not-allowed' : 'hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-blue-500 focus:ring-opacity-50'}`} + > + {isLoading && currentChallengeType === 'sms' ? 'Sending SMS...' : smsButtonText} + </button> + + {/* Voice Call Button */} + <button + onClick={() => handleContinue('voice')} + disabled={isLoading} + className={`w-full px-4 py-2 text-white bg-green-600 rounded-md transition duration-150 ease-in-out ${isLoading ? 'opacity-50 cursor-not-allowed' : 'hover:bg-green-700 focus:outline-none focus:ring-2 focus:ring-green-500 focus:ring-opacity-50'}`} + > + {isLoading && currentChallengeType === 'voice' ? 'Initiating Call...' : voiceButtonText} + </button> + </div> + + {/* Separator */} + <div className="my-6 border-t border-gray-300"></div> + + {/* Try Another Method Button */} + <button + onClick={handleTryAnotherMethod} + disabled={isLoading} + className={`w-full px-4 py-2 text-gray-700 bg-gray-200 rounded-md transition duration-150 ease-in-out ${isLoading ? 'opacity-50 cursor-not-allowed' : 'hover:bg-gray-300 focus:outline-none focus:ring-2 focus:ring-gray-400 focus:ring-opacity-50'}`} + > + {isLoading ? 'Loading...' : tryAnotherMethodText} + </button> + </div> + </div> + ); +}; + +export default ResetPasswordMfaPhoneChallengeScreen; +``` + +```typescript Initialize the SDK Class lines +import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; + +const screenManager = new ResetPasswordMfaPhoneChallenge(); + +// Access screen data like the phone number +const phoneNumber = screenManager.screen.data?.phoneNumber; +console.log('Phone number for challenge:', phoneNumber); // e.g., "+1******7890" + +// Access transaction details like errors +const errors = screenManager.transaction.errors; +if (errors) { + console.error('Transaction errors:', errors); +} +``` + +```typescript Send Code via SMS lines +import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; + +const screenManager = new ResetPasswordMfaPhoneChallenge(); + +try { + await screenManager.continue({ type: 'sms' }); + // On success, the user will typically be redirected to the code entry screen. +} catch (error) { + console.error('Failed to request SMS code:', error); + // Handle the error, e.g., display a message to the user. +} +``` + +```typescript Send Code via Voice Call lines +import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; + +const screenManager = new ResetPasswordMfaPhoneChallenge(); + +try { + await screenManager.continue({ type: 'voice' }); + // On success, the user will typically be redirected to the code entry screen. +} catch (error) { + console.error('Failed to request voice call:', error); + // Handle the error. +} +``` + +```typescript Try Another MFA Method lines +import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; + +const screenManager = new ResetPasswordMfaPhoneChallenge(); + +// You need to know which option ('sms' or 'voice') was presented or last selected by the user. +// Let's assume 'sms' was the context. +const currentType: 'sms' | 'voice' = 'sms'; + +try { + await screenManager.tryAnotherMethod({ type: currentType }); + // On success, the user will be redirected to the authenticator selection screen. +} catch (error) { + console.error('Failed to switch MFA method:', error); + // Handle the error. +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> + The unique identifier for this screen, used internally and for telemetry. +</ParamField> + +<ParamField path="screen" type={<span>ScreenOptions</span>} required> + Holds the specific screen data and properties, processed by ScreenOverride. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="continue" type={<span>Promise<void></span>}> + Sends the verification code to the user's phone via the selected method (SMS or Voice). Corresponds to the 'Continue' action in the OpenAPI definition (action: 'default'). + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> + Initiates the process for the user to select a different MFA authenticator. Corresponds to the 'Try Another Method' action in the OpenAPI definition (action: 'pick-authenticator'). + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-phone-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPushChallengePush.mdx new file mode 100644 index 000000000..43668c84d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPushChallengePush.mdx @@ -0,0 +1,241 @@ +--- +title: "ResetPasswordMfaPushChallengePush" +description: "Class representing the reset-password-mfa-push-challenge-push screen functionality This screen is shown when a push notification has been sent to the user's device during password reset" +--- + +<RequestExample> + +```tsx React Component Example with TailwindCSS lines +import React from 'react'; +import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; + +const ResetPasswordMfaPushChallengePushScreen: React.FC = () => { + const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); + const { deviceName } = resetPasswordMfaPushChallengePush.screen.data || {}; + const { screen, transaction } = resetPasswordMfaPushChallengePush + + + const handleContinue = async () => { + await resetPasswordMfaPushChallengePush.continue(); + }; + + const handleResend = async () => { + await resetPasswordMfaPushChallengePush.resendPushNotification(); + }; + + const handleEnterCodeManually = async () => { + await resetPasswordMfaPushChallengePush.enterCodeManually(); + }; + + const handleTryAnotherMethod = async () => { + await resetPasswordMfaPushChallengePush.tryAnotherMethod(); + }; + + return ( + <div className="min-h-screen bg-gray-100 flex flex-col py-12 sm:px-6 lg:px-8"> + <div className="sm:mx-auto sm:w-full sm:max-w-md"> + <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> + { screen?.texts?.title ?? 'Verify Your Identity' } + </h2> + <p className="mt-3 text-center text-sm text-gray-600"> + { screen?.texts?.description ?? 'We\'ve sent a notification to the following device via Auth0 Guardian app.' + `Device: ${screen.data?.deviceName}` } + {deviceName && <span className="font-medium"> ({deviceName})</span>} + </p> + </div> + + <div className="mt-6 sm:mx-auto sm:w-full sm:max-w-md"> + <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> + <div className="space-y-4"> + <p className="text-center text-sm text-gray-500"> + Waiting for you to accept the push notification... + </p> + <div className="flex items-center justify-center"> + <div className="animate-spin rounded-full h-12 w-12 border-b-2 border-blue-500" /> + </div> + + <button + onClick={handleContinue} + className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 disabled:opacity-50" + > + { screen?.texts?.continueTextB2C ?? 'I\'ve responded on my device' } + </button> + + <button + onClick={handleResend} + className="w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 disabled:opacity-50" + > + { screen?.texts?.resendActionText ?? 'Resend Code Manually' } + </button> + + <button + onClick={handleEnterCodeManually} + className="w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 disabled:opacity-50" + > + { screen?.texts?.enterOtpCode ?? 'Enter Code Manually' } + </button> + + <button + onClick={handleTryAnotherMethod} + className="w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 disabled:opacity-50" + > + { screen?.texts?.tryAnotherMethod ?? 'Try Another Method' } + </button> + </div> + + {transaction?.errors?.length && ( + <div className="mt-2 mb-4"> + {transaction?.errors.map((err, index) => ( + <p key={index} className="text-red-500"> + {err.message} + </p> + ))} + </div> + )} + </div> + </div> + </div> + ); +}; + +export default ResetPasswordMfaPushChallengePushScreen; +``` + +```typescript Continue (Poll for Push Notification Acceptance) lines +import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; + +const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); + +// Poll for push notification acceptance +const pollInterval = setInterval(async () => { + try { + await resetPasswordMfaPushChallengePush.continue(); + // If successful, the page will redirect + clearInterval(pollInterval); + } catch (error) { + // Ignore polling errors + } +}, 5000); +``` + +```typescript Resend Push Notification lines +import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; + +const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); +resetPasswordMfaPushChallengePush.resendPushNotification(); +``` + +```typescript Enter Code Manually lines +import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; + +const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); +resetPasswordMfaPushChallengePush.enterCodeManually(); +``` + +```typescript Try Another Method lines +import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; + +const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); +resetPasswordMfaPushChallengePush.tryAnotherMethod(); +``` + +</RequestExample> + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> +</ParamField> + +<ParamField path="screen" type={<span>ScreenOptions</span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="continue" type={<span>Promise<void></span>}> + Continues with the push notification challenge + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="resendPushNotification" type={<span>Promise<void></span>}> + Re-sends the push notification + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="enterCodeManually" type={<span>Promise<void></span>}> + Switches to entering the verification code manually + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> + Allows trying another authentication method + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="pollingManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> + Starts and manages polling for an MFA push challenge. Creates a polling session that repeatedly checks the MFA push challenge endpoint at the specified interval until the challenge is approved or an error occurs. When the approval condition is met, the provided callback is invoked and polling stops automatically. Use the returned to start, stop, or check the status of the polling process at any time. + + <Expandable title="parameters"> + <ParamField path="options" type={<span>MfaPollingOptions</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-push-challenge-push/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx new file mode 100644 index 000000000..08c88b2a9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx @@ -0,0 +1,177 @@ +--- +title: "ResetPasswordMfaRecoveryCodeChallenge" +description: "Class implementing the Reset Password MFA Recovery Code Challenge screen functionality." +--- + +<RequestExample> + +```tsx React Component Example with TailwindCSS lines +import React, { useState } from 'react'; +import ResetPasswordMfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/reset-password-mfa-recovery-code-challenge'; + +const ResetPasswordMfaRecoveryCodeChallengeScreen: React.FC = () => { + const [code, setCode] = useState(''); + const resetPasswordMfaRecoveryCodeChallengeManager = new ResetPasswordMfaRecoveryCodeChallenge(); + const { screen, transaction: { errors } } = resetPasswordMfaRecoveryCodeChallengeManager; + const texts = screen.texts ?? {}; + + const handleSubmit = async () => { + try { + await resetPasswordMfaRecoveryCodeChallengeManager.continue(code); + } catch (error) { + console.error('Failed to submit recovery code:', error); + } + }; + + const handleTryAnotherMethod = async () => { + try { + await resetPasswordMfaRecoveryCodeChallengeManager.tryAnotherMethod(); + } catch (error) { + console.error('Failed to try another method:', error); + } + }; + + return ( + <div className="flex flex-col items-center min-h-screen bg-gray-100 p-4"> + <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 w-full max-w-md"> + <h2 className="text-2xl font-bold mb-4 text-center"> + {texts.title ?? 'Enter Recovery Code'} + </h2> + <p className="text-sm text-gray-700 mb-4 text-center"> + {texts.description ?? 'Please enter the recovery code from your authenticator app.'} + </p> + + <input + className="shadow appearance-none border rounded w-full py-2 px-3 text-gray-700 leading-tight focus:outline-none focus:shadow-outline mb-3" + id="code" + type="text" + placeholder={texts.placeholder ?? 'Enter your recovery code'} + value={code} + onChange={(e) => setCode(e.target.value)} + /> + + {errors?.length && ( + <div className="mb-4 space-y-1"> + {errors.map((err, index) => ( + <p key={index} className="text-red-600 text-sm"> + {err.message} + </p> + ))} + </div> + )} + + <button + className="w-full bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline mb-4" + type="button" + onClick={handleSubmit} + > + {texts.buttonText ?? 'Continue'} + </button> + + <button + className="text-blue-600 hover:underline text-sm text-center w-full" + type="button" + onClick={handleTryAnotherMethod} + > + {texts.pickAuthenticatorText ?? 'Try another method'} + </button> + </div> + </div> + ); +}; + +export default ResetPasswordMfaRecoveryCodeChallengeScreen; +``` + +```typescript Continue with Code lines +import ResetPasswordMfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/reset-password-mfa-recovery-code-challenge'; + +const resetPasswordMfaRecoveryCodeChallenge = new ResetPasswordMfaRecoveryCodeChallenge(); + +resetPasswordMfaRecoveryCodeChallenge.continue('PJVLZM6MS8DP6JYRT97XYZM2'); +``` + +```typescript Try Another Method lines +import ResetPasswordMfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/reset-password-mfa-recovery-code-challenge'; + +const resetPasswordMfaRecoveryCodeChallenge = new ResetPasswordMfaRecoveryCodeChallenge(); + +resetPasswordMfaRecoveryCodeChallenge.tryAnotherMethod(); +``` + +</RequestExample> + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="continue" type={<span>Promise<void></span>}> + Continues with the provided recovery code. + + <Expandable title="parameters"> + <ParamField path="code" type={<span>string</span>} required> + </ParamField> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> + Navigates to the screen where the user can pick another MFA method. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-recovery-code-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaSmsChallenge.mdx new file mode 100644 index 000000000..41fd423a2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaSmsChallenge.mdx @@ -0,0 +1,259 @@ +--- +title: "ResetPasswordMfaSmsChallenge" +description: "This class provides methods to handle the reset-password-mfa-sms-challenge screen." +--- + +<RequestExample> + +```jsx React Component Example with TailwindCSS lines +import { useState, useMemo } from 'react'; +import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; + +const ResetPasswordMfaSmsChallengeScreen = () => { + const resetPasswordMfaSmsChallenge = useMemo(() => new ResetPasswordMfaSmsChallenge(), []); + const [code, setCode] = useState(''); + const [disabled, setDisabled] = useState(false); + const [remainingSeconds, setRemainingSeconds] = useState(0); + + const { screen, transaction } = resetPasswordMfaSmsChallenge; + + function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { + setDisabled(isDisabled); + setRemainingSeconds(remainingSeconds); + } + + function handleTimeout() { + console.log('Resend timeout completed'); + } + + const resendManager = useMemo( + () => + resetPasswordMfaSmsChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout, + }), + [resetPasswordMfaSmsChallenge] + ); + + const { startResend } = resendManager; + + const handleSubmit = async (e: React.FormEvent) => { + e.preventDefault(); + await resetPasswordMfaSmsChallenge.continueMfaSmsChallenge({ + code, + }); + }; + + const handleResendCode = async () => { + try { + await startResend(); + } catch (error) { + console.error('Failed to resend code:', error); + } + }; + + const handleTryAnotherMethod = async () => { + await resetPasswordMfaSmsChallenge.tryAnotherMethod(); + }; + + const handleGetACall = async () => { + try { + await resetPasswordMfaSmsChallenge.getACall(); + } catch (error) { + console.error('Get a call failed:', error); + } + }; + + return ( + <div className="min-h-screen bg-gray-100 flex flex-col py-12 sm:px-6 lg:px-8"> + <div className="sm:mx-auto sm:w-full sm:max-w-md"> + <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> + { screen?.texts?.title ?? 'Verify Your Identity' } + </h2> + <p className="mt-4"> + { screen?.texts?.description ?? 'Enter the code sent to your phone number' + screen.data?.phoneNumber } + </p> + </div> + + <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> + <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> + <form className="space-y-6" onSubmit={handleSubmit}> + <div> + <label htmlFor="code" className="block text-sm font-medium text-gray-700"> + { screen?.texts?.placeholder ?? 'Enter the 6-digit code' } + </label> + <div className="mt-1"> + <input + id="code" + name="code" + type="text" + placeholder={ screen?.texts?.placeholder ?? 'Enter the 6-digit code' } + required + value={code} + onChange={(e) => setCode(e.target.value)} + className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> + </div> + </div> + + <div> + <button + type="submit" + className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" + > + { screen?.texts?.buttonText ?? 'Continue' } + </button> + </div> + + {transaction?.errors?.length && ( + <div className="mt-2 mb-4"> + {transaction?.errors.map((err, index) => ( + <p key={index} className="text-red-500"> + {err.message} + </p> + ))} + </div> + )} + </form> + + <div className="mt-6"> + <button + onClick={handleResendCode} + disabled={disabled} + className={`w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium mt-2 ${ + disabled + ? "text-gray-400 bg-gray-100 cursor-not-allowed" + : "text-gray-700 bg-white hover:bg-gray-50" + }`} + > + {disabled + ? `${screen?.texts?.resendActionText ?? 'Resend Code'} (${remainingSeconds}s)` + : screen?.texts?.resendActionText ?? 'Resend Code' + } + </button> + <button + onClick={handleTryAnotherMethod} + className="w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 mt-2" + > + { screen?.texts?.pickAuthenticatorText ?? 'Try Another Method' } + </button> + { screen.data?.showLinkVoice && ( + <button + onClick={handleGetACall} + className="w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 mt-2" + > + { screen?.texts?.resendVoiceActionText ?? 'Get a Call' } + </button> + )} + </div> + </div> + </div> + </div> + ); +}; + +export default ResetPasswordMfaSmsChallengeScreen; +``` + +</RequestExample> + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> +</ParamField> + +<ParamField path="screen" type={<span>ScreenOptions</span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="continueMfaSmsChallenge" type={<span>Promise<void></span>}> + Submits the MFA SMS challenge with the provided code. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions">MfaSmsChallengeOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="resendCode" type={<span>Promise<void></span>}> + Submits the action to resend the SMS code. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> + Submits the action to try another MFA method. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getACall" type={<span>Promise<void></span>}> + Submits the action to switch to voice call verification. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> + Gets resend functionality with timeout management for this screen + + <Expandable title="parameters"> + <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-sms-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaVoiceChallenge.mdx new file mode 100644 index 000000000..6b6d4e286 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaVoiceChallenge.mdx @@ -0,0 +1,301 @@ +--- +title: "ResetPasswordMfaVoiceChallenge" +description: "Class implementing the reset-password-mfa-voice-challenge screen functionality." +--- + +<RequestExample> + +```tsx React Component Example with TailwindCSS lines +import React, { useState, useMemo } from 'react'; +import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge'; + +const ResetPasswordMfaVoiceChallengeScreen: React.FC = () => { + const [code, setCode] = useState(''); + const [showLinkSms, setShowLinkSms] = useState(false); + const [disabled, setDisabled] = useState(false); + const [remainingSeconds, setRemainingSeconds] = useState(0); + + const resetPasswordMfaVoiceChallenge = useMemo(() => new ResetPasswordMfaVoiceChallenge(), []); + + const { screen, transaction } = resetPasswordMfaVoiceChallenge; + const texts = screen?.texts ?? {}; + + function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { + setDisabled(isDisabled); + setRemainingSeconds(remainingSeconds); + } + + function handleTimeout() { + console.log('Resend timeout completed'); + } + + const resendManager = useMemo( + () => + resetPasswordMfaVoiceChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout, + }), + [resetPasswordMfaVoiceChallenge] + ); + + const { startResend } = resendManager; + + // Initialize state from screen data + React.useEffect(() => { + if (screen?.data?.showLinkSms !== undefined) { + setShowLinkSms(screen.data.showLinkSms); + } + }, [screen?.data]); + + const handleSubmit = async (e: React.FormEvent) => { + e.preventDefault(); + try { + await resetPasswordMfaVoiceChallenge.continue({ code }); + } catch (error) { + console.error('Submit error:', error); + } + }; + + const handleSwitchToSms = async () => { + try { + await resetPasswordMfaVoiceChallenge.switchToSms(); + } catch (error) { + console.error('Switch to SMS failed:', error); + } + }; + + const handleResendCode = async () => { + try { + await startResend(); + } catch (error) { + console.error('Failed to resend code:', error); + } + }; + + const handleTryAnotherMethod = async () => { + try { + await resetPasswordMfaVoiceChallenge.tryAnotherMethod(); + } catch (error) { + console.error('Try another method failed:', error); + } + }; + + return ( + <div className="min-h-screen bg-gray-100 flex flex-col items-center p-4"> + <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 w-full max-w-md"> + <h2 className="text-2xl font-bold mb-4 text-center"> + {texts.title ?? 'Verify Your Identity'} + </h2> + <p className="text-sm text-gray-700 mb-4 text-center"> + {texts.description ?? `Enter the code sent to your phone number ending in ${screen?.data?.phoneNumber}`} + </p> + + <form onSubmit={handleSubmit}> + <input + id="code" + name="code" + type="text" + required + placeholder={texts.placeholder ?? 'Enter your code'} + value={code} + onChange={(e) => setCode(e.target.value)} + className="mb-3 shadow appearance-none border rounded w-full py-2 px-3 text-gray-700 leading-tight focus:outline-none focus:shadow-outline" + /> + + {transaction?.errors?.length && ( + <div className="mb-4 space-y-1"> + {transaction.errors.map((err, index) => ( + <p key={index} className="text-red-600 text-sm"> + {err.message} + </p> + ))} + </div> + )} + + <button + type="submit" + className="w-full bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline mb-4" + > + {texts.buttonText ?? 'Verify Code'} + </button> + </form> + + <div className="flex flex-col space-y-2 text-sm text-center"> + <button + onClick={handleResendCode} + disabled={disabled} + className={`${ + disabled + ? "text-gray-400 cursor-not-allowed" + : "text-blue-600 hover:underline" + }`} + type="button" + > + {disabled + ? `${texts.resendActionText ?? 'Call Again'} (${remainingSeconds}s)` + : texts.resendActionText ?? 'Call Again' + } + </button> + + {showLinkSms && ( + <button + onClick={handleSwitchToSms} + className="text-blue-600 hover:underline" + type="button" + > + {texts.resendSmsActionText ?? 'Send a text'} + </button> + )} + + <button + onClick={handleTryAnotherMethod} + className="text-blue-600 hover:underline" + type="button" + > + {texts.pickAuthenticatorText ?? 'Try another method'} + </button> + </div> + </div> + </div> + ); +}; + +export default ResetPasswordMfaVoiceChallengeScreen; +``` + +```typescript Continue with Code lines +import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge'; + +const resetPasswordMfaVoiceChallenge = new ResetPasswordMfaVoiceChallenge(); + +resetPasswordMfaVoiceChallenge.continue({ + code: '123456', +}); +``` + +```typescript Switch to SMS lines +import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge'; + +const resetPasswordMfaVoiceChallenge = new ResetPasswordMfaVoiceChallenge(); + +resetPasswordMfaVoiceChallenge.switchToSms(); +``` + +```typescript Resend Code lines +import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge'; + +const resetPasswordMfaVoiceChallenge = new ResetPasswordMfaVoiceChallenge(); + +resetPasswordMfaVoiceChallenge.resendCode(); +``` + +```typescript Try Another Method lines +import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge'; + +const resetPasswordMfaVoiceChallenge = new ResetPasswordMfaVoiceChallenge(); + +resetPasswordMfaVoiceChallenge.tryAnotherMethod(); +``` + +</RequestExample> + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> +</ParamField> + +<ParamField path="screen" type={<span>ScreenOptions</span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="continue" type={<span>Promise<void></span>}> + Continues with the voice challenge using the provided code. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="switchToSms" type={<span>Promise<void></span>}> + Switches to SMS verification. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="resendCode" type={<span>Promise<void></span>}> + Resends the code via voice call. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> + Allows the user to try another MFA method. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> + Gets resend functionality with timeout management for this screen + + <Expandable title="parameters"> + <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-voice-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx new file mode 100644 index 000000000..4f40f9894 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,88 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallenge" +description: "" +--- + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> + static +</ParamField> + +<ParamField path="screen" type={<span>ScreenOptions</span>} required> + Holds the specific screen data and properties for this screen, processed by `ScreenOverride`. This includes `publicKey` (for the WebAuthn challenge) and `showRememberDevice`. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="continueWithPasskey" type={<span>Promise<void></span>}> + Initiates the WebAuthn platform authenticator challenge by calling `navigator.credentials.get()` using the challenge options provided in `screen.publicKey`. If successful, it submits the resulting credential assertion to Auth0 with `action: "default"`. + + <Expandable title="parameters"> + <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithPasskeyOptions">ContinueWithPasskeyOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="reportBrowserError" type={<span>Promise<void></span>}> + Reports a browser-side error that occurred during the `navigator.credentials.get()` API call. This is used to inform Auth0 about issues like user cancellation (`NotAllowedError`), timeout, or other WebAuthn API specific errors. It submits the error details with `action: "showError::"`. + + <Expandable title="parameters"> + <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions">ReportBrowserErrorOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> + Allows the user to opt-out of the WebAuthn platform authenticator challenge and select a different MFA method for verifying their identity during password reset. This action submits `action: "pick-authenticator"` to Auth0, which should navigate the user to an MFA factor selection screen. + + <Expandable title="parameters"> + <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx new file mode 100644 index 000000000..8cde2492c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,88 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallenge" +description: "" +--- + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> + The unique identifier for this screen, used for internal SDK logic and telemetry. +</ParamField> + +<ParamField path="screen" type={<span>ScreenOptions</span>} required> + Holds the specific screen data and properties for this screen, (for the WebAuthn challenge) and `showRememberDevice`. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="useSecurityKey" type={<span>Promise<void></span>}> + Initiates the WebAuthn security key challenge. This method internally calls `navigator.credentials.get()` using the challenge options provided in `this.screen.publicKey`. If the user successfully authenticates with their security key, the resulting `PublicKeyCredential` is stringified and submitted to Auth0 with `action: "default"`. + + <Expandable title="parameters"> + <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UseSecurityKeyOptions">UseSecurityKeyOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="showError" type={<span>Promise<void></span>}> + Reports a client-side WebAuthn API error (from `navigator.credentials.get()`) to Auth0. This method is intended to be called when (or a direct call to `navigator.credentials.get()`) fails due to a standard WebAuthn API error (e.g., `NotAllowedError` if the user cancels, `NotFoundError`, `SecurityError`, timeout). It submits the error details with `action: "showError::"` and an empty `response`. + + <Expandable title="parameters"> + <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions">ShowErrorOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> + Allows the user to opt-out of the WebAuthn roaming authenticator challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate the user to an MFA factor selection screen. + + <Expandable title="parameters"> + <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordRequest.mdx new file mode 100644 index 000000000..1ae7bff09 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordRequest.mdx @@ -0,0 +1,144 @@ +--- +title: "ResetPasswordRequest" +description: "" +--- + +<RequestExample> + +```jsx React Component Example with TailwindCSS lines +import React, { useState } from 'react'; +import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request'; + +const ResetPasswordRequestScreen = () => { + const [username, setUsername] = useState(''); + const resetPasswordRequest = new ResetPasswordRequest(); + + const handleSubmit = async (e: React.FormEvent) => { + e.preventDefault(); + await resetPasswordRequest.resetPassword({ username }); + }; + + return ( + <div className="w-[100vw] min-h-screen bg-gray-100 flex items-center justify-center p-4"> + <div className="w-full max-w-md"> + <h2 className="text-3xl font-bold text-center mb-8"> + Reset your password + </h2> + + <div className="bg-white p-8 rounded-lg shadow"> + <form onSubmit={handleSubmit} className="space-y-6"> + <div> + <label htmlFor="username" className="text-sm font-medium text-gray-700"> + Username + </label> + <input + id="username" + type="text" + required + value={username} + onChange={(e) => setUsername(e.target.value)} + className="mt-1 w-full p-2 border rounded-md focus:ring-2 focus:ring-blue-500" + placeholder="Enter your username" + /> + </div> + <div className="space-y-3"> + <button + type="submit" + className="w-full py-2 px-4 bg-blue-600 text-gray-700 rounded-md hover:bg-blue-700" + > + Continue + </button> + + <button + type="button" + onClick={() => resetPasswordRequest?.backToLogin()} + className="w-full py-2 px-4 border text-gray-700 rounded-md hover:bg-gray-50" + > + Back to Login + </button> + </div> + </form> + </div> + </div> + </div> + ); +}; + +export default ResetPasswordRequestScreen; +``` + +</RequestExample> + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> +</ParamField> + +<ParamField path="screen" type={<span>ScreenOptions</span>} required> +</ParamField> + +<ParamField path="transaction" type={<span>TransactionOptions</span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="resetPassword" type={<span>Promise<void></span>}> + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions">ResetPasswordRequestOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="backToLogin" type={<span>Promise<void></span>}> + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getLoginIdentifiers" type={<span>IdentifierType[] | null</span>}> + Gets the active identifier types for the reset-password-request screen + +</ParamField> + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/reset-password-request/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-request/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordSuccess.mdx new file mode 100644 index 000000000..03d310d67 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordSuccess.mdx @@ -0,0 +1,89 @@ +--- +title: "ResetPasswordSuccess" +description: "" +--- + +<RequestExample> + +```typescript React Component Example with TailwindCSS lines +import React from 'react'; +import ResetPasswordSuccess from '@auth0/auth0-acul-js/reset-password-success'; + +const ResetPasswordSuccessComponent: React.FC = () => { + const resetPasswordSuccessManager = new ResetPasswordSuccess(); + const { screen } = resetPasswordSuccessManager; + const data = screen.texts?.description; + + return ( + <div className="w-[100vw] flex flex-col items-center justify-center min-h-screen bg-gray-100"> + <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4 flex flex-col"> + <h2 className="text-2xl font-bold mb-6">Reset Password Success Screen</h2> + {data && ( + <div className="mb-4"> + <p>Message: {data}</p> + </div> + )} + </div> + </div> + ); +}; + +export default ResetPasswordSuccessComponent; +``` + +</RequestExample> + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/reset-password-success/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-success/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SDKUsageError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SDKUsageError.mdx new file mode 100644 index 000000000..733c36707 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SDKUsageError.mdx @@ -0,0 +1,16 @@ +--- +title: "SDKUsageError" +description: "" +--- + +## Properties + +<ParamField path="code" type={<span>any</span>} required> +</ParamField> + +<ParamField path="field" type={<span>string</span>}> +</ParamField> + +--- + +**File:** [src/utils/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Screen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Screen.mdx new file mode 100644 index 000000000..5263d92ba --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Screen.mdx @@ -0,0 +1,66 @@ +--- +title: "Screen" +description: "" +--- + +## Properties + +<ParamField path="name" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['name']</span>} required> + The name of the current screen +</ParamField> + +<ParamField path="captchaImage" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captchaImage']</span>} required> + URL to the captcha image if available +</ParamField> + +<ParamField path="captchaSiteKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captchaSiteKey']</span>} required> + The site key for captcha integration +</ParamField> + +<ParamField path="captchaProvider" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captchaProvider']</span>} required> + The provider of the captcha service +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['isCaptchaAvailable']</span>} required> + Indicates if captcha is available on this screen +</ParamField> + +<ParamField path="data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['data']</span>} required> + Screen-specific data for rendering or logic +</ParamField> + +<ParamField path="links" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['links']</span>} required> + Navigation links available on this screen +</ParamField> + +<ParamField path="texts" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['texts']</span>} required> + Text content for UI elements +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captcha']</span>} required> + Complete captcha configuration +</ParamField> + +## Methods + +<ParamField path="getScreenData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['data']</span>}> + @static + + <Expandable title="parameters"> + <ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getScreenLinks" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['links']</span>}> + @static + + <Expandable title="parameters"> + <ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [src/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride.mdx new file mode 100644 index 000000000..5ebda389c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride.mdx @@ -0,0 +1,65 @@ +--- +title: "ScreenOverride" +description: "" +--- + +## Properties + +<ParamField path="loginLink" type={<span>OverrideOptions['loginLink']</span>} required> +</ParamField> + +<ParamField path="editLink" type={<span>OverrideOptions['editLink']</span>} required> +</ParamField> + +<ParamField path="data" type={<span>OverrideOptions['data']</span>} required> +</ParamField> + +<ParamField path="getScreenData" type={<span>any</span>} required> +</ParamField> + +<ParamField path="name" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['name']</span>} required> + The name of the current screen +</ParamField> + +<ParamField path="captchaImage" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captchaImage']</span>} required> + URL to the captcha image if available +</ParamField> + +<ParamField path="captchaSiteKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captchaSiteKey']</span>} required> + The site key for captcha integration +</ParamField> + +<ParamField path="captchaProvider" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captchaProvider']</span>} required> + The provider of the captcha service +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['isCaptchaAvailable']</span>} required> + Indicates if captcha is available on this screen +</ParamField> + +<ParamField path="links" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['links']</span>} required> + Navigation links available on this screen +</ParamField> + +<ParamField path="texts" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['texts']</span>} required> + Text content for UI elements +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captcha']</span>} required> + Complete captcha configuration +</ParamField> + +## Methods + +<ParamField path="getScreenLinks" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['links']</span>}> + @static + + <Expandable title="parameters"> + <ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [src/screens/signup-password/screen-override.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/signup-password/screen-override.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Signup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Signup.mdx new file mode 100644 index 000000000..294d4120b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Signup.mdx @@ -0,0 +1,317 @@ +--- +title: "Signup" +description: "" +--- + +<RequestExample> + +```tsx React Component Example with TailwindCSS lines +import React, { useState, useRef } from 'react'; +import LoginInstance from "@auth0/auth0-acul-js/signup"; +import { withWindowDebug } from "../../../utils"; +import { Logo } from '../../components/Logo'; +import { Title } from './components/Title'; +import { FederatedLogin } from './components/FederatedLogin'; +import { Links } from './components/Links'; +import { ErrorMessages } from './components/ErrorMessages'; +import Button from '../../components/Button'; + +const SignupScreen: React.FC = () => { + const [password, setPassword] = useState(''); + const [username, setUsername] = useState(''); + const [phone, setPhone] = useState(''); + const [ email, setEmail] = useState(''); + const [captcha, setCaptcha] = useState(''); + + // Initialize signupManager once + const [signupManager] = useState(() => new LoginInstance()); + + const identifiers = signupManager.getEnabledIdentifiers(); + + const {isValid, results} = signupManager.validatePassword(password); + + // Signup button click handler + const onSignupClick = () => { + if (!isValid) return; + + const options = { + username, + email, + phoneNumber, + password, + captcha: signupManager.screen.isCaptchaAvailable ? captcha : "", + }; + signupManager.signup(options); + }; + + // Social login handler + const handleSocialSignup = (connectionName: string) => { + signupManager.federatedSignup({ connection: connectionName }); + }; + + // JSX UI part (same as before) + return ( + <div className="prompt-container"> + <Logo /> + <Title screenTexts={signupManager.screen.texts!} /> + + <div className="input-container"> + {/* Country code button */} + <button className="pick-country-code hidden" id="pick-country-code"> + Pick country code - {signupManager.transaction.countryCode}: +{signupManager.transaction.countryPrefix} + </button> + + {/* Email input */} + {identifiers?.find((id) => id.type === 'email') && ( + <> + <label htmlFor="email"> + Enter your email{' '} + {identifiers.find((id) => id.type === 'email')?.required ? ( + <span className="text-red-500">*</span> + ) : ( + <span className="text-gray-500 text-sm">(optional)</span> + )} + </label> + <input + type="email" + id="email" + value={email} + onChange = {(e) => setEmail(e.target.value)} + placeholder="Enter your email" + required={identifiers.find((id) => id.type === 'email')?.required} + /> + </> + )} + + {/* Username input */} + {identifiers?.find((id) => id.type === 'username') && ( + <> + <label htmlFor="username"> + Enter your username{' '} + {identifiers.find((id) => id.type === 'username')?.required ? ( + <span className="text-red-500">*</span> + ) : ( + <span className="text-gray-500 text-sm">(optional)</span> + )} + </label> + <input + type="text" + id="username" + value={username} + onChange = {(e) => setUsername(e.target.value)} + placeholder="Enter your username" + required={identifiers.find((id) => id.type === 'username')?.required} + /> + </> + )} + + {/* Phone input */} + {identifiers?.find((id) => id.type === 'phone') && ( + <> + <label htmlFor="phoneNumber"> + Enter your phone number{' '} + {identifiers.find((id) => id.type === 'phone')?.required ? ( + <span className="text-red-500">*</span> + ) : ( + <span className="text-gray-500 text-sm">(optional)</span> + )} + </label> + <input + type="tel" + id="phoneNumber" + value={phone} + onChange = {(e) => setPhone(e.target.value)} + placeholder="Enter your phone number" + required={identifiers.find((id) => id.type === 'phone')?.required} + /> + </> + )} + + {/* Password input */} + <label htmlFor="password"> + Enter your password <span className="text-red-500">*</span> + </label> + <input + type="password" + id="password" + value={password} + placeholder="Enter your password" + aria-invalid={!isValid} + required + className={`input w-full border px-4 py-2 rounded ${ + !isValid ? 'border-red-500' : 'border-gray-300' + }`} + onChange={(e) => setPassword(e.target.value)} + /> + + {/* Password validation hints */} + {password.length > 0 && results.length > 0 && ( + <div className="mt-2 border border-gray-300 rounded p-2 text-sm"> + <p className="text-gray-700 mb-1">Your password must contain:</p> + <ul className="list-disc ml-4"> + {results.map((rule) => ( + <li + key={rule.code} + className={rule.status === 'valid' ? 'text-green-600' : 'text-gray-700'} + > + {rule.label} + {rule.items && rule.items.length > 0 && ( + <ul className="ml-5 list-disc"> + {rule.items.map((sub) => ( + <li + key={sub.code} + className={sub.status === 'valid' ? 'text-green-600' : 'text-gray-700'} + > + {sub.label} + </li> + ))} + </ul> + )} + </li> + ))} + </ul> + </div> + )} + + {/* Captcha input */} + {signupManager.screen.isCaptchaAvailable && ( + <div className="captcha-container"> + <img src={signupManager.screen.captchaImage ?? ''} alt="Captcha" /> + <label htmlFor="captcha">Enter the captcha</label> + <input + type="text" + id="captcha" + ref={captchaRef} + placeholder="Enter the captcha" + /> + </div> + )} + + {/* Signup button */} + <div className="button-container mt-4"> + <Button onClick={onSignupClick}>Continue</Button> + </div> + </div> + + {/* Social login buttons */} + <FederatedLogin + connections={signupManager.transaction.alternateConnections!} + onFederatedLogin={handleSocialSignup} + /> + + {/* Links */} + {signupManager.screen.links && ( + <Links loginLink={signupManager.screen.links.loginLink!} /> + )} + + {/* Error messages */} + {signupManager.transaction.hasErrors && signupManager.transaction.errors && ( + <ErrorMessages errors={signupManager.transaction.errors!} /> + )} + </div> + ); +}; + +export default SignupScreen; +``` + +</RequestExample> + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> +</ParamField> + +<ParamField path="screen" type={<span>ScreenOptions</span>} required> +</ParamField> + +<ParamField path="transaction" type={<span>TransactionOptions</span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="signup" type={<span>Promise<void></span>}> + This method handles the submission of the signup form. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions">SignupOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="federatedSignup" type={<span>Promise<void></span>}> + This method is similar to the method but is used for social signups. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions">FederatedSignupOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="pickCountryCode" type={<span>Promise<void></span>}> +</ParamField> + +<ParamField path="validatePassword" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> + @param password + + <Expandable title="parameters"> + <ParamField path="password" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getSignupIdentifiers" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier">Identifier[]</a> | null</span>}> + Returns the list of enabled identifiers for the signup form, marking each as required or optional based on transaction config. + +</ParamField> + +<ParamField path="validateUsername" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}> + Validates a given username against the current username policy defined in the transaction context. + + <Expandable title="parameters"> + <ParamField path="username" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/signup/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/signup/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupId.mdx new file mode 100644 index 000000000..bdb7903b3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupId.mdx @@ -0,0 +1,333 @@ +--- +title: "SignupId" +description: "" +--- + +<RequestExample> + +```typescript signup lines +import SignupId from "@auth0/auth0-acul-js/signup-id"; + const signupIdManager = new SignupId(); + + //get mandatory & optional identifiers required for signup + const { transaction } = signupIdManager; + const mandatoryIdentifier = transaction.getRequiredIdentifiers(); // eg: email + const optionalIdentifiers = transaction.getOptionalIdentifiers() // eg: phone + + /* Based on mandatory & optional identifiers users can render corresponding field on signup-id screen */ + + const signupParams = { + email : "testEmail", + phone : "+91923456789" + } + + signupIdManager.signup(signupParams); +``` + +```typescript socialSignup lines +import SignupId from "@auth0/auth0-acul-js/signup-id"; + + const signupIdManager = new SignupId(); + const { transaction } = signupIdManager; + + //get social connections + const socialConnection = transaction.alternateConnections; //eg: "google-oauth2" + const signupParams = { + connection : socialConnection[0].name, // "google-oauth2" + }; + + signupIdManager.federatedSignup(signupParams); +``` + +```typescript signupId Example lines +import React, { useState, useEffect } from 'react'; +import SignupId from '@auth0/auth0-acul-js/signup-id'; +import { Logo } from '../../components/Logo'; +import Button from '../../components/Button'; + +const SignupIdScreen: React.FC = () => { + const [email, setEmail] = useState(''); + const [phone, setPhone] = useState(''); + const [username, setUsername] = useState(''); + const [error, setError] = useState(''); + const [success, setSuccess] = useState(false); + const [identifiers, setIdentifiers] = useState<Array<{ type: string; required: boolean }>>([]); + + const signupIdManager = new SignupId(); + + const title = signupIdManager.screen.texts?.title || ''; + const description = signupIdManager.screen.texts?.description || ''; + const federatedConnections = signupIdManager.transaction.alternateConnections ?? []; + const links = signupIdManager.screen.links ?? {}; + + const { isValid, errors } = signupIdManager.validateUsername(username); + + + useEffect(() => { + const enabledIds = signupIdManager.getSignupIdentifiers(); + setIdentifiers(enabledIds ?? []); + }, []); + + const handleSignup = async (e: React.FormEvent) => { + e.preventDefault(); + setError(''); + setSuccess(false); + + const emailRequired = identifiers.find((id) => id.type === 'email')?.required; + const phoneRequired = identifiers.find((id) => id.type === 'phone')?.required; + const usernameRequired = identifiers.find((id) => id.type === 'username')?.required; + + if (emailRequired && !email) { + setError('Email is required.'); + return; + } + if (phoneRequired && !phone) { + setError('Phone number is required.'); + return; + } + if (usernameRequired && !username) { + setError('Username is required.'); + return; + } + + if(!isValid){ + setError(errors[0].message); + return; + } + + try { + await signupIdManager.signup({ + email, + phone, + username, + }); + setSuccess(true); + } catch { + setError('Signup failed. Please try again later.'); + } + }; + + const handleFederatedSignup = (connectionName: string) => { + signupIdManager.federatedSignup({ connection: connectionName }); + }; + + return ( + <div className="prompt-container"> + <Logo /> + {/* Title Section */} + <div className="title-container"> + <h1 className="mt-6 text-center text-3xl font-extrabold text-gray-900">{title}</h1> + <div> + <p className="mt-2 text-center text-sm text-gray-600">{description}</p> + </div> + </div> + + {/* Form Section */} + <div className="input-container"> + <form onSubmit={handleSignup}> + {/* Email */} + {identifiers.find((id) => id.type === 'email') && ( + <div> + <label>Email {identifiers.find((id) => id.type === 'email')?.required && '*'}</label> + <input + type="email" + id="email" + placeholder="Enter your email" + value={email} + onChange={(e) => setEmail(e.target.value)} + className="input-field" + /> + </div> + )} + + {/* Phone */} + {identifiers.find((id) => id.type === 'phone') && ( + <div> + <label>Phone {identifiers.find((id) => id.type === 'phone')?.required && '*'}</label> + <input + type="tel" + id="phone" + placeholder="Enter your phone number" + value={phone} + onChange={(e) => setPhone(e.target.value)} + className="input-field" + /> + </div> + )} + + {/* Username */} + {identifiers.find((id) => id.type === 'username') && ( + <div> + <label>Username {identifiers.find((id) => id.type === 'username')?.required && '*'}</label> + <input + type="text" + id="username" + placeholder="Enter your username" + value={username} + onChange={(e) => setUsername(e.target.value)} + className={`input-field ${username && !isValid ? 'border-red-500' : 'border-gray-300' + }`} + /> + + {username.length > 0 && errors.length > 0 && ( + <ul className="mt-1 text-sm text-red-500"> + {errors.map((err, i) => ( + <li key={i}>{err.message}</li> + ))} + </ul> + )} + </div> + )} + + {/* Error & Success Messages */} + {error && ( + <div className="error-container"> + <p>{error}</p> + </div> + )} + {success && ( + <div className="success-message"> + Signup successful! Please check your email to verify your account. + </div> + )} + + {/* Submit Button */} + <div className="button-container"> + <Button onClick={() => handleSignup}> + Sign Up + </Button> + </div> + </form> + + {/* Login Link */} + {links?.login && ( + <div className="mt-6 text-center text-sm"> + <span> + Already have an account? + </span> + <a + href={links.loginLink} + className="text-indigo-600 hover:underline" + > + Log in + </a> + </div> + )} + {/* OR separator */} + <div className="flex items-center my-4"> + <div className="flex-1 border-t border-gray-300"></div> + <span className="px-3 text-sm text-gray-400">OR</span> + <div className="flex-1 border-t border-gray-300"></div> + </div> + + {/* Google login */} + {federatedConnections.length > 0 && federatedConnections.map((conn: any) => ( + <button + key={conn.name} + onClick={() => handleFederatedSignup(conn.name)} + className="w-full flex items-center justify-center gap-2 rounded-md border border-gray-300 bg-white px-4 py-2 text-sm font-medium text-gray-700 hover:bg-gray-50" + > + {/* <img src="/google-icon.svg" alt="" className="h-4 w-4" /> */} + Continue with {conn.options?.display_name || conn.name} + </button> + ))} + + </div> + </div> + ); +}; + +export default SignupIdScreen; +``` + +</RequestExample> + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> +</ParamField> + +<ParamField path="screen" type={<span>ScreenOptions</span>} required> +</ParamField> + +<ParamField path="transaction" type={<span>TransactionOptions</span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="signup" type={<span>Promise<void></span>}> + This methods handles signup-id related configuration. It allows to signup new users via different identifiers. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions">SignupOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="federatedSignup" type={<span>Promise<void></span>}> + This methods handles allows signup via different social identifiers. Eg: Google, Facebook etc. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions">FederatedSignupOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getSignupIdentifiers" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier">Identifier[]</a> | null</span>}> + Returns the list of enabled identifiers for the signup-id form, marking each as required or optional based on transaction config. + +</ParamField> + +<ParamField path="pickCountryCode" type={<span>Promise<void></span>}> +</ParamField> + +<ParamField path="validateUsername" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}> + Validates a given username against the current username policy defined in the transaction context. + + <Expandable title="parameters"> + <ParamField path="username" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/signup-id/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/signup-id/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupPassword.mdx new file mode 100644 index 000000000..9d1be6f37 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupPassword.mdx @@ -0,0 +1,281 @@ +--- +title: "SignupPassword" +description: "" +--- + +<RequestExample> + +```typescript signup lines +import SignupPassword from "@auth0/auth0-acul-js/signup-password"; + + const signupPasswordManager = new SignupPassword(); + const { transaction, screen } = signupPasswordManager; + + //get mandatory & optional identifiers required for signup-password screen to proceed + const mandatoryIdentifier = transaction.getRequiredIdentifiers(); //eg: email + const optionalIdentifiers = transaction.getOptionalIdentifiers() //eg: phone + + //get signup data submitted on previous screen from previous screen + const data = screen.data; //eg: email, phone + + + const signupParams = { + email : data.email, + phone : data.phone_number, + password : "********" + }; + + signupPasswordManager.signup(signupParams); +``` + +```typescript signupPassword Example using validatePassword lines +import React, { useState } from 'react'; +import SignupPassword from '@auth0/auth0-acul-js/signup-password'; +import { Logo } from '../../components/Logo'; +import Button from '../../components/Button'; + +const SignupPasswordScreen: React.FC = () => { + const [password, setPassword] = useState(''); + const [error, setError] = useState(''); + const [success, setSuccess] = useState(false); + + const signupPasswordManager = new SignupPassword(); + + const email = signupPasswordManager.screen.data?.email || ''; + const phone = signupPasswordManager.screen.data?.phoneNumber || ''; + const username = signupPasswordManager.screen.data?.username || ''; + + const title = signupPasswordManager.screen.texts?.title || ''; + const description = signupPasswordManager.screen.texts?.description || ''; + + const { isValid, results } = signupPasswordManager.validatePassword(password); + + const handleSignup = async (e: React.FormEvent) => { + e.preventDefault(); + setError(''); + setSuccess(false); + + if (!email || !password) { + setError('Email and password are required.'); + return; + } + + if (!isValid) return; + + try { + await signupPasswordManager.signup({ email, username, phone, password }); + setSuccess(true); + } catch { + setError('Signup failed. Please try again later.'); + } + }; + + return ( + <div className="prompt-container"> + <Logo /> + + {/* Title Section (inline, not imported) */} + <div className="title-container"> + <h1 className="mt-6 text-center text-3xl font-extrabold text-gray-900">{title}</h1> + <div> + <p className="mt-2 text-center text-sm text-gray-600">{description}</p> + </div> + </div> + + {/* Form */} + <div className="input-container"> + <form onSubmit={handleSignup}> + {email && ( + <div> + <label>Email</label> + <input + type="email" + id="email" + placeholder="Enter your email" + value={email} + disabled + /> + </div> + )} + + + {username && ( + <div> + <label>Username</label> + <input + type="text" + id="username" + placeholder="Enter your username" + value={username} + disabled + /> + </div> + )} + + { + phone && ( + <div> + <label>Phone</label> + <input + type="tel" + id="phone" + placeholder="Enter your phone number" + value={phone} + disabled + /> + </div> + ) + } + + + + <label>Password</label> + <input + type="password" + id="password" + placeholder="Enter your password" + value={password} + onChange={(e) => setPassword(e.target.value)} + className={!isValid && password.length > 0 ? 'error' : ''} + /> + + {/* Password Validation Rules */} + + {password.length > 0 && results.length > 0 && ( + <div className="mt-2 border border-gray-300 rounded p-2 text-sm"> + <p className="text-gray-700 mb-1">Your password must contain:</p> + <ul className="list-disc ml-4"> + {results.map((rule) => ( + <li + key={rule.code} + className={rule.status === 'valid' ? 'text-green-600' : 'text-gray-700'} + > + {rule.label} + {rule.items && rule.items.length > 0 && ( + <ul className="ml-5 list-disc"> + {rule.items.map((sub) => ( + <li + key={sub.code} + className={sub.status === 'valid' ? 'text-green-600' : 'text-gray-700'} + > + {sub.label} + </li> + ))} + </ul> + )} + </li> + ))} + </ul> + </div> + )} + {/* Error & Success messages */} + {error && ( + <div className="error-container"> + <p>{error}</p> + </div> + )} + + {success && ( + <div className="success-message"> + Signup successful! Please check your email to verify your account. + </div> + )} + + {/* Submit Button */} + <div className="button-container"> + <Button onClick={() => handleSignup}> + Sign Up + </Button> + </div> + </form> + </div> + </div> + ); +}; + +export default SignupPasswordScreen; +``` + +</RequestExample> + +## Properties + +<ParamField path="screenIdentifier" type={<span>string</span>} required> +</ParamField> + +<ParamField path="screen" type={<span>ScreenOptions</span>} required> +</ParamField> + +<ParamField path="transaction" type={<span>TransactionOptions</span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> +</ParamField> + +## Methods + +<ParamField path="signup" type={<span>Promise<void></span>}> + This methods handles signup-password related screen configuration. It allows to proceed with registering signup password along with signup identifiers passed in previous screen + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordOptions">SignupPasswordOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="federatedSignup" type={<span>Promise<void></span>}> + This methods handles allows signup via different social identifiers. Eg: Google, Facebook etc. + + <Expandable title="parameters"> + <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions">FederatedSignupOptions</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="validatePassword" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> + Validates a password string against the current transaction's password policy. This method retrieves the password policy from the current transaction context and delegates the actual validation to `coreValidatePassword`. It returns an array of validation results, each containing: - `code`: the identifier of the password rule, - `policy`: a user-friendly description of the rule, - `isValid`: boolean indicating if the password passed that rule. + + <Expandable title="parameters"> + <ParamField path="password" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> + Retrieves a specific part of the Universal Login Context. + + <Expandable title="parameters"> + <ParamField path="model" type={<span>K</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span>TransactionError[]</span>}> + Retrieves the array of transaction errors from the context, or an empty array if none exist. + +</ParamField> + +--- + +**File:** [src/screens/signup-password/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/signup-password/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Tenant.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Tenant.mdx new file mode 100644 index 000000000..25b3fbe58 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Tenant.mdx @@ -0,0 +1,26 @@ +--- +title: "Tenant" +description: "" +--- + +## Properties + +<ParamField path="name" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a>['name']</span>} required> + The name of the tenant +</ParamField> + +<ParamField path="friendlyName" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a>['friendlyName']</span>} required> + The display name of the tenant +</ParamField> + +<ParamField path="enabledLocales" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a>['enabledLocales']</span>} required> + List of locales enabled for the tenant +</ParamField> + +<ParamField path="enabledFactors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a>['enabledFactors']</span>} required> + List of MFA factors enabled for the tenant +</ParamField> + +--- + +**File:** [src/models/tenant.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/tenant.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Transaction.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Transaction.mdx new file mode 100644 index 000000000..dd646d239 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Transaction.mdx @@ -0,0 +1,75 @@ +--- +title: "Transaction" +description: "" +--- + +## Properties + +<ParamField path="state" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['state']</span>} required> + The current state of the authentication transaction +</ParamField> + +<ParamField path="hasErrors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['hasErrors']</span>} required> + Indicates if the transaction has errors +</ParamField> + +<ParamField path="locale" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['locale']</span>} required> + The current locale for the transaction +</ParamField> + +<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['countryCode']</span>} required> + The country code if available +</ParamField> + +<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['countryCode']</span>} required> + The phone prefix for the country +</ParamField> + +<ParamField path="connectionStrategy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['connectionStrategy']</span>} required> + The strategy of the current connection +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['errors']</span>} required> + List of errors in the transaction +</ParamField> + +<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['currentConnection']</span>} required> + The connection being used +</ParamField> + +<ParamField path="alternateConnections" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['alternateConnections']</span>} required> + Other available connections +</ParamField> + +## Methods + +<ParamField path="getErrors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['errors']</span>}> + @static + + <Expandable title="parameters"> + <ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getCurrentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['currentConnection']</span>}> + @static + + <Expandable title="parameters"> + <ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getAlternateConnections" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['alternateConnections']</span>}> + @static + + <Expandable title="parameters"> + <ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [src/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride.mdx new file mode 100644 index 000000000..cafeb7187 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride.mdx @@ -0,0 +1,96 @@ +--- +title: "TransactionOverride" +description: "" +--- + +## Properties + +<ParamField path="isPasskeyEnabled" type={<span>OverrideOptions['isPasskeyEnabled']</span>} required> +</ParamField> + +<ParamField path="passwordPolicy" type={<span>OverrideOptions['passwordPolicy']</span>} required> +</ParamField> + +<ParamField path="optionalIdentifiers" type={<span>OverrideOptions['optionalIdentifiers']</span>} required> +</ParamField> + +<ParamField path="requiredIdentifiers" type={<span>OverrideOptions['requiredIdentifiers']</span>} required> +</ParamField> + +<ParamField path="state" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['state']</span>} required> + The current state of the authentication transaction +</ParamField> + +<ParamField path="hasErrors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['hasErrors']</span>} required> + Indicates if the transaction has errors +</ParamField> + +<ParamField path="locale" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['locale']</span>} required> + The current locale for the transaction +</ParamField> + +<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['countryCode']</span>} required> + The country code if available +</ParamField> + +<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['countryCode']</span>} required> + The phone prefix for the country +</ParamField> + +<ParamField path="connectionStrategy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['connectionStrategy']</span>} required> + The strategy of the current connection +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['errors']</span>} required> + List of errors in the transaction +</ParamField> + +<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['currentConnection']</span>} required> + The connection being used +</ParamField> + +<ParamField path="alternateConnections" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['alternateConnections']</span>} required> + Other available connections +</ParamField> + +## Methods + +<ParamField path="getRequiredIdentifiers" type={<span>OverrideOptions['requiredIdentifiers']</span>}> + <Expandable title="parameters"> + <ParamField path="transactionContext" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> + </ParamField> + <ParamField path="connectionStrategy" type={<span>string | null</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getErrors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['errors']</span>}> + @static + + <Expandable title="parameters"> + <ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getCurrentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['currentConnection']</span>}> + @static + + <Expandable title="parameters"> + <ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getAlternateConnections" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['alternateConnections']</span>}> + @static + + <Expandable title="parameters"> + <ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [src/screens/signup-password/transaction-override.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/signup-password/transaction-override.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedData.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedData.mdx new file mode 100644 index 000000000..cc6b1f152 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedData.mdx @@ -0,0 +1,38 @@ +--- +title: "UntrustedData" +description: "" +--- + +## Properties + +<ParamField path="submittedFormData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>['submittedFormData']</span>} required> + Form data submitted by the user +</ParamField> + +<ParamField path="authorizationParams" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>['authorizationParams']</span>} required> + Authorization parameters from the request +</ParamField> + +## Methods + +<ParamField path="getSubmittedFormData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>['submittedFormData']</span>}> + @static + + <Expandable title="parameters"> + <ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a> | undefined</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getAuthorizationParams" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>['authorizationParams']</span>}> + @static + + <Expandable title="parameters"> + <ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a> | undefined</span>}> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [src/models/untrusted-data.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/untrusted-data.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride.mdx new file mode 100644 index 000000000..005a43aea --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride.mdx @@ -0,0 +1,37 @@ +--- +title: "UntrustedDataOverride" +description: "Untrusted data override class for the mfa-voice-challenge screen Handles remember_device field from submitted form data" +--- + +## Properties + +<ParamField path="submittedFormData" type={<span>OverrideOptions['submittedFormData']</span>} required> +</ParamField> + +<ParamField path="authorizationParams" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>['authorizationParams']</span>} required> + Authorization parameters from the request +</ParamField> + +## Methods + +<ParamField path="getSubmittedFormData" type={<span>OverrideOptions['submittedFormData']</span>}> + @static + + <Expandable title="parameters"> + <ParamField path="untrustedDataContext" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="getAuthorizationParams" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>['authorizationParams']</span>}> + @static + + <Expandable title="parameters"> + <ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a> | undefined</span>}> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [src/screens/mfa-voice-challenge/untrusted-data-overrider.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-voice-challenge/untrusted-data-overrider.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/User.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/User.mdx new file mode 100644 index 000000000..3bbb70ee7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/User.mdx @@ -0,0 +1,69 @@ +--- +title: "User" +description: "" +--- + +## Properties + +<ParamField path="id" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['id']</span>} required> + The unique identifier of the user +</ParamField> + +<ParamField path="username" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['username']</span>} required> + The username of the user +</ParamField> + +<ParamField path="email" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['email']</span>} required> + The email address of the user +</ParamField> + +<ParamField path="picture" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['picture']</span>} required> + URL to the user's profile picture +</ParamField> + +<ParamField path="phoneNumber" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['phoneNumber']</span>} required> + The phone number of the user +</ParamField> + +<ParamField path="userMetadata" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['userMetadata']</span>} required> + @property | null} userMetadata - User-specific metadata that can be modified +</ParamField> + +<ParamField path="appMetadata" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['appMetadata']</span>} required> + @property | null} appMetadata - Application-specific metadata about the user +</ParamField> + +<ParamField path="enrolledFactors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['enrolledFactors']</span>} required> + List of MFA factors the user has enrolled in +</ParamField> + +<ParamField path="enrolledEmails" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['enrolledEmails']</span>} required> + List of emails the user has enrolled for MFA +</ParamField> + +<ParamField path="enrolledPhoneNumbers" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['enrolledPhoneNumbers']</span>} required> + List of phone numbers the user has enrolled for MFA +</ParamField> + +<ParamField path="enrolledDevices" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['enrolledDevices']</span>} required> + List of devices the user has enrolled for MFA +</ParamField> + +<ParamField path="organizations" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['organizations']</span>} required> + @property | undefined}> | null} organizations - Organizations the user belongs to +</ParamField> + +## Methods + +<ParamField path="getOrganizations" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['organizations']</span>}> + @static + + <Expandable title="parameters"> + <ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [src/models/user.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/user.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UserInputError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UserInputError.mdx new file mode 100644 index 000000000..3a28771eb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UserInputError.mdx @@ -0,0 +1,16 @@ +--- +title: "UserInputError" +description: "" +--- + +## Properties + +<ParamField path="code" type={<span>any</span>} required> +</ParamField> + +<ParamField path="field" type={<span>string</span>}> +</ParamField> + +--- + +**File:** [src/utils/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/base64UrlToUint8Array.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/base64UrlToUint8Array.mdx new file mode 100644 index 000000000..cfd3e4a0a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/base64UrlToUint8Array.mdx @@ -0,0 +1,18 @@ +--- +title: "base64UrlToUint8Array" +description: "" +--- + +## Parameters + +<ParamField path="base64Url" type={<span>string</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>ArrayBuffer</span>}> +</ParamField> + +--- + +**File:** [src/utils/codec.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/codec.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPasskeyCredentials.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPasskeyCredentials.mdx new file mode 100644 index 000000000..37ccf1572 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPasskeyCredentials.mdx @@ -0,0 +1,18 @@ +--- +title: "createPasskeyCredentials" +description: "" +--- + +## Parameters + +<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>['public_key']</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>Promise<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreateResponse">PasskeyCreateResponse</a>></span>}> +</ParamField> + +--- + +**File:** [src/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPollingControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPollingControl.mdx new file mode 100644 index 000000000..12535f5f5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPollingControl.mdx @@ -0,0 +1,18 @@ +--- +title: "createPollingControl" +description: "Starts polling the MFA push challenge endpoint using XHR GET requests. - Polls the given URL (or current page URL if not provided) at the specified interval. - Calls the `condition` function with the response body to determine if polling should stop. - If the condition is met, calls `onCompleted` and stops polling. - Handles rate limiting (HTTP 429) by waiting until the rate limit resets. - Calls `onError` if a non-200/429 response is received. - Returns a cancel function to stop polling." +--- + +## Parameters + +<ParamField path="options" type={<span>MfaPollingOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> +</ParamField> + +--- + +**File:** [src/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createResendControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createResendControl.mdx new file mode 100644 index 000000000..c1400662e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createResendControl.mdx @@ -0,0 +1,27 @@ +--- +title: "createResendControl" +description: "Utility function to create resend functionality with timeout management" +--- + +## Parameters + +<ParamField path="screenIdentifier" type={<span>string</span>} required> +</ParamField> + +<ParamField path="resendMethod" type={<span>() => Promise<void></span>} required> +</ParamField> + +<ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> +</ParamField> + +<ParamField path="resendLimitReached" type={<span>boolean</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> +</ParamField> + +--- + +**File:** [src/utils/resend-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/resend-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/decodePublicKey.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/decodePublicKey.mdx new file mode 100644 index 000000000..5826f970c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/decodePublicKey.mdx @@ -0,0 +1,18 @@ +--- +title: "decodePublicKey" +description: "" +--- + +## Parameters + +<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>['public_key']</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>PublicKeyCredentialCreationOptions</span>}> +</ParamField> + +--- + +**File:** [src/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/extractIdentifiersByStatus.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/extractIdentifiersByStatus.mdx new file mode 100644 index 000000000..3ad791bd3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/extractIdentifiersByStatus.mdx @@ -0,0 +1,21 @@ +--- +title: "extractIdentifiersByStatus" +description: "Helper function that extracts identifiers based on their signup status. Used internally by getAllowedIdentifiers, getRequiredIdentifiers, and getOptionalIdentifiers." +--- + +## Parameters + +<ParamField path="connection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection">DBConnection</a> | undefined</span>}> +</ParamField> + +<ParamField path="statuses" type={<span>('required' | 'optional')[]</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +--- + +**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenBorders.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenBorders.mdx new file mode 100644 index 000000000..a709b2520 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenBorders.mdx @@ -0,0 +1,18 @@ +--- +title: "flattenBorders" +description: "Processes and returns theme borders configuration" +--- + +## Parameters + +<ParamField path="themeBorders" type={<span>Record<string, string | boolean | number></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>Record<string, string | boolean | number></span>}> +</ParamField> + +--- + +**File:** [src/utils/branding-theme.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/branding-theme.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenColors.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenColors.mdx new file mode 100644 index 000000000..eba0f1b6d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenColors.mdx @@ -0,0 +1,21 @@ +--- +title: "flattenColors" +description: "Flattens and merges theme colors with settings colors" +--- + +## Parameters + +<ParamField path="themeColors" type={<span>Record<string, string></span>} required> +</ParamField> + +<ParamField path="settingsColors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings">BrandingSettings</a>['colors']</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>Record<string, string></span>}> +</ParamField> + +--- + +**File:** [src/utils/branding-theme.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/branding-theme.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenFonts.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenFonts.mdx new file mode 100644 index 000000000..fe126971b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenFonts.mdx @@ -0,0 +1,18 @@ +--- +title: "flattenFonts" +description: "Processes and returns theme fonts configuration" +--- + +## Parameters + +<ParamField path="themeFonts" type={<span>Record<string, string | boolean | object></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>Record<string, string | number | boolean | object></span>}> +</ParamField> + +--- + +**File:** [src/utils/branding-theme.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/branding-theme.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenPageBackground.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenPageBackground.mdx new file mode 100644 index 000000000..30d891c94 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenPageBackground.mdx @@ -0,0 +1,31 @@ +--- +title: "flattenPageBackground" +description: "Flattens and merges theme page background with settings background" +--- + +## Parameters + +<ParamField path="themeBackground" type={<span>Record<string, string></span>} required> +</ParamField> + +<ParamField path="settingsPageBackground" type={<span>string | object</span>}> + <Expandable title="properties"> + <ParamField path="type" type={<span>string</span>} required> + </ParamField> + <ParamField path="start" type={<span>string</span>} required> + </ParamField> + <ParamField path="end" type={<span>string</span>} required> + </ParamField> + <ParamField path="angleDegree" type={<span>number</span>} required> + </ParamField> + </Expandable> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>Record<string, string></span>}> +</ParamField> + +--- + +**File:** [src/utils/branding-theme.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/branding-theme.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenWidget.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenWidget.mdx new file mode 100644 index 000000000..ded2e72b5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenWidget.mdx @@ -0,0 +1,18 @@ +--- +title: "flattenWidget" +description: "Processes and returns theme widget configuration" +--- + +## Parameters + +<ParamField path="themeWidget" type={<span>Record<string, string | number></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>Record<string, string | number></span>}> +</ParamField> + +--- + +**File:** [src/utils/branding-theme.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/branding-theme.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getActiveIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getActiveIdentifiers.mdx new file mode 100644 index 000000000..b2aeca443 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getActiveIdentifiers.mdx @@ -0,0 +1,18 @@ +--- +title: "getActiveIdentifiers" +description: "Returns the active identifiers (email, username, phone) based on the connection settings. Active identifiers are those that can be used for login." +--- + +## Parameters + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +--- + +**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getAllowedIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getAllowedIdentifiers.mdx new file mode 100644 index 000000000..e8d5ba0e4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getAllowedIdentifiers.mdx @@ -0,0 +1,18 @@ +--- +title: "getAllowedIdentifiers" +description: "Returns the allowed identifiers (email, username, phone) based on the connection settings. This includes both required and optional identifier types." +--- + +## Parameters + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId">TransactionMembersOnLoginId</a>['allowedIdentifiers'] | null</span>}> +</ParamField> + +--- + +**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBackLink.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBackLink.mdx new file mode 100644 index 000000000..5dd75e74f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBackLink.mdx @@ -0,0 +1,18 @@ +--- +title: "getBackLink" +description: "Retrieves the back link from the screen context." +--- + +## Parameters + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>string | null</span>}> +</ParamField> + +--- + +**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBrowserCapabilities.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBrowserCapabilities.mdx new file mode 100644 index 000000000..ec1c52131 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBrowserCapabilities.mdx @@ -0,0 +1,15 @@ +--- +title: "getBrowserCapabilities" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>Promise<object></span>}> +</ParamField> + +--- + +**File:** [src/utils/browser-capabilities.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/browser-capabilities.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreen.mdx new file mode 100644 index 000000000..8e0f6ab8e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreen.mdx @@ -0,0 +1,15 @@ +--- +title: "getCurrentScreen" +description: "Gets the current screen name from the authentication context" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>string | null</span>}> +</ParamField> + +--- + +**File:** [src/common/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/common/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreenOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreenOptions.mdx new file mode 100644 index 000000000..1d3bbf1de --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreenOptions.mdx @@ -0,0 +1,15 @@ +--- +title: "getCurrentScreenOptions" +description: "Gets the current screen options including client, organization, prompt, screen, tenant, transaction, and untrusted data" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CurrentScreenOptions">CurrentScreenOptions</a></span>}> +</ParamField> + +--- + +**File:** [src/common/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/common/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getEditIdentifierLink.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getEditIdentifierLink.mdx new file mode 100644 index 000000000..3d4b940ad --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getEditIdentifierLink.mdx @@ -0,0 +1,18 @@ +--- +title: "getEditIdentifierLink" +description: "Retrieves the edit identifier link from the screen context." +--- + +## Parameters + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>string | null</span>}> +</ParamField> + +--- + +**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getErrors.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getErrors.mdx new file mode 100644 index 000000000..5bbda134e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getErrors.mdx @@ -0,0 +1,15 @@ +--- +title: "getErrors" +description: "Gets the current errors from the transaction context" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>TransactionError[] | null</span>}> +</ParamField> + +--- + +**File:** [src/common/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/common/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getForgotPasswordLink.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getForgotPasswordLink.mdx new file mode 100644 index 000000000..0378b18d1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getForgotPasswordLink.mdx @@ -0,0 +1,18 @@ +--- +title: "getForgotPasswordLink" +description: "Retrieves the forgot password link from the screen context." +--- + +## Parameters + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>string | null</span>}> +</ParamField> + +--- + +**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginIdentifiers.mdx new file mode 100644 index 000000000..c4fd993d7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginIdentifiers.mdx @@ -0,0 +1,18 @@ +--- +title: "getLoginIdentifiers" +description: "Returns a list of allowed login identifiers. This function accepts an array of allowed identifier types or `null`, and returns the array if provided, or an empty array otherwise." +--- + +## Parameters + +<ParamField path="allowedIdentifiers" type={<span>Array<IdentifierType> | null</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +--- + +**File:** [src/utils/login-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/login-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginLink.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginLink.mdx new file mode 100644 index 000000000..770551c0b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginLink.mdx @@ -0,0 +1,18 @@ +--- +title: "getLoginLink" +description: "Retrieves the login link from the screen context." +--- + +## Parameters + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>string | null</span>}> +</ParamField> + +--- + +**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getOptionalIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getOptionalIdentifiers.mdx new file mode 100644 index 000000000..a71ce31aa --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getOptionalIdentifiers.mdx @@ -0,0 +1,18 @@ +--- +title: "getOptionalIdentifiers" +description: "Returns only the optional identifiers for signup flow based on connection settings." +--- + +## Parameters + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a>['optionalIdentifiers']</span>}> +</ParamField> + +--- + +**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasskeyCredentials.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasskeyCredentials.mdx new file mode 100644 index 000000000..f4731b981 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasskeyCredentials.mdx @@ -0,0 +1,18 @@ +--- +title: "getPasskeyCredentials" +description: "" +--- + +## Parameters + +<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key']</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>Promise<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCredentialResponse">PasskeyCredentialResponse</a>></span>}> +</ParamField> + +--- + +**File:** [src/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasswordPolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasswordPolicy.mdx new file mode 100644 index 000000000..b2a8f1d95 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasswordPolicy.mdx @@ -0,0 +1,18 @@ +--- +title: "getPasswordPolicy" +description: "Retrieves the password policy configuration from the transaction context. This includes properties like minimum length and complexity requirements." +--- + +## Parameters + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy">PasswordPolicy</a> | null</span>}> +</ParamField> + +--- + +**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPublicKey.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPublicKey.mdx new file mode 100644 index 000000000..2f39aa5c9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPublicKey.mdx @@ -0,0 +1,18 @@ +--- +title: "getPublicKey" +description: "Retrieves the public key for passkeys from the screen context." +--- + +## Parameters + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key'] | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>['public_key'] | null</span>}> +</ParamField> + +--- + +**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getRequiredIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getRequiredIdentifiers.mdx new file mode 100644 index 000000000..6bb873386 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getRequiredIdentifiers.mdx @@ -0,0 +1,18 @@ +--- +title: "getRequiredIdentifiers" +description: "Returns only the required identifiers for signup flow based on connection settings." +--- + +## Parameters + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a>['requiredIdentifiers']</span>}> +</ParamField> + +--- + +**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getResetPasswordLink.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getResetPasswordLink.mdx new file mode 100644 index 000000000..c4bf98f06 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getResetPasswordLink.mdx @@ -0,0 +1,18 @@ +--- +title: "getResetPasswordLink" +description: "Retrieves the reset password link from the screen context." +--- + +## Parameters + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>string | null</span>}> +</ParamField> + +--- + +**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getScopes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getScopes.mdx new file mode 100644 index 000000000..84508b915 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getScopes.mdx @@ -0,0 +1,18 @@ +--- +title: "getScopes" +description: "Retrieves and processes the scopes from the provided screen context. This function ensures that the scopes are properly formatted and validated. It provides default values for optional fields and ensures that the `values` property is always an array of strings. Invalid entries are filtered out." +--- + +## Parameters + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope">Scope[]</a></span>}> +</ParamField> + +--- + +**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getShowRememberDevice.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getShowRememberDevice.mdx new file mode 100644 index 000000000..3e9357625 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getShowRememberDevice.mdx @@ -0,0 +1,18 @@ +--- +title: "getShowRememberDevice" +description: "Retrieves the remember device option from the screen context. This is used in MFA flows where users can choose to remember their device for future logins." +--- + +## Parameters + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>boolean</span>}> +</ParamField> + +--- + +**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupIdentifiers.mdx new file mode 100644 index 000000000..2ef5790aa --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupIdentifiers.mdx @@ -0,0 +1,24 @@ +--- +title: "getSignupIdentifiers" +description: "Returns a list of enabled identifiers (email, phone, or username), each with its `required` status, based on the given required and optional identifiers, and the connection strategy." +--- + +## Parameters + +<ParamField path="requiredIdentifiers" type={<span>Array<IdentifierType></span>} required> +</ParamField> + +<ParamField path="optionalIdentifiers" type={<span>Array<IdentifierType></span>} required> +</ParamField> + +<ParamField path="connectionStrategy" type={<span>string | null</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier">Identifier[]</a></span>}> +</ParamField> + +--- + +**File:** [src/utils/signup-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/signup-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupLink.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupLink.mdx new file mode 100644 index 000000000..648a764a9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupLink.mdx @@ -0,0 +1,18 @@ +--- +title: "getSignupLink" +description: "Retrieves the signup link from the screen context." +--- + +## Parameters + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>string | null</span>}> +</ParamField> + +--- + +**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getUsernamePolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getUsernamePolicy.mdx new file mode 100644 index 000000000..1f7285b5f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getUsernamePolicy.mdx @@ -0,0 +1,18 @@ +--- +title: "getUsernamePolicy" +description: "Retrieves the username policy configuration from the transaction context. This includes settings like minimum/maximum length and allowed formats." +--- + +## Parameters + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy">UsernamePolicy</a> | null</span>}> +</ParamField> + +--- + +**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getWebAuthnType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getWebAuthnType.mdx new file mode 100644 index 000000000..80cf7b272 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getWebAuthnType.mdx @@ -0,0 +1,18 @@ +--- +title: "getWebAuthnType" +description: "Retrieves the WebAuthn type from the screen context." +--- + +## Parameters + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>string | null</span>}> +</ParamField> + +--- + +**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/hasFlexibleIdentifier.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/hasFlexibleIdentifier.mdx new file mode 100644 index 000000000..de8c5ab2d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/hasFlexibleIdentifier.mdx @@ -0,0 +1,18 @@ +--- +title: "hasFlexibleIdentifier" +description: "Checks if the connection supports flexible identifiers. A connection supports flexible identifiers if it has attributes configured." +--- + +## Parameters + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>boolean</span>}> +</ParamField> + +--- + +**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/internalPoll.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/internalPoll.mdx new file mode 100644 index 000000000..4a055c678 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/internalPoll.mdx @@ -0,0 +1,15 @@ +--- +title: "internalPoll" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isAuthenticatorAssertionResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isAuthenticatorAssertionResponse.mdx new file mode 100644 index 000000000..a0a36aa3c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isAuthenticatorAssertionResponse.mdx @@ -0,0 +1,18 @@ +--- +title: "isAuthenticatorAssertionResponse" +description: "" +--- + +## Parameters + +<ParamField path="response" type={<span>AuthenticatorResponse</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>response is AuthenticatorAssertionResponse</span>}> +</ParamField> + +--- + +**File:** [src/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isBrave.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isBrave.mdx new file mode 100644 index 000000000..3e30ab811 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isBrave.mdx @@ -0,0 +1,15 @@ +--- +title: "isBrave" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>Promise<boolean></span>}> +</ParamField> + +--- + +**File:** [src/utils/browser-capabilities.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/browser-capabilities.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isForgotPasswordEnabled.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isForgotPasswordEnabled.mdx new file mode 100644 index 000000000..41b2e4c57 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isForgotPasswordEnabled.mdx @@ -0,0 +1,18 @@ +--- +title: "isForgotPasswordEnabled" +description: "Checks if forgot password is enabled for the current database connection." +--- + +## Parameters + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>boolean</span>}> +</ParamField> + +--- + +**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isJsAvailable.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isJsAvailable.mdx new file mode 100644 index 000000000..cc27593e0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isJsAvailable.mdx @@ -0,0 +1,15 @@ +--- +title: "isJsAvailable" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>boolean</span>}> +</ParamField> + +--- + +**File:** [src/utils/browser-capabilities.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/browser-capabilities.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeyEnabled.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeyEnabled.mdx new file mode 100644 index 000000000..a48b240e8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeyEnabled.mdx @@ -0,0 +1,18 @@ +--- +title: "isPasskeyEnabled" +description: "Checks if passkeys are enabled in the current connection configuration." +--- + +## Parameters + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>boolean</span>}> +</ParamField> + +--- + +**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeySupported.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeySupported.mdx new file mode 100644 index 000000000..8d0e0ea31 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeySupported.mdx @@ -0,0 +1,15 @@ +--- +title: "isPasskeySupported" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>Promise<boolean></span>}> +</ParamField> + +--- + +**File:** [src/utils/browser-capabilities.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/browser-capabilities.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isRunning.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isRunning.mdx new file mode 100644 index 000000000..2d57a8269 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isRunning.mdx @@ -0,0 +1,15 @@ +--- +title: "isRunning" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>boolean</span>}> +</ParamField> + +--- + +**File:** [src/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isSignupEnabled.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isSignupEnabled.mdx new file mode 100644 index 000000000..7ae63c9c1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isSignupEnabled.mdx @@ -0,0 +1,18 @@ +--- +title: "isSignupEnabled" +description: "Checks if signup is enabled for the current connection." +--- + +## Parameters + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>boolean</span>}> +</ParamField> + +--- + +**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isUsernameRequired.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isUsernameRequired.mdx new file mode 100644 index 000000000..355351693 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isUsernameRequired.mdx @@ -0,0 +1,18 @@ +--- +title: "isUsernameRequired" +description: "Determines if a username is required for authentication based on connection settings." +--- + +## Parameters + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>boolean</span>}> +</ParamField> + +--- + +**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthAvailable.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthAvailable.mdx new file mode 100644 index 000000000..e12ea1cda --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthAvailable.mdx @@ -0,0 +1,15 @@ +--- +title: "isWebAuthAvailable" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>boolean</span>}> +</ParamField> + +--- + +**File:** [src/utils/browser-capabilities.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/browser-capabilities.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthPlatformAvailable.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthPlatformAvailable.mdx new file mode 100644 index 000000000..6916cab79 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthPlatformAvailable.mdx @@ -0,0 +1,15 @@ +--- +title: "isWebAuthPlatformAvailable" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>Promise<boolean></span>}> +</ParamField> + +--- + +**File:** [src/utils/browser-capabilities.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/browser-capabilities.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/parseErrorMessage.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/parseErrorMessage.mdx new file mode 100644 index 000000000..f07c74fdf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/parseErrorMessage.mdx @@ -0,0 +1,21 @@ +--- +title: "parseErrorMessage" +description: "" +--- + +## Parameters + +<ParamField path="responseText" type={<span>string</span>} required> +</ParamField> + +<ParamField path="status" type={<span>number</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>string</span>}> +</ParamField> + +--- + +**File:** [src/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/registerPasskeyAutofill.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/registerPasskeyAutofill.mdx new file mode 100644 index 000000000..6b4e9910a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/registerPasskeyAutofill.mdx @@ -0,0 +1,31 @@ +--- +title: "registerPasskeyAutofill" +description: "" +--- + +## Parameters + +<ParamField path="{ + publicKey, + inputId, + onResolve, + onReject, +}" type="object" required> + <Expandable title="properties"> + <ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key']</span>} required> + </ParamField> + <ParamField path="inputId" type={<span>string</span>}> + </ParamField> + <ParamField path="onResolve" type={<span>(credential: Credential) => void | Promise<void>; onReject?: (error: unknown) => void;</span>} required> + </ParamField> + </Expandable> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>Promise<AbortController | void></span>}> +</ParamField> + +--- + +**File:** [src/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/safeBase64Url.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/safeBase64Url.mdx new file mode 100644 index 000000000..196a08852 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/safeBase64Url.mdx @@ -0,0 +1,18 @@ +--- +title: "safeBase64Url" +description: "" +--- + +## Parameters + +<ParamField path="buffer" type={<span>ArrayBuffer | null</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>string | null</span>}> +</ParamField> + +--- + +**File:** [src/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/startPolling.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/startPolling.mdx new file mode 100644 index 000000000..dfe4016f9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/startPolling.mdx @@ -0,0 +1,15 @@ +--- +title: "startPolling" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/stopPolling.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/stopPolling.mdx new file mode 100644 index 000000000..d06dbd401 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/stopPolling.mdx @@ -0,0 +1,15 @@ +--- +title: "stopPolling" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/uint8ArrayToBase64Url.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/uint8ArrayToBase64Url.mdx new file mode 100644 index 000000000..f34277d21 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/uint8ArrayToBase64Url.mdx @@ -0,0 +1,18 @@ +--- +title: "uint8ArrayToBase64Url" +description: "" +--- + +## Parameters + +<ParamField path="arraybuffer" type={<span>ArrayBufferLike</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>string</span>}> +</ParamField> + +--- + +**File:** [src/utils/codec.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/codec.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/updatePayloadByIdentifier.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/updatePayloadByIdentifier.mdx new file mode 100644 index 000000000..fb47f8311 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/updatePayloadByIdentifier.mdx @@ -0,0 +1,25 @@ +--- +title: "updatePayloadByIdentifier" +description: "@private" +--- + +## Parameters + +<ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions">ResetPasswordRequestOptions</a></span>} required> +</ParamField> + +<ParamField path="isFlexibleIdentifier" type={<span>boolean</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions">ResetPasswordRequestOptions</a> | object</span>}> + <Expandable title="properties"> + <ParamField path="email" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [src/screens/reset-password-request/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-request/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validatePassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validatePassword.mdx new file mode 100644 index 000000000..8bdac9a9f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validatePassword.mdx @@ -0,0 +1,21 @@ +--- +title: "validatePassword" +description: "Validate a password string against an Auth0 password policy." +--- + +## Parameters + +<ParamField path="password" type={<span>string</span>} required> +</ParamField> + +<ParamField path="policy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy">PasswordPolicy</a> | null</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> +</ParamField> + +--- + +**File:** [src/utils/validate-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/validate-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validateUsername.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validateUsername.mdx new file mode 100644 index 000000000..23e23ff24 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validateUsername.mdx @@ -0,0 +1,21 @@ +--- +title: "validateUsername" +description: "Validates a username string against a given username policy. This function checks the username for: - Presence (if no policy is provided) - Minimum and maximum length - Email format restrictions - Phone number format restrictions If no policy is provided, it defaults to checking whether the username is non-empty." +--- + +## Parameters + +<ParamField path="username" type={<span>string</span>} required> +</ParamField> + +<ParamField path="policy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy">UsernamePolicy</a> | null</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}> +</ParamField> + +--- + +**File:** [src/utils/validate-username.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/validate-username.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AbortEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AbortEnrollmentOptions.mdx new file mode 100644 index 000000000..5c5886bc4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AbortEnrollmentOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "AbortEnrollmentOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface AbortEnrollmentOptions { + doNotShowAgain?: boolean; + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="doNotShowAgain" type={<span>boolean</span>}> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/passkey-enrollment-local.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AcceptInvitationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AcceptInvitationMembers.mdx new file mode 100644 index 000000000..180b2acda --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AcceptInvitationMembers.mdx @@ -0,0 +1,60 @@ +--- +title: "AcceptInvitationMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface AcceptInvitationMembers extends BaseMembers { + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembersOnAcceptInvitation; + transaction: TransactionMembers; + /** + * Accepts the invitation to the organization. + * @param payload Optional custom options to include with the request. + */ + acceptInvitation(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnAcceptInvitation">ScreenMembersOnAcceptInvitation</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="acceptInvitation" type={<span>Promise<void></span>} required> + Accepts the invitation to the organization. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/accept-invitation.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AllowCredential.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AllowCredential.mdx new file mode 100644 index 000000000..0e13b0a26 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AllowCredential.mdx @@ -0,0 +1,31 @@ +--- +title: "AllowCredential" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface AllowCredential { + type: 'public-key'; + id: Base64URLString; + transports?: AuthenticatorTransport[]; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="type" type={<span>'public-key'</span>} required> +</ParamField> + +<ParamField path="id" type={<span>Base64URLString</span>} required> +</ParamField> + +<ParamField path="transports" type={<span>AuthenticatorTransport[]</span>}> +</ParamField> + +--- + +**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail.mdx new file mode 100644 index 000000000..330be70fa --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail.mdx @@ -0,0 +1,27 @@ +--- +title: "AuthorizationDetail" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface AuthorizationDetail { + type: string; + [key: string]: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="type" type={<span>string</span>} required> +</ParamField> + +<ParamField path="unknown" type={<span>string</span>} required> +</ParamField> + +--- + +**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseContext.mdx new file mode 100644 index 000000000..0f1a6290c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseContext.mdx @@ -0,0 +1,55 @@ +--- +title: "BaseContext" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface BaseContext { + branding?: BrandingContext; + client: ClientContext; + organization: OrganizationContext; + prompt: PromptContext; + screen: ScreenContext; + tenant?: TenantContext; + transaction: TransactionContext; + user: UserContext; + untrusted_data?: UntrustedDataContext; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> +</ParamField> + +<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>}> +</ParamField> + +--- + +**File:** [interfaces/models/base-context.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/base-context.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseMembers.mdx new file mode 100644 index 000000000..f5009536f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseMembers.mdx @@ -0,0 +1,55 @@ +--- +title: "BaseMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface BaseMembers { + branding: BrandingMembers; + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + tenant: TenantMembers; + transaction: TransactionMembers; + user: UserMembers; + untrustedData: UntrustedDataMembers; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/models/base-context.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/base-context.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Branding.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Branding.mdx new file mode 100644 index 000000000..7c1d53edf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Branding.mdx @@ -0,0 +1,36 @@ +--- +title: "Branding" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface Branding { + logoUrl?: string; + colors?: { + primary?: string; + pageBackground?: string; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="logoUrl" type={<span>string</span>}> +</ParamField> + +<ParamField path="colors" type="object"> + <Expandable title="properties"> + <ParamField path="primary" type={<span>string</span>}> + </ParamField> + <ParamField path="pageBackground" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/models/organization.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/organization.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext.mdx new file mode 100644 index 000000000..94bade51e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext.mdx @@ -0,0 +1,101 @@ +--- +title: "BrandingContext" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface BrandingContext { + settings?: { + colors?: { + primary?: string; + page_background?: + | string + | { + type: string; + start: string; + end: string; + angle_deg: number; + }; + }; + favicon_url?: string; + logo_url?: string; + font?: { + url: string; + }; + }; + themes?: { + default: { + borders: Record<string, string | boolean | number>; + colors: Record<string, string>; + displayName: string; + fonts: Record<string, string | boolean | object>; + page_background: Record<string, string>; + widget: Record<string, string | number>; + }; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="settings" type="object"> + <Expandable title="properties"> + <ParamField path="colors" type="object"> + <Expandable title="properties"> + <ParamField path="primary" type={<span>string</span>}> + </ParamField> + <ParamField path="page_background" type={<span>string | object</span>}> + <Expandable title="properties"> + <ParamField path="type" type={<span>string</span>} required> + </ParamField> + <ParamField path="start" type={<span>string</span>} required> + </ParamField> + <ParamField path="end" type={<span>string</span>} required> + </ParamField> + <ParamField path="angle_deg" type={<span>number</span>} required> + </ParamField> + </Expandable> + </ParamField> + </Expandable> + </ParamField> + <ParamField path="favicon_url" type={<span>string</span>}> + </ParamField> + <ParamField path="logo_url" type={<span>string</span>}> + </ParamField> + <ParamField path="font" type="object"> + <Expandable title="properties"> + <ParamField path="url" type={<span>string</span>} required> + </ParamField> + </Expandable> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="themes" type="object"> + <Expandable title="properties"> + <ParamField path="default" type="object" required> + <Expandable title="properties"> + <ParamField path="borders" type={<span>Record<string, string | boolean | number></span>} required> + </ParamField> + <ParamField path="colors" type={<span>Record<string, string></span>} required> + </ParamField> + <ParamField path="displayName" type={<span>string</span>} required> + </ParamField> + <ParamField path="fonts" type={<span>Record<string, string | boolean | object></span>} required> + </ParamField> + <ParamField path="page_background" type={<span>Record<string, string></span>} required> + </ParamField> + <ParamField path="widget" type={<span>Record<string, string | number></span>} required> + </ParamField> + </Expandable> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/models/branding.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/branding.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers.mdx new file mode 100644 index 000000000..5a0c29b22 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers.mdx @@ -0,0 +1,27 @@ +--- +title: "BrandingMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface BrandingMembers { + settings: BrandingSettings | null; + themes: BrandingThemes | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="settings" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings">BrandingSettings</a> | null</span>}> +</ParamField> + +<ParamField path="themes" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingThemes">BrandingThemes</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/models/branding.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/branding.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings.mdx new file mode 100644 index 000000000..281b6613a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings.mdx @@ -0,0 +1,61 @@ +--- +title: "BrandingSettings" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface BrandingSettings { + colors?: { + primary?: string; + pageBackground?: + | string + | { + type: string; + start: string; + end: string; + angleDegree: number; + }; + }; + faviconUrl?: string; + logoUrl?: string; + fontUrl?: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="colors" type="object"> + <Expandable title="properties"> + <ParamField path="primary" type={<span>string</span>}> + </ParamField> + <ParamField path="pageBackground" type={<span>string | object</span>}> + <Expandable title="properties"> + <ParamField path="type" type={<span>string</span>} required> + </ParamField> + <ParamField path="start" type={<span>string</span>} required> + </ParamField> + <ParamField path="end" type={<span>string</span>} required> + </ParamField> + <ParamField path="angleDegree" type={<span>number</span>} required> + </ParamField> + </Expandable> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="faviconUrl" type={<span>string</span>}> +</ParamField> + +<ParamField path="logoUrl" type={<span>string</span>}> +</ParamField> + +<ParamField path="fontUrl" type={<span>string</span>}> +</ParamField> + +--- + +**File:** [interfaces/models/branding.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/branding.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingThemes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingThemes.mdx new file mode 100644 index 000000000..6dc21caca --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingThemes.mdx @@ -0,0 +1,44 @@ +--- +title: "BrandingThemes" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface BrandingThemes { + default: { + borders: Record<string, string | boolean | number>; + colors: Record<string, string>; + displayName: string; + fonts: Record<string, string | boolean | object>; + pageBackground: Record<string, string>; + widget: Record<string, string | number>; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="default" type="object" required> + <Expandable title="properties"> + <ParamField path="borders" type={<span>Record<string, string | boolean | number></span>} required> + </ParamField> + <ParamField path="colors" type={<span>Record<string, string></span>} required> + </ParamField> + <ParamField path="displayName" type={<span>string</span>} required> + </ParamField> + <ParamField path="fonts" type={<span>Record<string, string | boolean | object></span>} required> + </ParamField> + <ParamField path="pageBackground" type={<span>Record<string, string></span>} required> + </ParamField> + <ParamField path="widget" type={<span>Record<string, string | number></span>} required> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/models/branding.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/branding.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureMembers.mdx new file mode 100644 index 000000000..183528892 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureMembers.mdx @@ -0,0 +1,47 @@ +--- +title: "BruteForceProtectionUnblockFailureMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface BruteForceProtectionUnblockFailureMembers extends BaseMembers { + screen: ScreenMembersOnBruteForceProtectionUnblockFailure; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockFailure">ScreenMembersOnBruteForceProtectionUnblockFailure</a></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/brute-force-protection-unblock-failure.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/brute-force-protection-unblock-failure.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureOptions.mdx new file mode 100644 index 000000000..d97d3d099 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "BruteForceProtectionUnblockFailureOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface BruteForceProtectionUnblockFailureOptions { + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/brute-force-protection-unblock-failure.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/brute-force-protection-unblock-failure.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockMembers.mdx new file mode 100644 index 000000000..6e50f53a2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockMembers.mdx @@ -0,0 +1,56 @@ +--- +title: "BruteForceProtectionUnblockMembers" +description: "Represents the members of the BruteForceProtectionUnblock screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface BruteForceProtectionUnblockMembers extends BaseMembers { + /** + * Submits the unblock account request. + * @param {CustomOptions} [payload] - Optional payload to include with the unblock request. + * @returns {Promise<void>} A promise that resolves when the unblock request is successfully submitted. + */ + unblockAccount(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="unblockAccount" type={<span>Promise<void></span>} required> + Submits the unblock account request. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/brute-force-protection-unblock.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/brute-force-protection-unblock.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockSuccessMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockSuccessMembers.mdx new file mode 100644 index 000000000..441d3e311 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockSuccessMembers.mdx @@ -0,0 +1,51 @@ +--- +title: "BruteForceProtectionUnblockSuccessMembers" +description: "Represents the public interface of the Brute Force Protection Unblock Success screen. It extends the base members and includes specific properties and methods for this screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface BruteForceProtectionUnblockSuccessMembers extends BaseMembers { + /** + * Represents the screen-specific members for the brute force protection unblock success screen. + */ + screen: ScreenMembersOnBruteForceProtectionUnblockSuccess; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockSuccess">ScreenMembersOnBruteForceProtectionUnblockSuccess</a></span>} required> + Represents the screen-specific members for the brute force protection unblock success screen. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/brute-force-protection-unblock-success.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/brute-force-protection-unblock-success.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext.mdx new file mode 100644 index 000000000..c42242972 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext.mdx @@ -0,0 +1,31 @@ +--- +title: "CaptchaContext" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface CaptchaContext { + provider: string; + image?: string; + siteKey?: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="provider" type={<span>string</span>} required> +</ParamField> + +<ParamField path="image" type={<span>string</span>}> +</ParamField> + +<ParamField path="siteKey" type={<span>string</span>}> +</ParamField> + +--- + +**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext.mdx new file mode 100644 index 000000000..dc84e7db4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext.mdx @@ -0,0 +1,43 @@ +--- +title: "ClientContext" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ClientContext { + id: string; + name: string; + logo_uri?: string; + description?: string; + metadata?: { + [key: string]: string; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="id" type={<span>string</span>} required> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="logo_uri" type={<span>string</span>}> +</ParamField> + +<ParamField path="description" type={<span>string</span>}> +</ParamField> + +<ParamField path="metadata" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/models/client.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/client.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers.mdx new file mode 100644 index 000000000..bc5a94046 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers.mdx @@ -0,0 +1,41 @@ +--- +title: "ClientMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ClientMembers { + id: string; + name: string; + logoUrl: string | null; + description: string | null; + metadata: { [key: string]: string } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="id" type={<span>string</span>} required> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="logoUrl" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="description" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="metadata" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/models/client.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/client.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConditionalMediationCapable.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConditionalMediationCapable.mdx new file mode 100644 index 000000000..da1b86db6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConditionalMediationCapable.mdx @@ -0,0 +1,23 @@ +--- +title: "ConditionalMediationCapable" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ConditionalMediationCapable { + isConditionalMediationAvailable?: () => Promise<boolean>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="isConditionalMediationAvailable" type={<span>() => Promise<boolean></span>}> +</ParamField> + +--- + +**File:** [interfaces/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConfirmLogoutOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConfirmLogoutOptions.mdx new file mode 100644 index 000000000..cf39a515e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConfirmLogoutOptions.mdx @@ -0,0 +1,28 @@ +--- +title: "ConfirmLogoutOptions" +description: "Options for confirming logout" +--- + +<RequestExample> + +```typescript Interface lines +export interface ConfirmLogoutOptions extends CustomOptions { + /** The authentication transaction state */ + action: 'accept' | 'deny'; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="action" type={<span>'accept' | 'deny'</span>} required> + The authentication transaction state +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/logout.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/logout.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection.mdx new file mode 100644 index 000000000..db31070f5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection.mdx @@ -0,0 +1,31 @@ +--- +title: "Connection" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface Connection { + name: string; + strategy: string; + metadata?: Record<string, string>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="strategy" type={<span>string</span>} required> +</ParamField> + +<ParamField path="metadata" type={<span>Record<string, string></span>}> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConsentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConsentMembers.mdx new file mode 100644 index 000000000..ee4c90884 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConsentMembers.mdx @@ -0,0 +1,117 @@ +--- +title: "ConsentMembers" +description: "@interface ConsentMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface ConsentMembers extends BaseMembers { + /** + * Provides access to the specific properties and data of the Consent screen, + * including the list of `scopes` being requested and the `hideScopes` flag. + * @type {ScreenMembersOnConsent} + */ + screen: ScreenMembersOnConsent; + + /** + * Submits the user's decision to accept (grant) the requested permissions. + * This action posts to the `/u/consent` endpoint with `action: "accept"`. + * + * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs + * to be sent with the request. These parameters will be + * included in the form data submitted to the server. + * @returns {Promise<void>} A promise that resolves when the accept action is successfully submitted. + * On success, Auth0 typically redirects the user back to the application + * or to the next step in the authentication flow. + * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). + * Server-side errors (like "invalid_request") will be reflected in `this.transaction.errors` + * after the operation, rather than being thrown as JavaScript errors. + * + * @example + * ```typescript + * // Assuming 'consentManager' is an instance of the Consent screen SDK class + * try { + * await consentManager.accept(); + * // If successful, the page will typically redirect. + * } catch (error) { + * // Handle unexpected errors during the submission itself. + * console.error("Failed to submit consent acceptance:", error); + * } + * // After the await, check consentManager.transaction.errors for server-side validation issues. + * ``` + */ + accept(payload?: CustomOptions): Promise<void>; + + /** + * Submits the user's decision to deny (reject) the requested permissions. + * This action posts to the `/u/consent` endpoint with `action: "deny"`. + * + * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs + * to be sent with the request. These parameters will be + * included in the form data submitted to the server. + * @returns {Promise<void>} A promise that resolves when the deny action is successfully submitted. + * On success, Auth0 typically redirects the user, potentially showing an + * access denied message or returning an error to the application. + * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). + * Server-side errors are reflected in `this.transaction.errors`. + * + * @example + * ```typescript + * // Assuming 'consentManager' is an instance of the Consent screen SDK class + * try { + * await consentManager.deny({ reason: "user_declined" }); // Example custom option + * // If successful, the page will typically redirect. + * } catch (error) { + * console.error("Failed to submit consent denial:", error); + * } + * // After the await, check consentManager.transaction.errors for server-side validation issues. + * ``` + */ + deny(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnConsent">ScreenMembersOnConsent</a></span>} required> + Provides access to the specific properties and data of the Consent screen, including the list of `scopes` being requested and the `hideScopes` flag. +</ParamField> + +<ParamField path="accept" type={<span>Promise<void></span>} required> + Submits the user's decision to accept (grant) the requested permissions. This action posts to the `/u/consent` endpoint with `action: "accept"`. +</ParamField> + +<ParamField path="deny" type={<span>Promise<void></span>} required> + Submits the user's decision to deny (reject) the requested permissions. This action posts to the `/u/consent` endpoint with `action: "deny"`. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/consent.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/consent.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions.mdx new file mode 100644 index 000000000..95f800cbf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions.mdx @@ -0,0 +1,30 @@ +--- +title: "ContinueOptions" +description: "Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers." +--- + +<RequestExample> + +```typescript Interface lines +export interface ContinueOptions extends CustomOptions { + /** + * The OTP code entered by the user. + */ + code: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="code" type={<span>string</span>} required> + The OTP code entered by the user. +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-voice-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithCodeOptions.mdx new file mode 100644 index 000000000..ca9f124cf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithCodeOptions.mdx @@ -0,0 +1,34 @@ +--- +title: "ContinueWithCodeOptions" +description: "@interface ContinueWithCodeOptions description Options for the `continueWithCode` method on the Login Email Verification screen. This operation is used when the user submits the verification code they received via email to proceed with the authentication flow." +--- + +<RequestExample> + +```typescript Interface lines +export interface ContinueWithCodeOptions extends CustomOptions { + /** + * The verification code sent to the user's email. This is typically a short numeric + * or alphanumeric string that the user must enter into the form. + * @type {string} + * @example "123456" + * @example "ABCXYZ" + */ + code: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="code" type={<span>string</span>} required> + The verification code sent to the user's email. This is typically a short numeric or alphanumeric string that the user must enter into the form. +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-email-verification.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithOrganizationNameOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithOrganizationNameOptions.mdx new file mode 100644 index 000000000..47b2476c4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithOrganizationNameOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "ContinueWithOrganizationNameOptions" +description: "Options for continuing with the selected organization name." +--- + +<RequestExample> + +```typescript Interface lines +export interface ContinueWithOrganizationNameOptions { + /** + * The organization name. + */ + organizationName: string; + /** + * Any additional custom options. + */ + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="organizationName" type={<span>string</span>} required> + The organization name. +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> + Any additional custom options. +</ParamField> + +--- + +**File:** [interfaces/screens/organization-selection.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/organization-selection.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithPasskeyOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithPasskeyOptions.mdx new file mode 100644 index 000000000..e42ee32bf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithPasskeyOptions.mdx @@ -0,0 +1,32 @@ +--- +title: "ContinueWithPasskeyOptions" +description: "@interface ContinueWithPasskeyOptions" +--- + +<RequestExample> + +```typescript Interface lines +export interface ContinueWithPasskeyOptions extends CustomOptions { + /** + * Optional. If true, and if `screen.showRememberDevice` is also true, + * this signals the server to remember this browser for MFA for a defined period. + * @type {boolean | undefined} + */ + rememberDevice?: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="rememberDevice" type={<span>boolean</span>}> + Optional. If true, and if `screen.showRememberDevice` is also true, this signals the server to remember this browser for MFA for a defined period. +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode.mdx new file mode 100644 index 000000000..bcd77b0dd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode.mdx @@ -0,0 +1,27 @@ +--- +title: "CountryCode" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +interface CountryCode { + code: string; + prefix: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="code" type={<span>string</span>} required> +</ParamField> + +<ParamField path="prefix" type={<span>string</span>} required> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CredentialResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CredentialResponse.mdx new file mode 100644 index 000000000..715641108 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CredentialResponse.mdx @@ -0,0 +1,31 @@ +--- +title: "CredentialResponse" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface CredentialResponse { + clientDataJSON: string | null; + attestationObject: string | null; + transports?: string[]; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="clientDataJSON" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="attestationObject" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="transports" type={<span>string[]</span>}> +</ParamField> + +--- + +**File:** [interfaces/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CurrentScreenOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CurrentScreenOptions.mdx new file mode 100644 index 000000000..dbb5041ac --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CurrentScreenOptions.mdx @@ -0,0 +1,101 @@ +--- +title: "CurrentScreenOptions" +description: "CurrentScreenOptions details." +--- + +<RequestExample> + +```typescript Interface lines +export interface CurrentScreenOptions { + client: { + id: string; + metadata: Record<string, string> | null; + } | null; + organization: { + id: string; + metadata: Record<string, string> | null; + } | null; + prompt: { + name: string; + } | null; + screen: { + name: string; + } | null; + tenant: { + enabledLocales: string[]; + } | null; + transaction: { + errors: TransactionError[] | null; + state: string; + locale: string; + } | null; + untrustedData: { + authorizationParams: Record<string, string> | null; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="client" type="object"> + <Expandable title="properties"> + <ParamField path="id" type={<span>string</span>} required> + </ParamField> + <ParamField path="metadata" type={<span>Record<string, string> | null</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="organization" type="object"> + <Expandable title="properties"> + <ParamField path="id" type={<span>string</span>} required> + </ParamField> + <ParamField path="metadata" type={<span>Record<string, string> | null</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="prompt" type="object"> + <Expandable title="properties"> + <ParamField path="name" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="screen" type="object"> + <Expandable title="properties"> + <ParamField path="name" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="tenant" type="object"> + <Expandable title="properties"> + <ParamField path="enabledLocales" type={<span>string[]</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="transaction" type="object"> + <Expandable title="properties"> + <ParamField path="errors" type={<span>TransactionError[] | null</span>}> + </ParamField> + <ParamField path="state" type={<span>string</span>} required> + </ParamField> + <ParamField path="locale" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="untrustedData" type="object"> + <Expandable title="properties"> + <ParamField path="authorizationParams" type={<span>Record<string, string> | null</span>}> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/common/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/common/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions.mdx new file mode 100644 index 000000000..09837165f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "CustomOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface CustomOptions { + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/common/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/common/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomizedConsentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomizedConsentMembers.mdx new file mode 100644 index 000000000..d1fef6859 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomizedConsentMembers.mdx @@ -0,0 +1,119 @@ +--- +title: "CustomizedConsentMembers" +description: "@interface CustomizedConsentMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface CustomizedConsentMembers extends BaseMembers { + /** + * Provides access to the specific properties and data of the Customized Consent screen, + * including the list of `scopes` and `authorizationDetails` being requested. + * @type {ScreenMembersOnCustomizedConsent} + */ + screen: ScreenMembersOnCustomizedConsent; + + /** + * Submits the user's decision to accept (grant) the requested permissions and authorization details. + * This action posts to the `/u/customized-consent` endpoint with `action: "accept"`. + * The transaction state is automatically included. + * + * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs + * to be sent with the request. These parameters will be + * included in the form data submitted to the server. + * @returns {Promise<void>} A promise that resolves when the accept action is successfully submitted. + * On success, Auth0 typically redirects the user back to the application + * or to the next step in the authentication flow. + * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). + * Server-side errors (like "invalid_request") will be reflected in `this.transaction.errors` + * after the operation, rather than being thrown as JavaScript errors. + * + * @example + * ```typescript + * // Assuming 'customizedConsentManager' is an instance of the CustomizedConsent SDK class + * try { + * await customizedConsentManager.accept(); + * // If successful, the page will typically redirect. + * } catch (error) { + * // Handle unexpected errors during the submission itself. + * console.error("Failed to submit consent acceptance:", error); + * } + * // After the await, check customizedConsentManager.transaction.errors for server-side validation issues. + * ``` + */ + accept(payload?: CustomOptions): Promise<void>; + + /** + * Submits the user's decision to deny (reject) the requested permissions and authorization details. + * This action posts to the `/u/customized-consent` endpoint with `action: "deny"`. + * The transaction state is automatically included. + * + * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs + * to be sent with the request. These parameters will be + * included in the form data submitted to the server. + * @returns {Promise<void>} A promise that resolves when the deny action is successfully submitted. + * On success, Auth0 typically redirects the user, potentially showing an + * access denied message or returning an error to the application. + * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). + * Server-side errors are reflected in `this.transaction.errors`. + * + * @example + * ```typescript + * // Assuming 'customizedConsentManager' is an instance of the CustomizedConsent SDK class + * try { + * await customizedConsentManager.deny({ reason_code: "user_rejected_details" }); // Example custom option + * // If successful, the page will typically redirect. + * } catch (error) { + * console.error("Failed to submit consent denial:", error); + * } + * // After the await, check customizedConsentManager.transaction.errors for server-side validation issues. + * ``` + */ + deny(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnCustomizedConsent">ScreenMembersOnCustomizedConsent</a></span>} required> + Provides access to the specific properties and data of the Customized Consent screen, including the list of `scopes` and `authorizationDetails` being requested. +</ParamField> + +<ParamField path="accept" type={<span>Promise<void></span>} required> + Submits the user's decision to accept (grant) the requested permissions and authorization details. This action posts to the `/u/customized-consent` endpoint with `action: "accept"`. The transaction state is automatically included. +</ParamField> + +<ParamField path="deny" type={<span>Promise<void></span>} required> + Submits the user's decision to deny (reject) the requested permissions and authorization details. This action posts to the `/u/customized-consent` endpoint with `action: "deny"`. The transaction state is automatically included. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/customized-consent.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/customized-consent.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection.mdx new file mode 100644 index 000000000..cfb6316cb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection.mdx @@ -0,0 +1,164 @@ +--- +title: "DBConnection" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface DBConnection extends Connection { + options: { + signup_enabled: boolean; + flexible_identifiers_active?: boolean; + forgot_password_enabled: boolean; + username_required?: boolean; + validation?: { + username: { + max_length: number; + min_length: number; + }; + }; + attributes?: { + email?: { + signup_status: string; + identifier_active: boolean; + }; + username?: { + signup_status: string; + identifier_active: boolean; + validation?: { + max_length: number; + min_length: number; + allowed_types: { + email: boolean; + phone_number: boolean; + }; + }; + }; + phone?: { + signup_status: string; + identifier_active: boolean; + }; + }; + authentication_methods: { + password: { + enabled: boolean; + policy: string; + min_length: number; + password_security_info?: PasswordComplexityRule[]; + }; + passkey: { + enabled: boolean; + }; + }; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="options" type="object" required> + <Expandable title="properties"> + <ParamField path="signup_enabled" type={<span>boolean</span>} required> + </ParamField> + <ParamField path="flexible_identifiers_active" type={<span>boolean</span>}> + </ParamField> + <ParamField path="forgot_password_enabled" type={<span>boolean</span>} required> + </ParamField> + <ParamField path="username_required" type={<span>boolean</span>}> + </ParamField> + <ParamField path="validation" type="object"> + <Expandable title="properties"> + <ParamField path="username" type="object" required> + <Expandable title="properties"> + <ParamField path="max_length" type={<span>number</span>} required> + </ParamField> + <ParamField path="min_length" type={<span>number</span>} required> + </ParamField> + </Expandable> + </ParamField> + </Expandable> + </ParamField> + <ParamField path="attributes" type="object"> + <Expandable title="properties"> + <ParamField path="email" type="object"> + <Expandable title="properties"> + <ParamField path="signup_status" type={<span>string</span>} required> + </ParamField> + <ParamField path="identifier_active" type={<span>boolean</span>} required> + </ParamField> + </Expandable> + </ParamField> + <ParamField path="username" type="object"> + <Expandable title="properties"> + <ParamField path="signup_status" type={<span>string</span>} required> + </ParamField> + <ParamField path="identifier_active" type={<span>boolean</span>} required> + </ParamField> + <ParamField path="validation" type="object"> + <Expandable title="properties"> + <ParamField path="max_length" type={<span>number</span>} required> + </ParamField> + <ParamField path="min_length" type={<span>number</span>} required> + </ParamField> + <ParamField path="allowed_types" type="object" required> + <Expandable title="properties"> + <ParamField path="email" type={<span>boolean</span>} required> + </ParamField> + <ParamField path="phone_number" type={<span>boolean</span>} required> + </ParamField> + </Expandable> + </ParamField> + </Expandable> + </ParamField> + </Expandable> + </ParamField> + <ParamField path="phone" type="object"> + <Expandable title="properties"> + <ParamField path="signup_status" type={<span>string</span>} required> + </ParamField> + <ParamField path="identifier_active" type={<span>boolean</span>} required> + </ParamField> + </Expandable> + </ParamField> + </Expandable> + </ParamField> + <ParamField path="authentication_methods" type="object" required> + <Expandable title="properties"> + <ParamField path="password" type="object" required> + <Expandable title="properties"> + <ParamField path="enabled" type={<span>boolean</span>} required> + </ParamField> + <ParamField path="policy" type={<span>string</span>} required> + </ParamField> + <ParamField path="min_length" type={<span>number</span>} required> + </ParamField> + <ParamField path="password_security_info" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule">PasswordComplexityRule[]</a></span>}> + </ParamField> + </Expandable> + </ParamField> + <ParamField path="passkey" type="object" required> + <Expandable title="properties"> + <ParamField path="enabled" type={<span>boolean</span>} required> + </ParamField> + </Expandable> + </ParamField> + </Expandable> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="strategy" type={<span>string</span>} required> +</ParamField> + +<ParamField path="metadata" type={<span>Record<string, string></span>}> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationAllowedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationAllowedMembers.mdx new file mode 100644 index 000000000..c7809dec6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationAllowedMembers.mdx @@ -0,0 +1,45 @@ +--- +title: "DeviceCodeActivationAllowedMembers" +description: "Interface describing the members of the Device Code Activation Allowed screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface DeviceCodeActivationAllowedMembers extends BaseMembers {} +``` + +</RequestExample> + +## Properties + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/device-code-activation-allowed.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/device-code-activation-allowed.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationDeniedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationDeniedMembers.mdx new file mode 100644 index 000000000..efc89a450 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationDeniedMembers.mdx @@ -0,0 +1,45 @@ +--- +title: "DeviceCodeActivationDeniedMembers" +description: "Interface describing the members of the Device Code Activation Denied screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface DeviceCodeActivationDeniedMembers extends BaseMembers {} +``` + +</RequestExample> + +## Properties + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/device-code-activation-denied.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/device-code-activation-denied.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationMembers.mdx new file mode 100644 index 000000000..aa2867360 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationMembers.mdx @@ -0,0 +1,61 @@ +--- +title: "DeviceCodeActivationMembers" +description: "Interface describing the members of the Device Code Activation screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface DeviceCodeActivationMembers extends BaseMembers { + /** + * Submits the device code entered by the user. + * This action is triggered when the user enters the code displayed on their device and submits the form. + * + * @param {object} payload - An object containing the code entered by the user and any custom payload. + * @param {string} payload.code - The device code entered by the user. + * + * @returns {Promise<void>} A promise that resolves when the code is successfully submitted. + * Rejects with an error if the submission fails. + */ + continue(payload: ContinueOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Submits the device code entered by the user. This action is triggered when the user enters the code displayed on their device and submits the form. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/device-code-activation.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/device-code-activation.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeConfirmationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeConfirmationMembers.mdx new file mode 100644 index 000000000..7816c9e8e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeConfirmationMembers.mdx @@ -0,0 +1,67 @@ +--- +title: "DeviceCodeConfirmationMembers" +description: "Interface describing the members of the Device Code Confirmation screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface DeviceCodeConfirmationMembers extends BaseMembers { + screen: ScreenMembersOnDeviceCodeConfirmation; + + /** + * Confirms the device code. + * @param payload Optional custom options to include with the request. + */ + confirm(payload?: CustomOptions): Promise<void>; + + /** + * Cancels the device code flow. + * @param payload Optional custom options to include with the request. + */ + cancel(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnDeviceCodeConfirmation">ScreenMembersOnDeviceCodeConfirmation</a></span>} required> +</ParamField> + +<ParamField path="confirm" type={<span>Promise<void></span>} required> + Confirms the device code. +</ParamField> + +<ParamField path="cancel" type={<span>Promise<void></span>} required> + Cancels the device code flow. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/device-code-confirmation.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailChallengeOptions.mdx new file mode 100644 index 000000000..9f212391a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailChallengeOptions.mdx @@ -0,0 +1,31 @@ +--- +title: "EmailChallengeOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface EmailChallengeOptions { + code: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="code" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captcha" type={<span>string</span>}> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/email-identifier-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailIdentifierChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailIdentifierChallengeMembers.mdx new file mode 100644 index 000000000..c1d9a9b7f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailIdentifierChallengeMembers.mdx @@ -0,0 +1,63 @@ +--- +title: "EmailIdentifierChallengeMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface EmailIdentifierChallengeMembers extends BaseMembers { + screen: ScreenMembersOnEmailIdentifierChallenge; + submitEmailChallenge(payload: EmailChallengeOptions): Promise<void>; + resendCode(payload?: CustomOptions): Promise<void>; + resendManager(payload?: StartResendOptions): ResendControl; + returnToPrevious(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailIdentifierChallenge">ScreenMembersOnEmailIdentifierChallenge</a></span>} required> +</ParamField> + +<ParamField path="submitEmailChallenge" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="resendCode" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> +</ParamField> + +<ParamField path="returnToPrevious" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/email-identifier-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailOTPChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailOTPChallengeMembers.mdx new file mode 100644 index 000000000..b35e0b0c0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailOTPChallengeMembers.mdx @@ -0,0 +1,74 @@ +--- +title: "EmailOTPChallengeMembers" +description: "Represents the Email OTP Challenge screen interface." +--- + +<RequestExample> + +```typescript Interface lines +export interface EmailOTPChallengeMembers extends BaseMembers { + screen: ScreenMembersOnEmailOTPChallenge; + /** + * Submits the OTP code entered by the user. + * @param options Optional parameters to include in the submission. + */ + submitCode(options: OtpCodeOptions): Promise<void>; + /** + * Requests a new OTP code to be sent to the user's email. + * @param options Optional parameters to include in the resend request. + */ + resendCode(options?: CustomOptions): Promise<void>; + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailOTPChallenge">ScreenMembersOnEmailOTPChallenge</a></span>} required> +</ParamField> + +<ParamField path="submitCode" type={<span>Promise<void></span>} required> + Submits the OTP code entered by the user. +</ParamField> + +<ParamField path="resendCode" type={<span>Promise<void></span>} required> + Requests a new OTP code to be sent to the user's email. +</ParamField> + +<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> + Gets resend functionality with timeout management for this screen +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/email-otp-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailVerificationResultMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailVerificationResultMembers.mdx new file mode 100644 index 000000000..d6881fbc5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailVerificationResultMembers.mdx @@ -0,0 +1,53 @@ +--- +title: "EmailVerificationResultMembers" +description: "@interface EmailVerificationResultMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface EmailVerificationResultMembers extends BaseMembers { + /** + * Provides access to the specific properties and data of the Email Verification Result screen, + * including the verification `status` and the `login` link. + * @type {ScreenMembersOnEmailVerificationResult} + */ + screen: ScreenMembersOnEmailVerificationResult; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailVerificationResult">ScreenMembersOnEmailVerificationResult</a></span>} required> + Provides access to the specific properties and data of the Email Verification Result screen, including the verification `status` and the `login` link. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/email-verification-result.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice.mdx new file mode 100644 index 000000000..e1f7d734f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice.mdx @@ -0,0 +1,27 @@ +--- +title: "EnrolledDevice" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface EnrolledDevice { + id: number; + device: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="id" type={<span>number</span>} required> +</ParamField> + +<ParamField path="device" type={<span>string</span>} required> +</ParamField> + +--- + +**File:** [interfaces/models/user.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/user.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail.mdx new file mode 100644 index 000000000..21e8228b6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail.mdx @@ -0,0 +1,27 @@ +--- +title: "EnrolledEmail" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface EnrolledEmail { + id: number; + email: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="id" type={<span>number</span>} required> +</ParamField> + +<ParamField path="email" type={<span>string</span>} required> +</ParamField> + +--- + +**File:** [interfaces/models/user.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/user.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber.mdx new file mode 100644 index 000000000..24643e0fe --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber.mdx @@ -0,0 +1,27 @@ +--- +title: "EnrolledPhoneNumber" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface EnrolledPhoneNumber { + id: number; + phoneNumber: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="id" type={<span>number</span>} required> +</ParamField> + +<ParamField path="phoneNumber" type={<span>string</span>} required> +</ParamField> + +--- + +**File:** [interfaces/models/user.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/user.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection.mdx new file mode 100644 index 000000000..37c81c70f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection.mdx @@ -0,0 +1,44 @@ +--- +title: "EnterpriseConnection" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface EnterpriseConnection extends Connection { + options: { + iconUrl?: string; + displayName?: string; + showAsButton: boolean; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="options" type="object" required> + <Expandable title="properties"> + <ParamField path="iconUrl" type={<span>string</span>}> + </ParamField> + <ParamField path="displayName" type={<span>string</span>}> + </ParamField> + <ParamField path="showAsButton" type={<span>boolean</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="strategy" type={<span>string</span>} required> +</ParamField> + +<ParamField path="metadata" type={<span>Record<string, string></span>}> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext.mdx new file mode 100644 index 000000000..4573627a9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext.mdx @@ -0,0 +1,44 @@ +--- +title: "EnterpriseConnectionContext" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface EnterpriseConnectionContext extends Connection { + options: { + icon_url?: string; + display_name?: string; + show_as_button: boolean; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="options" type="object" required> + <Expandable title="properties"> + <ParamField path="icon_url" type={<span>string</span>}> + </ParamField> + <ParamField path="display_name" type={<span>string</span>}> + </ParamField> + <ParamField path="show_as_button" type={<span>boolean</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="strategy" type={<span>string</span>} required> +</ParamField> + +<ParamField path="metadata" type={<span>Record<string, string></span>}> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error.mdx new file mode 100644 index 000000000..a35660b3a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error.mdx @@ -0,0 +1,35 @@ +--- +title: "Error" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface Error { + code: string; + field?: string; + message: string; + rules?: PasswordComplexityRule[]; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="code" type={<span>string</span>} required> +</ParamField> + +<ParamField path="field" type={<span>string</span>}> +</ParamField> + +<ParamField path="message" type={<span>string</span>} required> +</ParamField> + +<ParamField path="rules" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule">PasswordComplexityRule[]</a></span>}> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext.mdx new file mode 100644 index 000000000..2e8c37e81 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext.mdx @@ -0,0 +1,41 @@ +--- +title: "ExtendedScreenContext" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +interface ExtendedScreenContext extends ScreenContext { + links: { + login: string; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="links" type="object" required> + <Expandable title="properties"> + <ParamField path="login" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a></span>}> +</ParamField> + +<ParamField path="data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData">ScreenData</a></span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string></span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/signup-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext.mdx new file mode 100644 index 000000000..dff5e9cfe --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext.mdx @@ -0,0 +1,46 @@ +--- +title: "ExtendedUntrustedDataContext" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +interface ExtendedUntrustedDataContext extends UntrustedDataContext { + submitted_form_data?: { + /* this object is opt-in */ + email?: string; + phone?: string; + username?: string; + [key: string]: string | undefined; // keys like "ulp_xxx" are allowed + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="submitted_form_data" type="object"> + <Expandable title="properties"> + <ParamField path="phone" type={<span>string</span>}> + </ParamField> + <ParamField path="username" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="authorization_params" type="object"> + <Expandable title="properties"> + <ParamField path="login_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="screen_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="ui_locales" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/screens/signup-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions.mdx new file mode 100644 index 000000000..e99e1b0f4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions.mdx @@ -0,0 +1,31 @@ +--- +title: "FederatedLoginOptions" +description: "Options for performing social login operations" +--- + +<RequestExample> + +```typescript Interface lines +export interface FederatedLoginOptions { + /** The social connection name to use */ + connection: string; + /** Any additional custom options */ + [key: string]: string | number | boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="connection" type={<span>string</span>} required> + The social connection name to use +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean</span>} required> + Any additional custom options +</ParamField> + +--- + +**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions.mdx new file mode 100644 index 000000000..547259757 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "FederatedSignupOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface FederatedSignupOptions { + connection: string; + [key: string]: string | number | boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="connection" type={<span>string</span>} required> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean</span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/signup.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FlattenedTheme.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FlattenedTheme.mdx new file mode 100644 index 000000000..262e33dbc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FlattenedTheme.mdx @@ -0,0 +1,39 @@ +--- +title: "FlattenedTheme" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface FlattenedTheme { + colors: Record<string, string>; + fonts: Record<string, string | number | boolean | object>; + borders: Record<string, string | number | boolean>; + pageBackground: Record<string, string>; + widget: Record<string, string | number>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="colors" type={<span>Record<string, string></span>} required> +</ParamField> + +<ParamField path="fonts" type={<span>Record<string, string | number | boolean | object></span>} required> +</ParamField> + +<ParamField path="borders" type={<span>Record<string, string | number | boolean></span>} required> +</ParamField> + +<ParamField path="pageBackground" type={<span>Record<string, string></span>} required> +</ParamField> + +<ParamField path="widget" type={<span>Record<string, string | number></span>} required> +</ParamField> + +--- + +**File:** [interfaces/common/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/common/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FormOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FormOptions.mdx new file mode 100644 index 000000000..838c5416f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FormOptions.mdx @@ -0,0 +1,39 @@ +--- +title: "FormOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface FormOptions { + state: string; + telemetry: Array<string>; + useBrowserCapabilities?: boolean; + route?: string; + [key: string]: string | number | boolean | null | undefined | Array<string>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="telemetry" type={<span>Array<string></span>} required> +</ParamField> + +<ParamField path="useBrowserCapabilities" type={<span>boolean</span>}> +</ParamField> + +<ParamField path="route" type={<span>string</span>}> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | null | undefined | Array<string></span>}> +</ParamField> + +--- + +**File:** [interfaces/utils/form-handler.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/form-handler.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier.mdx new file mode 100644 index 000000000..d24a59f9f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier.mdx @@ -0,0 +1,38 @@ +--- +title: "Identifier" +description: "Describes a configured identifier field (e.g. email, phone, or username) for use in a signup form or authentication flow." +--- + +<RequestExample> + +```typescript Interface lines +export interface Identifier { + /** + * The type of identifier, such as `'email'`, `'phone'`, or `'username'`. + * + * @see IdentifierType + */ + type: IdentifierType; + + /** + * Whether this identifier is required for signup. + */ + required: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="type" type={<span>IdentifierType</span>} required> + The type of identifier, such as `'email'`, `'phone'`, or `'username'`. +</ParamField> + +<ParamField path="required" type={<span>boolean</span>} required> + Whether this identifier is required for signup. +</ParamField> + +--- + +**File:** [interfaces/utils/signup-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/InterstitialCaptchaMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/InterstitialCaptchaMembers.mdx new file mode 100644 index 000000000..96265b6f8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/InterstitialCaptchaMembers.mdx @@ -0,0 +1,50 @@ +--- +title: "InterstitialCaptchaMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface InterstitialCaptchaMembers extends BaseMembers { + submitCaptcha: (payload: SubmitCaptchaOptions) => void; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="submitCaptcha" type={<span>(payload: <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCaptchaOptions">SubmitCaptchaOptions</a>) => void</span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/interstitial-captcha.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Login.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Login.mdx new file mode 100644 index 000000000..dec91fc21 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Login.mdx @@ -0,0 +1,233 @@ +--- +title: "Login" +description: "Login screen interface extending base context" +--- + +<RequestExample> + +```typescript Interface lines +export interface Login extends BaseContext { + screen: ScreenContextOnLogin; + transaction: TransactionContextOnLogin; +} +``` + +```typescript Basic Login with Username/Password +import Login from '@auth0/auth0-acul-js/login'; + +const loginManager = new Login(); + +// Handle form submission and error handling +const errors = loginManager.getErrors(); +const handleSubmit = async (e: React.FormEvent) => { + e.preventDefault(); + + try { + await loginManager.login({ + username: 'user@example.com', + password: 'myPassword123' + }); + } catch (error) { + console.error('Login failed:', error); + } +}; + +return ( + <div> + {/* Render the login ID screen content */} + <button onclick={handleLogin}>Continue<button> + {loginIdManager.transaction.hasErrors && errors && ( + // A custom React component that renders a <div> with error details + <ErrorMessages errors={errors} /> + )} + ) +``` + +```typescript Login with Social Provider +import Login from '@auth0/auth0-acul-js/login'; + +const loginManager = new Login(); + +// Handle social login +const handleSocialLogin = async (connection: string) => { + try { + await loginManager.federatedLogin({ + connection: connection // e.g. 'google-oauth2' + }); + } catch (error) { + console.error('Social login failed:', error); + } +}; +``` + +```tsx React Component Example with TailwindCSS +import React, { useState } from 'react'; +import Login from '@auth0/auth0-acul-js/login'; + +const LoginScreen: React.FC = () => { + const [username, setUsername] = useState(''); + const [password, setPassword] = useState(''); + const [error, setError] = useState(''); + + const loginManager = new Login(); + const { transaction } = loginManager; + const activeIdentifiers = useMemo(() => loginManager.getActiveIdentifiers(), []); + + const getIdentifierLabel = () => { + if (activeIdentifiers?.length === 1) return `Enter your ${activeIdentifiers[0]}`; + return `Enter your ${activeIdentifiers?.join(" or ")}`; + }; + + const handleSubmit = async (e: React.FormEvent) => { + e.preventDefault(); + setError(''); + + try { + await loginManager.login({ + username, + password + }); + } catch (error) { + setError('Login failed. Please check your credentials.'); + } + }; + + const handleSocialLogin = async (connection: string) => { + try { + await loginManager.federatedLogin({ connection }); + } catch (error) { + setError('Social login failed. Please try again.'); + } + }; + + return ( + <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> + <div className="sm:mx-auto sm:w-full sm:max-w-md"> + <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> + Sign in to your account + </h2> + </div> + + <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> + <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> + <form className="space-y-6" onSubmit={handleSubmit}> + <div> + <label htmlFor="username" className="block text-sm font-medium text-gray-700"> + {getIdentifierLabel()} + </label> + <div className="mt-1"> + <input + id="username" + name="username" + type="text" + required + value={username} + onChange={(e) => setUsername(e.target.value)} + placeholder= {getIdentifierLabel()} + className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> + </div> + </div> + + <div> + <label htmlFor="password" className="block text-sm font-medium text-gray-700"> + Password + </label> + <div className="mt-1"> + <input + id="password" + name="password" + type="password" + required + value={password} + onChange={(e) => setPassword(e.target.value)} + className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" + /> + </div> + </div> + + {error && ( + <div className="text-red-600 text-sm"> + {error} + </div> + )} + + <div> + <button + type="submit" + className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" + > + Sign in + </button> + </div> + </form> + + {transaction.alternateConnections && transaction.alternateConnections.length > 0 && ( + <div className="mt-6"> + <div className="relative"> + <div className="absolute inset-0 flex items-center"> + <div className="w-full border-t border-gray-300" /> + </div> + <div className="relative flex justify-center text-sm"> + <span className="px-2 bg-white text-gray-500"> + Or continue with + </span> + </div> + </div> + + <div className="mt-6 grid grid-cols-3 gap-3"> + {transaction.alternateConnections.map((connection) => ( + <button + key={connection.name} + onClick={() => handleSocialLogin(connection.name)} + className="w-full inline-flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm bg-white text-sm font-medium text-gray-500 hover:bg-gray-50" + > + {connection.name} + </button> + ))} + </div> + </div> + )} + </div> + </div> + </div> + ); +}; + +export default LoginScreen; +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLogin">ScreenContextOnLogin</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLogin">TransactionContextOnLogin</a></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> +</ParamField> + +<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEmailVerificationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEmailVerificationMembers.mdx new file mode 100644 index 000000000..6e44163f6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEmailVerificationMembers.mdx @@ -0,0 +1,149 @@ +--- +title: "LoginEmailVerificationMembers" +description: "@interface LoginEmailVerificationMembers description Defines the members (properties and methods) available for interacting with the Login Email Verification screen. This screen is a crucial part of email verification processes, typically during login, where a user must prove ownership of an email address by providing a one-time code. The SDK facilitates submitting this code or requesting a new one. The `universal_login_context` for this screen (`window.universal_login_context`) will contain: - `client`: Information about the Auth0 application. - `organization` (optional): Details if the authentication is for a specific organization. - `prompt`: Context of the current authentication prompt (e.g., 'login'). - `screen`: UI texts and general screen information. No screen-specific `data` fields are uniquely defined for `login-email-verification` beyond standard ones. - `transaction`: Details of the ongoing transaction, including state and any errors from previous attempts (e.g., \"invalid-code\")." +--- + +<RequestExample> + +```typescript Interface lines +export interface LoginEmailVerificationMembers extends BaseMembers { + /** + * Submits the email verification code entered by the user. + * This action corresponds to the user entering the code they received via email and + * clicking a "Continue" or "Verify" button. The SDK will then POST this code + * to the Auth0 `/u/login-email-verification` endpoint. + * + * If the code is valid, Auth0 will typically redirect the user to the next step in the + * authentication flow. If the code is invalid, expired, or another error occurs, + * Auth0 will usually re-render the login-email-verification screen, and the + * `transaction.errors` array in the SDK's context will be updated with details + * about the failure (e.g., error code `invalid-code`). + * + * @param {ContinueWithCodeOptions} payload - An object containing the `code` string entered by the user. + * It can also include any `CustomOptions` for extensibility. + * @returns {Promise<void>} A promise that resolves when the form submission is initiated. + * It does not return data directly upon resolution, as a redirect or + * page re-render is the common outcome. + * @throws {Error} Throws an error if `payload.code` is not provided or is not a string, + * or if the `FormHandler` encounters an unrecoverable issue during submission (e.g., network error). + * Validation errors from Auth0 (like an invalid code) are not thrown as JavaScript errors + * but are reflected in `this.transaction.errors` after the operation. + * + * @example + * ```typescript + * // Assuming 'manager' is an instance of LoginEmailVerification + * const userInputCode = "123456"; + * try { + * await manager.continueWithCode({ code: userInputCode }); + * // If successful, page redirects. No further client-side action needed here. + * } catch (error) { + * // This catch is for unexpected errors, not for Auth0 validation errors. + * console.error("Failed to submit the verification code:", error); + * } + * // After the await, always check manager.transaction.errors for server-side validation issues. + * if (manager.transaction.errors && manager.transaction.errors.length > 0) { + * manager.transaction.errors.forEach(err => { + * if (err.code === 'invalid-code') { + * // Display "The code you entered is invalid" to the user. + * } + * }); + * } + * ``` + */ + continueWithCode(payload: ContinueWithCodeOptions): Promise<void>; + + /** + * Requests a new verification code to be sent to the user's email address. + * This action is typically invoked when the user clicks a "Resend Code" button, perhaps because + * they didn't receive the first email, the code expired, or they suspect an issue. + * The SDK will POST to the Auth0 `/u/login-email-verification` endpoint with an action indicating + * a resend request. + * + * Upon successful submission of this request, Auth0 attempts to send a new email. + * The page may re-render. If there are issues (e.g., too many resend attempts for the same email, + * identified by error code `too-many-emails`), `transaction.errors` will be updated. + * + * @param {ResendCodeOptions} [payload] - Optional. An object for `CustomOptions` if any + * additional parameters need to be sent with the request. + * @returns {Promise<void>} A promise that resolves when the resend request is initiated. + * Like `continueWithCode`, this usually results in a page re-render or state update + * rather than direct data in the promise resolution. + * @throws {Error} Throws if the `FormHandler` encounters an unrecoverable issue (e.g., network error). + * Server-side errors (like rate limits) are reflected in `this.transaction.errors`. + * + * @example + * ```typescript + * // Assuming 'manager' is an instance of LoginEmailVerification + * try { + * await manager.resendCode(); + * // Optionally, update UI to inform the user a new code has been sent. + * alert("A new verification code has been dispatched to your email."); + * } catch (error) { + * console.error("Failed to request a new code:", error); + * } + * // After the await, check manager.transaction.errors for server-side issues. + * if (manager.transaction.errors && manager.transaction.errors.length > 0) { + * manager.transaction.errors.forEach(err => { + * if (err.code === 'too-many-emails') { + * // Display "You have requested too many emails. Please wait a few minutes." + * } + * }); + * } + * ``` + */ + resendCode(payload?: ResendCodeOptions): Promise<void>; + + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="continueWithCode" type={<span>Promise<void></span>} required> + Submits the email verification code entered by the user. This action corresponds to the user entering the code they received via email and clicking a "Continue" or "Verify" button. The SDK will then POST this code to the Auth0 `/u/login-email-verification` endpoint. If the code is valid, Auth0 will typically redirect the user to the next step in the authentication flow. If the code is invalid, expired, or another error occurs, Auth0 will usually re-render the login-email-verification screen, and the `transaction.errors` array in the SDK's context will be updated with details about the failure (e.g., error code `invalid-code`). +</ParamField> + +<ParamField path="resendCode" type={<span>Promise<void></span>} required> + Requests a new verification code to be sent to the user's email address. This action is typically invoked when the user clicks a "Resend Code" button, perhaps because they didn't receive the first email, the code expired, or they suspect an issue. The SDK will POST to the Auth0 `/u/login-email-verification` endpoint with an action indicating a resend request. Upon successful submission of this request, Auth0 attempts to send a new email. The page may re-render. If there are issues (e.g., too many resend attempts for the same email, identified by error code `too-many-emails`), `transaction.errors` will be updated. +</ParamField> + +<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> + Gets resend functionality with timeout management for this screen +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/login-email-verification.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEnrollOptions.mdx new file mode 100644 index 000000000..72e01047a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEnrollOptions.mdx @@ -0,0 +1,31 @@ +--- +title: "LoginEnrollOptions" +description: "Options for continuing with a selected MFA factor" +--- + +<RequestExample> + +```typescript Interface lines +export interface LoginEnrollOptions { + /** The action indicating which factor to use for login */ + action: MfaLoginFactorType; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="action" type={<span>MfaLoginFactorType</span>} required> + The action indicating which factor to use for login +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> + Any additional custom options +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-login-options.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginId.mdx new file mode 100644 index 000000000..543f08eac --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginId.mdx @@ -0,0 +1,118 @@ +--- +title: "LoginId" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface LoginId extends BaseContext { + screen: ExtendedScreenContext; + untrustedData?: ExtendedUntrustedDataContext; +} +``` + +```typescript login +import LoginId from "@auth0/auth0-acul-js/login-id" + +const loginIdManager = new LoginId(); + +loginIdManager.login({ + username: "testUser" +}) +``` + +```typescript error handling +import LoginId from "@auth0/auth0-acul-js/login-id" + +const loginIdManager = new LoginId(); +const errors = loginIdManager.getErrors(); + +loginIdManager.login({ + username: "testUser" +}) + +return ( + <div> + {/* Render the login ID screen content */} + <button onclick={handleLogin}>Continue<button> + {loginIdManager.transaction.hasErrors && errors && ( + // A custom React component that renders a <div> with error details + <ErrorMessages errors={errors} /> + )} +) +``` + +```typescript federatedLogin +import LoginId from "@auth0/auth0-acul-js/login-id"; +const loginIdManager = new LoginId(); + +// Check if alternateConnections is available and has at least one item +if (!loginIdManager.transaction.alternateConnections) { + console.error('No alternate connections available.'); +} + +// Select the first available connection (users can select any available connection) +const selectedConnection = alternateConnections[0]; + +// Log the chosen connection for debugging or informational purposes +console.log(`Selected connection: ${selectedConnection.name}`); + +// Proceed with federated login using the selected connection +loginIdManager.federatedLogin({ + connection: selectedConnection.name, +}) +``` + +```typescript passkeyLogin +import LoginId from "@auth0/auth0-acul-js/login-id"; +const loginIdManager = new LoginId(); + +// it internally maps users available passkey config provided from auth0 server +loginIdManager.passkeyLogin(); +``` + +```typescript pickCountryCode +import LoginId from "@auth0/auth0-acul-js/login-id"; +const loginIdManager = new LoginId(); + +loginIdManager.pickCountryCode(); +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext">ExtendedScreenContext</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext">ExtendedUntrustedDataContext</a></span>}> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> +</ParamField> + +<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginIdMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginIdMembers.mdx new file mode 100644 index 000000000..d2ec6b97e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginIdMembers.mdx @@ -0,0 +1,68 @@ +--- +title: "LoginIdMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface LoginIdMembers extends BaseMembers { + screen: ScreenMembersOnLoginId; + transaction: TransactionMembersOnLoginId; + login(payload: LoginOptions): Promise<void>; + federatedLogin(payload: FederatedLoginOptions): Promise<void>; + passkeyLogin(payload?: CustomOptions): Promise<void>; + pickCountryCode(payload?: CustomOptions): Promise<void>; + getLoginIdentifiers(): IdentifierType[] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginId">ScreenMembersOnLoginId</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId">TransactionMembersOnLoginId</a></span>} required> +</ParamField> + +<ParamField path="login" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="federatedLogin" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="passkeyLogin" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="pickCountryCode" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="getLoginIdentifiers" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/login-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginMembers.mdx new file mode 100644 index 000000000..4fb07600a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginMembers.mdx @@ -0,0 +1,85 @@ +--- +title: "LoginMembers" +description: "Login screen members interface extending base members" +--- + +<RequestExample> + +```typescript Interface lines +export interface LoginMembers extends BaseMembers { + screen: ScreenMembersOnLogin; + transaction: TransactionMembersOnLogin; + /** + * Performs login with username/password + * @param payload The login options + */ + login(payload: LoginOptions): Promise<void>; + /** + * Performs login with social provider + * @param payload The social login options + */ + federatedLogin(payload: FederatedLoginOptions): Promise<void>; + /** + * Picks country code for phone number input + * @param payload Optional custom options + */ + pickCountryCode(payload?: CustomOptions): Promise<void>; + /** + * Gets the active identifier types for the login screen + * @returns An array of active identifier types or null if none are active + * @utilityFeature + */ + getLoginIdentifiers(): IdentifierType[] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLogin">ScreenMembersOnLogin</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLogin">TransactionMembersOnLogin</a></span>} required> +</ParamField> + +<ParamField path="login" type={<span>Promise<void></span>} required> + Performs login with username/password +</ParamField> + +<ParamField path="federatedLogin" type={<span>Promise<void></span>} required> + Performs login with social provider +</ParamField> + +<ParamField path="pickCountryCode" type={<span>Promise<void></span>} required> + Picks country code for phone number input +</ParamField> + +<ParamField path="getLoginIdentifiers" type={<span>IdentifierType[] | null</span>}> + Gets the active identifier types for the login screen +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions.mdx new file mode 100644 index 000000000..0ab04b08e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions.mdx @@ -0,0 +1,43 @@ +--- +title: "LoginOptions" +description: "Options for performing login operations" +--- + +<RequestExample> + +```typescript Interface lines +export interface LoginOptions { + /** The username/email to login with */ + username: string; + /** The password for authentication */ + password: string; + /** Optional captcha value if required */ + captcha?: string; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="username" type={<span>string</span>} required> + The username/email to login with +</ParamField> + +<ParamField path="password" type={<span>string</span>} required> + The password for authentication +</ParamField> + +<ParamField path="captcha" type={<span>string</span>}> + Optional captcha value if required +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> + Any additional custom options +</ParamField> + +--- + +**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPassword.mdx new file mode 100644 index 000000000..dca537541 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPassword.mdx @@ -0,0 +1,59 @@ +--- +title: "LoginPassword" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface LoginPassword extends BaseContext { + screen: ScreenContextOnLoginPassword; + transaction: TransactionContextOnLoginPassword; +} +``` + +```typescript login +import LoginPassword from "@auth0/auth0-acul-js/login-password" + +const loginPasswordManager = new LoginPassword(); + +loginPasswordManager.login({ + username: "testUser", + password: "******" +}); +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPassword">ScreenContextOnLoginPassword</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLoginPassword">TransactionContextOnLoginPassword</a></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> +</ParamField> + +<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordMembers.mdx new file mode 100644 index 000000000..4c009dce3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordMembers.mdx @@ -0,0 +1,56 @@ +--- +title: "LoginPasswordMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface LoginPasswordMembers extends BaseMembers { + screen: ScreenMembersOnLoginPassword; + transaction: TransactionMembersOnLoginPassword; + login(payload: LoginPasswordOptions): Promise<void>; + federatedLogin(payload: FederatedLoginOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPassword">ScreenMembersOnLoginPassword</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPassword">TransactionMembersOnLoginPassword</a></span>} required> +</ParamField> + +<ParamField path="login" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="federatedLogin" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/login-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordOptions.mdx new file mode 100644 index 000000000..f65b04f59 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "LoginPasswordOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface LoginPasswordOptions { + username: string; + password: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="username" type={<span>string</span>} required> +</ParamField> + +<ParamField path="password" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captcha" type={<span>string</span>}> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessEmailCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessEmailCodeMembers.mdx new file mode 100644 index 000000000..d344de95a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessEmailCodeMembers.mdx @@ -0,0 +1,60 @@ +--- +title: "LoginPasswordlessEmailCodeMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface LoginPasswordlessEmailCodeMembers extends BaseMembers { + screen: ScreenMembersOnLoginPasswordlessEmailCode; + transaction: TransactionMembersOnLoginPasswordlessEmailCode; + submitCode(payload: SubmitCodeOptions): Promise<void>; + resendCode(payload?: CustomOptions): Promise<void>; + resendManager(options?: StartResendOptions): ResendControl; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessEmailCode">ScreenMembersOnLoginPasswordlessEmailCode</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessEmailCode">TransactionMembersOnLoginPasswordlessEmailCode</a></span>} required> +</ParamField> + +<ParamField path="submitCode" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="resendCode" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/login-passwordless-email-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessSmsOtpMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessSmsOtpMembers.mdx new file mode 100644 index 000000000..155770b9c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessSmsOtpMembers.mdx @@ -0,0 +1,65 @@ +--- +title: "LoginPasswordlessSmsOtpMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface LoginPasswordlessSmsOtpMembers extends BaseMembers { + screen: ScreenMembersOnLoginPasswordlessSmsOtp; + transaction: TransactionMembersOnLoginPasswordlessSmsOtp; + submitOTP(payload: SubmitOTPOptions): Promise<void>; + resendOTP(payload?: CustomOptions): Promise<void>; + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp">ScreenMembersOnLoginPasswordlessSmsOtp</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp">TransactionMembersOnLoginPasswordlessSmsOtp</a></span>} required> +</ParamField> + +<ParamField path="submitOTP" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="resendOTP" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> + Gets resend functionality with timeout management for this screen +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/login-passwordless-sms-otp.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutAbortedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutAbortedMembers.mdx new file mode 100644 index 000000000..79475f02b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutAbortedMembers.mdx @@ -0,0 +1,45 @@ +--- +title: "LogoutAbortedMembers" +description: "Interface defining the available methods and properties for the logout-aborted screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface LogoutAbortedMembers extends BaseMembers {} +``` + +</RequestExample> + +## Properties + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/logout-aborted.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/logout-aborted.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutCompleteMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutCompleteMembers.mdx new file mode 100644 index 000000000..b92cdc904 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutCompleteMembers.mdx @@ -0,0 +1,45 @@ +--- +title: "LogoutCompleteMembers" +description: "Interface defining the available methods and properties for the logout-complete screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface LogoutCompleteMembers extends BaseMembers {} +``` + +</RequestExample> + +## Properties + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/logout-complete.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/logout-complete.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutMembers.mdx new file mode 100644 index 000000000..66d8ca257 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutMembers.mdx @@ -0,0 +1,55 @@ +--- +title: "LogoutMembers" +description: "Interface defining the available methods and properties for the logout screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface LogoutMembers extends BaseMembers { + /** + * Confirms the logout action (accept or deny) + * @param payload The options containing the action to perform + */ + confirmLogout(payload: ConfirmLogoutOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="confirmLogout" type={<span>Promise<void></span>} required> + Confirms the logout action (accept or deny) +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/logout.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/logout.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaBeginEnrollOptionsMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaBeginEnrollOptionsMembers.mdx new file mode 100644 index 000000000..db4cda74c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaBeginEnrollOptionsMembers.mdx @@ -0,0 +1,55 @@ +--- +title: "MfaBeginEnrollOptionsMembers" +description: "MFA Begin Enroll Options screen members interface" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaBeginEnrollOptionsMembers extends BaseMembers { + /** + * Continues the enrollment process with the selected factor + * @param payload The enrollment options including the selected factor + */ + enroll(payload: MfaEnrollOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="enroll" type={<span>Promise<void></span>} required> + Continues the enrollment process with the selected factor +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-begin-enroll-options.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaCountryCodesMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaCountryCodesMembers.mdx new file mode 100644 index 000000000..72ff74d26 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaCountryCodesMembers.mdx @@ -0,0 +1,65 @@ +--- +title: "MfaCountryCodesMembers" +description: "Interface defining the available methods and properties for the mfa-country-codes screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaCountryCodesMembers extends BaseMembers { + screen: ScreenMembersOnMfaCountryCodes; + /** + * Selects a country code from the available options + * @param payload The options containing the country code selection action + */ + selectCountryCode(payload: SelectCountryCodeOptions): Promise<void>; + /** + * Navigates back to the previous screen + * @param payload Optional custom options to include with the request + */ + goBack(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaCountryCodes">ScreenMembersOnMfaCountryCodes</a></span>} required> +</ParamField> + +<ParamField path="selectCountryCode" type={<span>Promise<void></span>} required> + Selects a country code from the available options +</ParamField> + +<ParamField path="goBack" type={<span>Promise<void></span>} required> + Navigates back to the previous screen +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-country-codes.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx new file mode 100644 index 000000000..db7cfcc0a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx @@ -0,0 +1,60 @@ +--- +title: "MfaDetectBrowserCapabilitiesMembers" +description: "Interface defining the available methods and properties for the mfa-detect-browser-capabilities screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaDetectBrowserCapabilitiesMembers extends BaseMembers { + /** + * Picks an authenticator based on browser capabilities + * @param payload The options containing browser capability flags + * @example + * ```typescript + * const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); + * await mfaDetectBrowserCapabilities.detectCapabilities(); + * ``` + */ + detectCapabilities(payload: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="detectCapabilities" type={<span>Promise<void></span>} required> + Picks an authenticator based on browser capabilities +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-detect-browser-capabilities.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-detect-browser-capabilities.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailChallengeMembers.mdx new file mode 100644 index 000000000..4d262ec8e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailChallengeMembers.mdx @@ -0,0 +1,98 @@ +--- +title: "MfaEmailChallengeMembers" +description: "Interface defining the available methods and properties for the mfa-email-challenge screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaEmailChallengeMembers extends BaseMembers { + screen: ScreenMembersOnMfaEmailChallenge; + untrustedData: UntrustedDataMembersOnMfaEmailChallenge; + + /** + * Continues with the email challenge using the provided code + * @param payload The options containing the code and rememberDevice flag + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Resends the email code + * @param payload Optional custom options to include with the request + */ + resendCode(payload?: ResendCodeOptions): Promise<void>; + + /** + * Allows the user to try another MFA method + * @param payload Optional custom options to include with the request + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; + + /** + * Submits the action to pick a different Email configuration, if available + * @param payload Optional custom options to include with the request + */ + pickEmail(payload?: CustomOptions): Promise<void>; + + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailChallenge">ScreenMembersOnMfaEmailChallenge</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaEmailChallenge">UntrustedDataMembersOnMfaEmailChallenge</a></span>} required> +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Continues with the email challenge using the provided code +</ParamField> + +<ParamField path="resendCode" type={<span>Promise<void></span>} required> + Resends the email code +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows the user to try another MFA method +</ParamField> + +<ParamField path="pickEmail" type={<span>Promise<void></span>} required> + Submits the action to pick a different Email configuration, if available +</ParamField> + +<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> + Gets resend functionality with timeout management for this screen +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-email-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailListMembers.mdx new file mode 100644 index 000000000..bfd36ede8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailListMembers.mdx @@ -0,0 +1,65 @@ +--- +title: "MfaEmailListMembers" +description: "Interface defining the available methods and properties for the mfa-email-list screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaEmailListMembers extends BaseMembers { + screen: ScreenMembersOnMfaEmailList; + /** + * Selects an enrolled email address from the list + * @param payload The options containing the selection action + */ + selectMfaEmail(payload: SelectMfaEmailOptions): Promise<void>; + /** + * Navigates back to the previous screen + * @param payload Optional custom options to include with the request + */ + goBack(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailList">ScreenMembersOnMfaEmailList</a></span>} required> +</ParamField> + +<ParamField path="selectMfaEmail" type={<span>Promise<void></span>} required> + Selects an enrolled email address from the list +</ParamField> + +<ParamField path="goBack" type={<span>Promise<void></span>} required> + Navigates back to the previous screen +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-email-list.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollOptions.mdx new file mode 100644 index 000000000..d44e97b08 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollOptions.mdx @@ -0,0 +1,31 @@ +--- +title: "MfaEnrollOptions" +description: "Options for continuing with factor enrollment" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaEnrollOptions { + /** The action indicating which factor to enroll */ + action: MfaEnrollFactorType; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="action" type={<span>MfaEnrollFactorType</span>} required> + The action indicating which factor to enroll +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> + Any additional custom options +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-begin-enroll-options.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollResultMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollResultMembers.mdx new file mode 100644 index 000000000..c2c348247 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollResultMembers.mdx @@ -0,0 +1,57 @@ +--- +title: "MfaEnrollResultMembers" +description: "@interface MfaEnrollResultMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaEnrollResultMembers extends BaseMembers { + /** + * Provides access to the specific properties and data of the MFA Enroll Result screen, + * including the enrollment `status` (via `screen.data.status`). + * @type {ScreenMembersOnMfaEnrollResult} + */ + screen: ScreenMembersOnMfaEnrollResult; + + // No specific operations (methods) are typically defined for this screen as it's informational. + // The user might be automatically redirected or provided a button to continue, + // which would usually be a simple navigation handled by the page template or a default action. +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEnrollResult">ScreenMembersOnMfaEnrollResult</a></span>} required> + Provides access to the specific properties and data of the MFA Enroll Result screen, including the enrollment `status` (via `screen.data.status`). +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-enroll-result.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaLoginOptionsMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaLoginOptionsMembers.mdx new file mode 100644 index 000000000..86998b2e0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaLoginOptionsMembers.mdx @@ -0,0 +1,77 @@ +--- +title: "MfaLoginOptionsMembers" +description: "Interface defining the available methods and properties for the mfa-login-options screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaLoginOptionsMembers extends BaseMembers { + screen: ScreenMembersOnMfaLoginOptions; + /** + * Continues the login process with the selected MFA factor + * @param payload The options containing the selected factor + * @example + * ```typescript + * const mfaLoginOptions = new MfaLoginOptions(); + * await mfaLoginOptions.enroll({ + * action: 'push-notification' + * }); + * ``` + */ + enroll(payload: LoginEnrollOptions): Promise<void>; + /** + * Returns to the previous screen in the authentication flow + * @param payload Optional custom options + * @example + * ```typescript + * const mfaLoginOptions = new MfaLoginOptions(); + * await mfaLoginOptions.returnToPrevious(); + * ``` + */ + returnToPrevious(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaLoginOptions">ScreenMembersOnMfaLoginOptions</a></span>} required> +</ParamField> + +<ParamField path="enroll" type={<span>Promise<void></span>} required> + Continues the login process with the selected MFA factor +</ParamField> + +<ParamField path="returnToPrevious" type={<span>Promise<void></span>} required> + Returns to the previous screen in the authentication flow +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-login-options.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpChallengeMembers.mdx new file mode 100644 index 000000000..14d6bbf6b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpChallengeMembers.mdx @@ -0,0 +1,68 @@ +--- +title: "MfaOtpChallengeMembers" +description: "Interface defining the available methods and properties for the mfa-otp-challenge screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaOtpChallengeMembers extends BaseMembers { + screen: ScreenMembersOnMfaOtpChallenge; + untrustedData: UntrustedDataMembersOnMfaOtpChallenge; + + /** + * Continues with the OTP challenge using the provided code + * @param payload The options containing the code and rememberDevice flag + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Allows the user to try another MFA method + * @param payload Optional custom options to include with the request + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpChallenge">ScreenMembersOnMfaOtpChallenge</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaOtpChallenge">UntrustedDataMembersOnMfaOtpChallenge</a></span>} required> +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Continues with the OTP challenge using the provided code +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows the user to try another MFA method +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-otp-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentCodeMembers.mdx new file mode 100644 index 000000000..e83fb1cda --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentCodeMembers.mdx @@ -0,0 +1,71 @@ +--- +title: "MfaOtpEnrollmentCodeMembers" +description: "Interface defining the available methods and properties for the mfa-otp-enrollment-code screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaOtpEnrollmentCodeMembers extends BaseMembers { + /** + * The screen properties for the mfa-otp-enrollment-code screen. + */ + screen: ScreenMembersOnMfaOtpEnrollmentCode; + + /** + * Continues the MFA OTP enrollment process by submitting the OTP code. + * @param payload The options containing the OTP code. + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Allows the user to try another MFA method. + * @param payload Optional custom options to include with the request. + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentCode">ScreenMembersOnMfaOtpEnrollmentCode</a></span>} required> + The screen properties for the mfa-otp-enrollment-code screen. +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Continues the MFA OTP enrollment process by submitting the OTP code. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows the user to try another MFA method. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-otp-enrollment-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentQrMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentQrMembers.mdx new file mode 100644 index 000000000..57e7a135d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentQrMembers.mdx @@ -0,0 +1,77 @@ +--- +title: "MfaOtpEnrollmentQrMembers" +description: "Interface defining the available methods and properties for the mfa-otp-enrollment-qr screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaOtpEnrollmentQrMembers extends BaseMembers { + screen: ScreenMembersOnMfaOtpEnrollmentQr; + + /** + * Toggles the view. + * @param payload Optional custom options to include with the request + */ + toggleView(payload?: CustomOptions): Promise<void>; + + /** + * Continues with the default action. + * @param payload Payload containing code and optional custom options + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Allows trying another authentication method + * @param payload Optional custom options to include with the request + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentQr">ScreenMembersOnMfaOtpEnrollmentQr</a></span>} required> +</ParamField> + +<ParamField path="toggleView" type={<span>Promise<void></span>} required> + Toggles the view. +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Continues with the default action. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows trying another authentication method +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-otp-enrollment-qr.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneChallengeMembers.mdx new file mode 100644 index 000000000..58ba9d8ff --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneChallengeMembers.mdx @@ -0,0 +1,122 @@ +--- +title: "MfaPhoneChallengeMembers" +description: "@interface MfaPhoneChallengeMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaPhoneChallengeMembers extends BaseMembers { + /** + * @property {ScreenMembersOnMfaPhoneChallenge} screen - Specific screen information for the MFA Phone Challenge. + */ + screen: ScreenMembersOnMfaPhoneChallenge; + + /** + * continue + * Submits the choice of MFA delivery method (SMS or Voice) to proceed with the challenge. + * This will trigger sending the verification code to the user's phone. + * + * @param {ContinueOptions} payload - The options specifying the delivery type ('sms' or 'voice'). + * @returns {Promise<void>} A promise that resolves when the action is submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + * + * const mfaPhoneChallenge = new MfaPhoneChallenge(); + * + * // To send the code via SMS + * await mfaPhoneChallenge.continue({ type: 'sms' }); + * + * // To send the code via Voice Call + * await mfaPhoneChallenge.continue({ type: 'voice' }); + * ``` + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * pickPhone + * Initiates the action to pick a different phone number. + * This typically redirects the user to a screen where they can select from multiple enrolled phone numbers, if applicable. + * + * @param {PickPhoneOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the action is submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + * + * const mfaPhoneChallenge = new MfaPhoneChallenge(); + * await mfaPhoneChallenge.pickPhone(); + * ``` + */ + pickPhone(payload?: PickPhoneOptions): Promise<void>; + + /** + * tryAnotherMethod + * Initiates the action to select a different MFA factor/authenticator. + * This redirects the user to a screen where they can choose an alternative MFA method (e.g., OTP app, recovery code). + * + * @param {PickAuthenticatorOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the action is submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + * + * const mfaPhoneChallenge = new MfaPhoneChallenge(); + * await mfaPhoneChallenge.tryAnotherMethod(); + * ``` + */ + tryAnotherMethod(payload?: PickAuthenticatorOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPhoneChallenge">ScreenMembersOnMfaPhoneChallenge</a></span>} required> + Specific screen information for the MFA Phone Challenge. +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + continue Submits the choice of MFA delivery method (SMS or Voice) to proceed with the challenge. This will trigger sending the verification code to the user's phone. +</ParamField> + +<ParamField path="pickPhone" type={<span>Promise<void></span>} required> + pickPhone Initiates the action to pick a different phone number. This typically redirects the user to a screen where they can select from multiple enrolled phone numbers, if applicable. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + tryAnotherMethod Initiates the action to select a different MFA factor/authenticator. This redirects the user to a screen where they can choose an alternative MFA method (e.g., OTP app, recovery code). +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-phone-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneEnrollmentMembers.mdx new file mode 100644 index 000000000..826c499ad --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneEnrollmentMembers.mdx @@ -0,0 +1,81 @@ +--- +title: "MfaPhoneEnrollmentMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaPhoneEnrollmentMembers extends BaseMembers { + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + transaction: TransactionMembers; + + /** + * Selects the country code for the phone number. + * @param payload Optional custom options to include with the request. + */ + pickCountryCode(payload?: CustomOptions): Promise<void>; + + /** + * Continues the enrollment process with the provided phone number and type (SMS or voice). + * @param payload The phone number, type, and optional custom options. + */ + continueEnrollment(payload: ContinueOptions): Promise<void>; + + /** + * Allows the user to try another MFA method. + * @param payload Optional custom options to include with the request. + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="pickCountryCode" type={<span>Promise<void></span>} required> + Selects the country code for the phone number. +</ParamField> + +<ParamField path="continueEnrollment" type={<span>Promise<void></span>} required> + Continues the enrollment process with the provided phone number and type (SMS or voice). +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows the user to try another MFA method. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-phone-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushChallengePushMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushChallengePushMembers.mdx new file mode 100644 index 000000000..1cbe85632 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushChallengePushMembers.mdx @@ -0,0 +1,99 @@ +--- +title: "MfaPushChallengePushMembers" +description: "Interface defining the available methods and properties for the mfa-push-challenge-push screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaPushChallengePushMembers extends BaseMembers { + screen: ScreenMembersOnMfaPushChallengePush; + untrustedData: UntrustedDataMembersOnMfaPushChallengePush; + + /** + * Continues with the push notification challenge + * @param payload Optional custom options to include with the request + */ + continue(payload?: WithRememberOptions): Promise<void>; + + /** + * Resends the push notification + * @param payload Optional custom options to include with the request + */ + resendPushNotification(payload?: WithRememberOptions): Promise<void>; + + /** + * Switches to entering the verification code manually + * @param payload Optional custom options to include with the request + */ + enterCodeManually(payload?: CustomOptions): Promise<void>; + + /** + * Allows trying another authentication method + * @param payload Optional custom options to include with the request + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + + /** + * Manages polling for MFA push challenge status + * @param options Configuration options for polling of type {@link MfaPollingOptions} + * @returns An object to control the polling process + */ + pollingManager(options: MfaPollingOptions): MfaPushPollingControl; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushChallengePush">ScreenMembersOnMfaPushChallengePush</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaPushChallengePush">UntrustedDataMembersOnMfaPushChallengePush</a></span>} required> +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Continues with the push notification challenge +</ParamField> + +<ParamField path="resendPushNotification" type={<span>Promise<void></span>} required> + Resends the push notification +</ParamField> + +<ParamField path="enterCodeManually" type={<span>Promise<void></span>} required> + Switches to entering the verification code manually +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows trying another authentication method +</ParamField> + +<ParamField path="pollingManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>} required> + Manages polling for MFA push challenge status +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-push-challenge-push.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushEnrollmentQrMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushEnrollmentQrMembers.mdx new file mode 100644 index 000000000..59eb3c4f7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushEnrollmentQrMembers.mdx @@ -0,0 +1,62 @@ +--- +title: "MfaPushEnrollmentQrMembers" +description: "Interface defining the available methods and properties for the mfa-push-enrollment-qr screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaPushEnrollmentQrMembers extends BaseMembers { + screen: ScreenMembersOnMfaPushEnrollmentQr; + /** + * Navigates to the authenticator selection screen. + * @param payload Optional custom options to include with the request + */ + pickAuthenticator(payload?: CustomOptions): Promise<void>; + + pollingManager(options: MfaPollingOptions): MfaPushPollingControl; + +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushEnrollmentQr">ScreenMembersOnMfaPushEnrollmentQr</a></span>} required> +</ParamField> + +<ParamField path="pickAuthenticator" type={<span>Promise<void></span>} required> + Navigates to the authenticator selection screen. +</ParamField> + +<ParamField path="pollingManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-push-enrollment-qr.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushListMembers.mdx new file mode 100644 index 000000000..c84213342 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushListMembers.mdx @@ -0,0 +1,64 @@ +--- +title: "MfaPushListMembers" +description: "Interface defining the available methods and properties for the mfa-push-list screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaPushListMembers extends BaseMembers { + /** + * Selects a registered device from the list to initiate MFA push. + * @param payload The options containing the device index. + */ + selectMfaPushDevice(payload: SelectMfaPushDeviceOptions): Promise<void>; + /** + * Navigates back to the previous screen. + * @param payload Optional custom options to include with the request. + */ + goBack(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="selectMfaPushDevice" type={<span>Promise<void></span>} required> + Selects a registered device from the list to initiate MFA push. +</ParamField> + +<ParamField path="goBack" type={<span>Promise<void></span>} required> + Navigates back to the previous screen. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-push-list.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl.mdx new file mode 100644 index 000000000..9db41553d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl.mdx @@ -0,0 +1,78 @@ +--- +title: "MfaPushPollingControl" +description: "Control interface for managing an MFA push-notification polling session. This interface provides imperative methods to start, stop, and inspect the status of a long-running polling loop that checks whether an MFA push challenge has been approved." +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaPushPollingControl { + /** + * Stops the polling process immediately. + * + * - Cancels any scheduled timer or pending request. + * - Once stopped, `isRunning()` returns `false`. + * - Safe to call multiple times; subsequent calls have no effect. + * + * @example + * ```ts + * const control = mfaPushChallengePush.pollingManager({ intervalMs: 5000 }); + * control.startPolling(); + * + * // Later, if the user cancels: + * control.stopPolling(); + * ``` + */ + stopPolling: () => void; + + /** + * Starts or resumes the polling process. + * + * - If polling is already active, calling this again has no effect. + * - If previously stopped, calling this restarts the polling loop. + * + * @example + * ```ts + * control.startPolling(); // Begin checking the MFA push challenge + * ``` + */ + startPolling: () => void; + + /** + * Indicates whether the polling process is currently running. + * + * - Returns `true` if polling is active and not cancelled. + * - Returns `false` if polling has been stopped or has completed. + * + * @example + * ```ts + * if (control.isRunning()) { + * console.log('Polling in progress...'); + * } else { + * console.log('Polling is stopped or completed.'); + * } + * ``` + */ + isRunning: () => boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="stopPolling" type={<span>() => void</span>} required> + Stops the polling process immediately. - Cancels any scheduled timer or pending request. - Once stopped, `isRunning()` returns `false`. - Safe to call multiple times; subsequent calls have no effect. +</ParamField> + +<ParamField path="startPolling" type={<span>() => void</span>} required> + Starts or resumes the polling process. - If polling is already active, calling this again has no effect. - If previously stopped, calling this restarts the polling loop. +</ParamField> + +<ParamField path="isRunning" type={<span>() => boolean</span>} required> + Indicates whether the polling process is currently running. - Returns `true` if polling is active and not cancelled. - Returns `false` if polling has been stopped or has completed. +</ParamField> + +--- + +**File:** [interfaces/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeMembers.mdx new file mode 100644 index 000000000..58f3e0d1e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeMembers.mdx @@ -0,0 +1,55 @@ +--- +title: "MfaPushWelcomeMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaPushWelcomeMembers extends BaseMembers { + screen: ScreenMembersOnMfaPushWelcome; + enroll(payload?: CustomOptions): Promise<void>; + pickAuthenticator(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushWelcome">ScreenMembersOnMfaPushWelcome</a></span>} required> +</ParamField> + +<ParamField path="enroll" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="pickAuthenticator" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-push-welcome.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeOptions.mdx new file mode 100644 index 000000000..a18e29965 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "MfaPushWelcomeOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaPushWelcomeOptions { + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-push-welcome.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeMembers.mdx new file mode 100644 index 000000000..2dc165059 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeMembers.mdx @@ -0,0 +1,73 @@ +--- +title: "MfaRecoveryCodeChallengeMembers" +description: "Interface describing the members of the Mfa Recovery Code Challenge screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaRecoveryCodeChallengeMembers extends BaseMembers { + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + transaction: TransactionMembers; + + /** + * Continues with the provided recovery code. + * @param payload - The continue options containing the recovery code and optional custom options. + * @returns A promise that resolves when the continuation is successful. + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Navigates to the screen where the user can pick another MFA method. + * @param payload Optional payload. + * @returns A promise that resolves when the navigation is complete. + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Continues with the provided recovery code. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Navigates to the screen where the user can pick another MFA method. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-recovery-code-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx new file mode 100644 index 000000000..239b789af --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx @@ -0,0 +1,84 @@ +--- +title: "MfaRecoveryCodeChallengeNewCodeMembers" +description: "@interface MfaRecoveryCodeChallengeNewCodeMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaRecoveryCodeChallengeNewCodeMembers extends BaseMembers { + /** + * Access to the specific properties and data of the 'mfa-recovery-code-challenge-new-code' screen. + * Includes the `textCode` which is the recovery code to be displayed. + * @type {ScreenMembersOnMfaRecoveryCodeChallengeNewCode} + */ + screen: ScreenMembersOnMfaRecoveryCodeChallengeNewCode; + + /** + * Confirms that the user has saved the new recovery code and continues the authentication flow. + * This method should be called after the user indicates they have securely stored the displayed recovery code. + * It sends a confirmation to the Auth0 server to proceed to the next step. + * + * @param {ContinueOptions} [payload] - Optional custom data to include with the request. + * @returns {Promise<void>} A promise that resolves when the confirmation is successfully submitted. + * @throws {Error} Throws an error if the submission fails (e.g., network issue, invalid state). + * + * @example + * ```typescript + * import MfaRecoveryCodeChallengeNewCode from '@auth0/auth0-acul-js/mfa-recovery-code-challenge-new-code'; + * + * const screenManager = new MfaRecoveryCodeChallengeNewCode(); + * + * // Assuming the user has checked a box confirming they saved the code + * try { + * await screenManager.continue(); + * // Redirects to the next screen on success + * } catch (error) { + * console.error("Failed to confirm recovery code saved:", error); + * // Handle error, e.g., display a message from screenManager.transaction.errors + * } + * ``` + */ + continue(payload?: ContinueOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode">ScreenMembersOnMfaRecoveryCodeChallengeNewCode</a></span>} required> + Access to the specific properties and data of the 'mfa-recovery-code-challenge-new-code' screen. Includes the `textCode` which is the recovery code to be displayed. +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Confirms that the user has saved the new recovery code and continues the authentication flow. This method should be called after the user indicates they have securely stored the displayed recovery code. It sends a confirmation to the Auth0 server to proceed to the next step. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-recovery-code-challenge-new-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx new file mode 100644 index 000000000..6ae519e59 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx @@ -0,0 +1,26 @@ +--- +title: "MfaRecoveryCodeEnrollmentContinueOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaRecoveryCodeEnrollmentContinueOptions extends CustomOptions { + isCodeCopied: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="isCodeCopied" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-recovery-code-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx new file mode 100644 index 000000000..b32a98344 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx @@ -0,0 +1,63 @@ +--- +title: "MfaRecoveryCodeEnrollmentMembers" +description: "Interface describing the members of the Mfa Recovery Code Enrollment screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaRecoveryCodeEnrollmentMembers extends BaseMembers { + screen: ScreenMembersOnMfaRecoveryCodeEnrollment; + + /** + * Declares that the user saved the recovery code. + * This action is triggered when the user declares that they have saved the recovery code. + * It redirects to the next screen in the authentication flow. + * + * @param {object} payload - An object containing any custom options. + * + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. + * Rejects with an error if the submission fails. + */ + continue(payload: MfaRecoveryCodeEnrollmentContinueOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment">ScreenMembersOnMfaRecoveryCodeEnrollment</a></span>} required> +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Declares that the user saved the recovery code. This action is triggered when the user declares that they have saved the recovery code. It redirects to the next screen in the authentication flow. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-recovery-code-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeMembers.mdx new file mode 100644 index 000000000..b3bd4711b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeMembers.mdx @@ -0,0 +1,77 @@ +--- +title: "MfaSmsChallengeMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaSmsChallengeMembers extends BaseMembers { + screen: ScreenMembersOnMfaSmsChallenge; + untrustedData: UntrustedDataMembersOnMfaSmsChallenge; + continueMfaSmsChallenge(payload: MfaSmsChallengeOptions): Promise<void>; + pickSms(payload?: CustomOptions): Promise<void>; + resendCode(payload?: CustomOptions): Promise<void>; + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + getACall(payload?: CustomOptions): Promise<void>; + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsChallenge">ScreenMembersOnMfaSmsChallenge</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaSmsChallenge">UntrustedDataMembersOnMfaSmsChallenge</a></span>} required> +</ParamField> + +<ParamField path="continueMfaSmsChallenge" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="pickSms" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="resendCode" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="getACall" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> + Gets resend functionality with timeout management for this screen +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-sms-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions.mdx new file mode 100644 index 000000000..d1a88e5b6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "MfaSmsChallengeOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaSmsChallengeOptions { + code: string; + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="code" type={<span>string</span>} required> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-sms-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentMembers.mdx new file mode 100644 index 000000000..f7f285985 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentMembers.mdx @@ -0,0 +1,59 @@ +--- +title: "MfaSmsEnrollmentMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaSmsEnrollmentMembers extends BaseMembers { + screen: ScreenMembersOnMfaSmsEnrollment; + pickCountryCode(payload?: CustomOptions): Promise<void>; + continueEnrollment(payload: { phone: string; captcha?: string }): Promise<void>; + tryAnotherMethod(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsEnrollment">ScreenMembersOnMfaSmsEnrollment</a></span>} required> +</ParamField> + +<ParamField path="pickCountryCode" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="continueEnrollment" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-sms-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentOptions.mdx new file mode 100644 index 000000000..cd17ebb94 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentOptions.mdx @@ -0,0 +1,31 @@ +--- +title: "MfaSmsEnrollmentOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaSmsEnrollmentOptions { + phone?: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="phone" type={<span>string</span>}> +</ParamField> + +<ParamField path="captcha" type={<span>string</span>}> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-sms-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListMembers.mdx new file mode 100644 index 000000000..dd84a0a65 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListMembers.mdx @@ -0,0 +1,67 @@ +--- +title: "MfaSmsListMembers" +description: "@interface MfaSmsListMembers Interface defining the members and methods for the MfaSmsList class." +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaSmsListMembers extends BaseMembers { + /** + * Selects a phone number from the list of enrolled phone numbers. + * @param {MfaSmsListOptions} [payload] - Optional payload for the action. + * @returns {Promise<void>} + * @throws {Error} If the index is out of bounds. + */ + selectPhoneNumber(payload?: MfaSmsListOptions): Promise<void>; + /** + * Navigates back to the previous screen. + * @param {MfaSmsListOptions} [payload] - Optional payload for the action. + * @returns {Promise<void>} + */ + backAction(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="selectPhoneNumber" type={<span>Promise<void></span>} required> + Selects a phone number from the list of enrolled phone numbers. +</ParamField> + +<ParamField path="backAction" type={<span>Promise<void></span>} required> + Navigates back to the previous screen. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-sms-list.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListOptions.mdx new file mode 100644 index 000000000..3e3942459 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListOptions.mdx @@ -0,0 +1,33 @@ +--- +title: "MfaSmsListOptions" +description: "@interface MfaSmsListOptions Options for performing actions on the mfa-sms-list screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaSmsListOptions { + /** + * @param {number} index - The index of the phone number to select. + */ + index: number; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="index" type={<span>number</span>} required> + @param index - The index of the phone number to select. +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> + Any additional custom options +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-sms-list.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeContinueOptions.mdx new file mode 100644 index 000000000..4394bf4f3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeContinueOptions.mdx @@ -0,0 +1,45 @@ +--- +title: "MfaVoiceChallengeContinueOptions" +description: "Options for submitting the voice challenge code." +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaVoiceChallengeContinueOptions { + /** + * The verification code received via voice call. + */ + code: string; + + /** + * Optional flag to remember the device for 30 days, skipping future MFA challenges. + */ + rememberDevice?: boolean; + + /** + * Additional custom options to pass with the request. + */ + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="code" type={<span>string</span>} required> + The verification code received via voice call. +</ParamField> + +<ParamField path="rememberDevice" type={<span>boolean</span>}> + Optional flag to remember the device for 30 days, skipping future MFA challenges. +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> + Additional custom options to pass with the request. +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-voice-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeMembers.mdx new file mode 100644 index 000000000..1bb03eeaa --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeMembers.mdx @@ -0,0 +1,156 @@ +--- +title: "MfaVoiceChallengeMembers" +description: "Interface defining all members and operations available on the MFA Voice Challenge screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaVoiceChallengeMembers extends BaseMembers { + /** + * Screen-specific properties and data. + */ + screen: ScreenMembersOnMfaVoiceChallenge; + + untrustedData: UntrustedDataMembersOnMfaVoiceChallenge; + + /** + * Submits the voice verification code to validate the MFA challenge. + * + * @param payload - Object containing the verification code and optional parameters + * @returns Promise that resolves when the code is successfully validated + * + * @example + * ```typescript + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * mfaVoiceChallenge.continue({ + * code: '123456', + * rememberDevice: true + * }); + * ``` + */ + continue(payload: MfaVoiceChallengeContinueOptions): Promise<void>; + + /** + * Navigates to the screen for selecting a different phone number. + * + * @param payload - Optional custom parameters + * @returns Promise that resolves when navigation is complete + * + * @example + * ```typescript + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * mfaVoiceChallenge.pickPhone(); + * ``` + */ + pickPhone(payload?: CustomOptions): Promise<void>; + + /** + * Switches to SMS verification method instead of voice call. + * + * @param payload - Optional custom parameters + * @returns Promise that resolves when switching is complete + * + * @example + * ```typescript + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * mfaVoiceChallenge.switchToSms(); + * ``` + */ + switchToSms(payload?: CustomOptions): Promise<void>; + + /** + * Requests a new voice call with a verification code. + * + * @param payload - Optional custom parameters + * @returns Promise that resolves when the new code is sent + * + * @example + * ```typescript + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * mfaVoiceChallenge.resendCode(); + * ``` + */ + resendCode(payload?: CustomOptions): Promise<void>; + + /** + * Navigates to the screen for selecting an alternative MFA method. + * + * @param payload - Optional custom parameters + * @returns Promise that resolves when navigation is complete + * + * @example + * ```typescript + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * mfaVoiceChallenge.tryAnotherMethod(); + * ``` + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaVoiceChallenge">ScreenMembersOnMfaVoiceChallenge</a></span>} required> + Screen-specific properties and data. +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaVoiceChallenge">UntrustedDataMembersOnMfaVoiceChallenge</a></span>} required> +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Submits the voice verification code to validate the MFA challenge. +</ParamField> + +<ParamField path="pickPhone" type={<span>Promise<void></span>} required> + Navigates to the screen for selecting a different phone number. +</ParamField> + +<ParamField path="switchToSms" type={<span>Promise<void></span>} required> + Switches to SMS verification method instead of voice call. +</ParamField> + +<ParamField path="resendCode" type={<span>Promise<void></span>} required> + Requests a new voice call with a verification code. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Navigates to the screen for selecting an alternative MFA method. +</ParamField> + +<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> + Gets resend functionality with timeout management for this screen +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-voice-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceEnrollmentMembers.mdx new file mode 100644 index 000000000..155f32ba4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceEnrollmentMembers.mdx @@ -0,0 +1,84 @@ +--- +title: "MfaVoiceEnrollmentMembers" +description: "Interface describing the members of the Mfa Voice Enrollment screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaVoiceEnrollmentMembers extends BaseMembers { + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + transaction: TransactionMembers; + + /** + * Continues with the voice enrollment process. + * @param payload - The phone number and optional custom options. + * @returns Promise that resolves when enrollment continues. + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Allows trying another authentication method. + * @param payload - Optional custom options. + * @returns Promise that resolves when the user switches method. + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + + /** + * Allows picking a country code for the phone number. + * @param payload - Optional custom options. + * @returns Promise that resolves when the country code is selected. + */ + selectPhoneCountryCode(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Continues with the voice enrollment process. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows trying another authentication method. +</ParamField> + +<ParamField path="selectPhoneCountryCode" type={<span>Promise<void></span>} required> + Allows picking a country code for the phone number. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-voice-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx new file mode 100644 index 000000000..2deacd5b0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx @@ -0,0 +1,100 @@ +--- +title: "MfaWebAuthnChangeKeyNicknameMembers" +description: "@interface MfaWebAuthnChangeKeyNicknameMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaWebAuthnChangeKeyNicknameMembers extends BaseMembers { + /** + * The screen object with MFA WebAuthn Change Key Nickname specific data structure. + */ + screen: ScreenMembersOnMfaWebAuthnChangeKeyNickname; + + /** + * Submits the new nickname for the WebAuthn security key. + * This action corresponds to the user entering a new nickname and clicking a "Save" or "Continue" button. + * The SDK will POST this new nickname to the Auth0 `/u/mfa-webauthn-change-key-nickname` endpoint. + * + * If the new nickname is valid and the update is successful, Auth0 will typically redirect the user + * to the next appropriate screen (e.g., back to MFA factor management or a success confirmation). + * If the nickname is invalid (e.g., empty, too long, too short), Auth0 will re-render the + * 'mfa-webauthn-change-key-nickname' screen, and the `transaction.errors` array in the SDK's + * context will be updated with details about the validation failure. + * + * @param {ContinueOptions} payload - An object containing the `nickname` (string) entered by the user. + * It can also include any `CustomOptions` for extensibility. + * @returns {Promise<void>} A promise that resolves when the form submission is initiated. + * It does not return data directly upon resolution, as a redirect or + * page re-render is the common outcome. + * @throws {Error} Throws an error if `payload.nickname` is not provided or is not a string, + * or if the `FormHandler` encounters an unrecoverable issue during submission (e.g., network error). + * Validation errors from Auth0 (like an invalid nickname) are not thrown as JavaScript errors + * but are reflected in `this.transaction.errors` after the operation. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnChangeKeyNickname + * const newNickname = "My Favorite YubiKey"; // Value from user input + * try { + * await sdk.continueWithNewNickname({ nickname: newNickname }); + * // If successful, page redirects. + * } catch (error) { + * // This catch is for unexpected errors during the SDK call itself. + * console.error("Failed to submit the new nickname:", error); + * } + * // After the await, always check sdk.transaction.errors for server-side validation issues. + * if (sdk.transaction.errors && sdk.transaction.errors.length > 0) { + * sdk.transaction.errors.forEach(err => { + * if (err.field === 'nickname') { + * // Display err.message related to the nickname input field. + * // e.g., "Name is too short", "Name is required" + * } + * }); + * } + * ``` + */ + continueWithNewNickname(payload: ContinueOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname">ScreenMembersOnMfaWebAuthnChangeKeyNickname</a></span>} required> + The screen object with MFA WebAuthn Change Key Nickname specific data structure. +</ParamField> + +<ParamField path="continueWithNewNickname" type={<span>Promise<void></span>} required> + Submits the new nickname for the WebAuthn security key. This action corresponds to the user entering a new nickname and clicking a "Save" or "Continue" button. The SDK will POST this new nickname to the Auth0 `/u/mfa-webauthn-change-key-nickname` endpoint. If the new nickname is valid and the update is successful, Auth0 will typically redirect the user to the next appropriate screen (e.g., back to MFA factor management or a success confirmation). If the nickname is invalid (e.g., empty, too long, too short), Auth0 will re-render the 'mfa-webauthn-change-key-nickname' screen, and the `transaction.errors` array in the SDK's context will be updated with details about the validation failure. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-change-key-nickname.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx new file mode 100644 index 000000000..e45926d85 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx @@ -0,0 +1,81 @@ +--- +title: "MfaWebAuthnEnrollmentSuccessMembers" +description: "@interface MfaWebAuthnEnrollmentSuccessMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaWebAuthnEnrollmentSuccessMembers extends BaseMembers { + /** + * Access to the specific properties and data of the 'mfa-webauthn-enrollment-success' screen. + * Includes the `nickname` of the enrolled authenticator and its `webauthnType`. + * @type {ScreenMembersOnMfaWebAuthnEnrollmentSuccess} + */ + screen: ScreenMembersOnMfaWebAuthnEnrollmentSuccess; + + /** + * Allows the user to continue the authentication flow after successful WebAuthn enrollment. + * This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` endpoint with `action: "default"`. + * + * @param {ContinueOptions} [payload] - Optional. An object for `CustomOptions` if any + * additional parameters need to be sent with the request. + * @returns {Promise<void>} A promise that resolves when the continue action is successfully submitted. + * On success, the browser will typically be redirected to the next step in the flow. + * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnEnrollmentSuccess + * try { + * await sdk.continue(); + * // User is redirected to the next step. + * } catch (error) { + * console.error("Failed to continue after WebAuthn enrollment:", error); + * // Handle error, potentially by inspecting sdk.transaction.errors if the page re-renders with an error. + * } + * ``` + */ + continue(payload?: ContinueOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess">ScreenMembersOnMfaWebAuthnEnrollmentSuccess</a></span>} required> + Access to the specific properties and data of the 'mfa-webauthn-enrollment-success' screen. Includes the `nickname` of the enrolled authenticator and its `webauthnType`. +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Allows the user to continue the authentication flow after successful WebAuthn enrollment. This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` endpoint with `action: "default"`. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-enrollment-success.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnErrorMembers.mdx new file mode 100644 index 000000000..a6277d0aa --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnErrorMembers.mdx @@ -0,0 +1,127 @@ +--- +title: "MfaWebAuthnErrorMembers" +description: "@interface MfaWebAuthnErrorMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaWebAuthnErrorMembers extends BaseMembers { + /** + * The screen object with MFA WebAuthn Error specific data structure. + */ + screen: ScreenMembersOnMfaWebAuthnError; + + /** + * Allows the user to attempt the previous WebAuthn operation again. + * This typically redirects the user back to the screen where the WebAuthn operation was initiated. + * + * @param {CustomOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnError + * await sdk.tryAgain(); + * ``` + */ + tryAgain(payload?: CustomOptions): Promise<void>; + + /** + * Allows the user to opt for password-based authentication as an alternative, if configured. + * This is typically available if the primary authentication or a previous step involved a password. + * + * @param {CustomOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnError + * await sdk.usePassword(); + * ``` + */ + usePassword(payload?: CustomOptions): Promise<void>; + + /** + * Allows the user to select a different MFA method if other factors are enrolled or available. + * This navigates the user to an authenticator selection screen. + * + * @param {CustomOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnError + * await sdk.tryAnotherMethod(); + * ``` + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + + /** + * Allows the user to refuse adding a device or completing the WebAuthn step, effectively declining the current WebAuthn flow. + * This action is typically used in enrollment scenarios where the user decides not to proceed. + * + * @param {CustomOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnError + * await sdk.noThanks(); + * ``` + */ + noThanks(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnError">ScreenMembersOnMfaWebAuthnError</a></span>} required> + The screen object with MFA WebAuthn Error specific data structure. +</ParamField> + +<ParamField path="tryAgain" type={<span>Promise<void></span>} required> + Allows the user to attempt the previous WebAuthn operation again. This typically redirects the user back to the screen where the WebAuthn operation was initiated. +</ParamField> + +<ParamField path="usePassword" type={<span>Promise<void></span>} required> + Allows the user to opt for password-based authentication as an alternative, if configured. This is typically available if the primary authentication or a previous step involved a password. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows the user to select a different MFA method if other factors are enrolled or available. This navigates the user to an authenticator selection screen. +</ParamField> + +<ParamField path="noThanks" type={<span>Promise<void></span>} required> + Allows the user to refuse adding a device or completing the WebAuthn step, effectively declining the current WebAuthn flow. This action is typically used in enrollment scenarios where the user decides not to proceed. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-error.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx new file mode 100644 index 000000000..5b5cab415 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx @@ -0,0 +1,71 @@ +--- +title: "MfaWebAuthnNotAvailableErrorMembers" +description: "@interface MfaWebAuthnNotAvailableErrorMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaWebAuthnNotAvailableErrorMembers extends BaseMembers { + /** + * Allows the user to select a different MFA method because WebAuthn is not available. + * This action navigates the user to an authenticator selection screen where they can choose + * from other available/enrolled MFA factors. + * + * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. + * @returns {Promise<void>} A promise that resolves upon successful submission of the 'pick-authenticator' action. + * @throws {Error} Throws an error if the form submission fails (e.g., network issues, server-side validation errors). + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnNotAvailableError + * try { + * await sdk.tryAnotherMethod(); + * // On success, Auth0 handles redirection to the authenticator selection screen. + * } catch (error) { + * console.error('Failed to switch to another MFA method:', error); + * // Potentially update UI to inform the user of the failure. + * } + * ``` + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows the user to select a different MFA method because WebAuthn is not available. This action navigates the user to an authenticator selection screen where they can choose from other available/enrolled MFA factors. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-not-available-error.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-not-available-error.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx new file mode 100644 index 000000000..008f8dedf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx @@ -0,0 +1,149 @@ +--- +title: "MfaWebAuthnPlatformChallengeMembers" +description: "@interface MfaWebAuthnPlatformChallengeMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaWebAuthnPlatformChallengeMembers extends BaseMembers { + /** + * Screen-specific properties and data, including WebAuthn challenge options and remember device preference. + * @type {ScreenMembersOnMfaWebAuthnPlatformChallenge} + */ + screen: ScreenMembersOnMfaWebAuthnPlatformChallenge; + + /** + * Initiates the WebAuthn platform authenticator challenge. + * This method internally calls `navigator.credentials.get()` using the challenge options + * provided in `screen.publicKey`. + * If successful, it submits the resulting credential to Auth0 with `action: "default"`. + * + * If `navigator.credentials.get()` fails (e.g., user cancellation, timeout, or other WebAuthn API errors), + * it's recommended to call `reportBrowserError` with the error details. + * + * @param {VerifyPlatformAuthenticatorOptions} [options] - Optional parameters for the verification process, + * such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. + * @returns {Promise<void>} A promise that resolves when the verification attempt is submitted. + * A successful operation typically results in a redirect. + * @throws {Error} Throws an error if `screen.publicKey` is missing, + * if `navigator.credentials.get()` fails with an unexpected error not handled by `getPasskeyCredentials`, + * or if the form submission to Auth0 fails. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformChallenge + * try { + * const remember = sdk.screen.showRememberDevice && userCheckedRememberDeviceBox; + * await sdk.verify({ rememberDevice: remember }); + * // On success, Auth0 handles redirection. + * } catch (error) { + * console.error("Platform authenticator verification failed:", error); + * // If it's a WebAuthn API error, report it + * if (error.name && error.message) { // Basic check for DOMException like error + * await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + * } + * // Check sdk.transaction.errors for server-side validation messages if the page reloads. + * } + * ``` + */ + verify(options?: VerifyPlatformAuthenticatorOptions): Promise<void>; + + /** + * Reports a specific WebAuthn API error (from `navigator.credentials.get()`) to Auth0. + * This method should be used when `verify()` (or a manual `navigator.credentials.get()` call) fails due to + * a browser-side WebAuthn issue (e.g., user cancellation `NotAllowedError`, timeout). + * It submits the error details with `action: "showError::{errorDetailsJsonString}"` and an empty `response`. + * + * @param {ReportBrowserErrorOptions} options - Contains the `error` object (with `name` and `message` + * from the WebAuthn API DOMException) and any other custom options. + * @returns {Promise<void>} A promise that resolves when the error report is submitted. + * @throws {Error} Throws an error if the form submission fails (e.g., network error, invalid state). + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformChallenge + * // And webAuthnDomException is an error object from a failed navigator.credentials.get() call. + * try { + * await sdk.reportBrowserError({ + * error: { name: webAuthnDomException.name, message: webAuthnDomException.message } + * }); + * // Auth0 will process this error and may re-render the page or redirect. + * } catch (submitError) { + * console.error("Failed to report WebAuthn browser error:", submitError); + * } + * ``` + */ + reportBrowserError(options: ReportBrowserErrorOptions): Promise<void>; + + /** + * Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. + * This action submits `action: "pick-authenticator"` to Auth0, which should navigate + * the user to an MFA factor selection screen. + * + * @param {TryAnotherMethodOptions} [options] - Optional custom parameters to be sent with the request. + * @returns {Promise<void>} A promise that resolves when the 'pick-authenticator' action is submitted. + * @throws {Error} Throws an error if the form submission fails. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformChallenge + * try { + * await sdk.tryAnotherMethod(); + * // On success, Auth0 handles redirection to MFA selection. + * } catch (error) { + * console.error("Failed to switch MFA method:", error); + * } + * ``` + */ + tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge">ScreenMembersOnMfaWebAuthnPlatformChallenge</a></span>} required> + Screen-specific properties and data, including WebAuthn challenge options and remember device preference. +</ParamField> + +<ParamField path="verify" type={<span>Promise<void></span>} required> + Initiates the WebAuthn platform authenticator challenge. This method internally calls `navigator.credentials.get()` using the challenge options provided in `screen.publicKey`. If successful, it submits the resulting credential to Auth0 with `action: "default"`. If `navigator.credentials.get()` fails (e.g., user cancellation, timeout, or other WebAuthn API errors), it's recommended to call `reportBrowserError` with the error details. +</ParamField> + +<ParamField path="reportBrowserError" type={<span>Promise<void></span>} required> + Reports a specific WebAuthn API error (from `navigator.credentials.get()`) to Auth0. This method should be used when `verify()` (or a manual `navigator.credentials.get()` call) fails due to a browser-side WebAuthn issue (e.g., user cancellation `NotAllowedError`, timeout). It submits the error details with `action: "showError::"` and an empty `response`. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate the user to an MFA factor selection screen. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-platform-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx new file mode 100644 index 000000000..9dee3e21b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx @@ -0,0 +1,148 @@ +--- +title: "MfaWebAuthnPlatformEnrollmentMembers" +description: "@interface MfaWebAuthnPlatformEnrollmentMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaWebAuthnPlatformEnrollmentMembers extends BaseMembers { + /** + * The screen object with MFA WebAuthn Platform Enrollment specific data structure. + */ + screen: ScreenMembersOnMfaWebAuthnPlatformEnrollment; + + /** + * Initiates the WebAuthn platform credential creation process using the public key options + * available on `this.screen.publicKey` and submits the resulting credential to the server. + * This method internally calls `createPasskeyCredentials` (which wraps `navigator.credentials.create()`). + * + * @param {SubmitPasskeyCredentialOptions} [payload] - Optional custom parameters to be sent to the server + * along with the created credential. + * @returns {Promise<void>} A promise that resolves when the credential is successfully created and submitted. + * @throws {Error} Throws an error if `this.screen.publicKey` is not available, if `createPasskeyCredentials` fails + * (e.g., user cancellation, hardware issues), or if the submission to the server fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment + * try { + * if (!sdk.screen.publicKey) { // Check if options are available + * throw new Error("Public key creation options are not available on the screen context."); + * } + * await sdk.submitPasskeyCredential(); // No need to pass publicKey explicitly + * // On success, Auth0 handles redirection. + * } catch (error) { + * console.error('Passkey enrollment failed:', error); + * // Handle error, potentially by calling reportBrowserError if it's a WebAuthn API error + * if (error.name && error.message) { // Check if it looks like a WebAuthn error + * await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + * } + * } + * ``` + */ + submitPasskeyCredential(payload?: SubmitPasskeyCredentialOptions): Promise<void>; + + /** + * Reports a browser-side error encountered during the WebAuthn `navigator.credentials.create()` operation. + * This method sends the error details to the server. + * + * @param {ReportBrowserErrorOptions} payload - The browser error details and any custom options. + * @returns {Promise<void>} A promise that resolves when the error report is successfully submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment + * // In the catch block of an attempted passkey creation (e.g. from submitPasskeyCredential): + * } catch (webAuthnError) { + * if (webAuthnError.name) { // Check if it's likely a WebAuthn API error + * await sdk.reportBrowserError({ error: { name: webAuthnError.name, message: webAuthnError.message } }); + * } + * // Update UI to show error message to the user + * } + * ``` + */ + reportBrowserError(payload: ReportBrowserErrorOptions): Promise<void>; + + /** + * Allows the user to snooze or postpone the WebAuthn platform enrollment. + * This action typically means the user will be reminded to enroll at a later time. + * + * @param {CustomOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the snooze action is successfully submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment + * await sdk.snoozeEnrollment(); + * ``` + */ + snoozeEnrollment(payload?: CustomOptions): Promise<void>; + + /** + * Allows the user to refuse WebAuthn platform enrollment on the current device. + * This action indicates the user does not want to use a platform authenticator on this specific device. + * + * @param {CustomOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the refusal action is successfully submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment + * await sdk.refuseEnrollmentOnThisDevice(); + * ``` + */ + refuseEnrollmentOnThisDevice(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment">ScreenMembersOnMfaWebAuthnPlatformEnrollment</a></span>} required> + The screen object with MFA WebAuthn Platform Enrollment specific data structure. +</ParamField> + +<ParamField path="submitPasskeyCredential" type={<span>Promise<void></span>} required> + Initiates the WebAuthn platform credential creation process using the public key options available on `this.screen.publicKey` and submits the resulting credential to the server. This method internally calls `createPasskeyCredentials` (which wraps `navigator.credentials.create()`). +</ParamField> + +<ParamField path="reportBrowserError" type={<span>Promise<void></span>} required> + Reports a browser-side error encountered during the WebAuthn `navigator.credentials.create()` operation. This method sends the error details to the server. +</ParamField> + +<ParamField path="snoozeEnrollment" type={<span>Promise<void></span>} required> + Allows the user to snooze or postpone the WebAuthn platform enrollment. This action typically means the user will be reminded to enroll at a later time. +</ParamField> + +<ParamField path="refuseEnrollmentOnThisDevice" type={<span>Promise<void></span>} required> + Allows the user to refuse WebAuthn platform enrollment on the current device. This action indicates the user does not want to use a platform authenticator on this specific device. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-platform-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx new file mode 100644 index 000000000..cb7826b5e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx @@ -0,0 +1,142 @@ +--- +title: "MfaWebAuthnRoamingChallengeMembers" +description: "@interface MfaWebAuthnRoamingChallengeMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaWebAuthnRoamingChallengeMembers extends BaseMembers { + /** + * Screen-specific properties and data, including WebAuthn challenge options. + * @type {ScreenMembersOnMfaWebAuthnRoamingChallenge} + */ + screen: ScreenMembersOnMfaWebAuthnRoamingChallenge; + + /** + * Initiates the WebAuthn challenge by calling `navigator.credentials.get()` with the + * options provided in `screen.data.publicKeyChallengeOptions`. + * If successful, it submits the resulting credential to Auth0 with `action: "default"`. + * If `navigator.credentials.get()` fails with a known WebAuthn API error (like `NotAllowedError`), + * this method will internally call `reportWebAuthnError` to inform Auth0. + * + * @param {VerifySecurityKeyOptions} [options] - Optional parameters for the verification process, + * such as `rememberDevice` and other custom options. + * @returns {Promise<void>} A promise that resolves when the verification attempt is submitted. + * It does not directly return data as a successful operation typically results in a redirect. + * @throws {Error} Throws an error if `screen.data.publicKeyChallengeOptions` is missing, + * if `navigator.credentials.get()` fails with an unexpected error, + * or if the form submission to Auth0 fails. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge + * try { + * await sdk.verify({ rememberDevice: true }); + * // On success, Auth0 handles redirection. + * } catch (error) { + * console.error("Security key verification failed:", error); + * // Check sdk.transaction.errors for server-side validation messages if the page reloads. + * } + * ``` + */ + verify(options?: VerifySecurityKeyOptions): Promise<void>; + + /** + * Reports a specific WebAuthn API error to Auth0. + * This method should be used if `navigator.credentials.get()` fails in a way that + * `verify()` doesn't automatically handle, or if the developer wants to explicitly + * report an error before trying another action. + * It submits the error details with `action: "showError::{errorDetails}"`. + * + * @param {ReportWebAuthnErrorOptions} options - Contains the `error` object with `name` and `message` + * from the WebAuthn API, and any other custom options. + * @returns {Promise<void>} A promise that resolves when the error report is submitted. + * @throws {Error} Throws an error if the form submission fails. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge + * // And webAuthnError is an error object from a failed navigator.credentials.get() call. + * try { + * await sdk.reportWebAuthnError({ + * error: { name: webAuthnError.name, message: webAuthnError.message } + * }); + * } catch (submitError) { + * console.error("Failed to report WebAuthn error:", submitError); + * } + * ``` + */ + reportWebAuthnError(options: ReportWebAuthnErrorOptions): Promise<void>; + + /** + * Allows the user to opt-out of the WebAuthn challenge and select a different MFA method. + * This action submits `action: "pick-authenticator"` to Auth0, which should navigate + * the user to an MFA factor selection screen. + * + * @param {TryAnotherMethodOptions} [options] - Optional custom parameters for the request. + * @returns {Promise<void>} A promise that resolves when the action is submitted. + * @throws {Error} Throws an error if the form submission fails. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge + * try { + * await sdk.tryAnotherMethod(); + * // On success, Auth0 handles redirection to MFA selection. + * } catch (error) { + * console.error("Failed to switch MFA method:", error); + * } + * ``` + */ + tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge">ScreenMembersOnMfaWebAuthnRoamingChallenge</a></span>} required> + Screen-specific properties and data, including WebAuthn challenge options. +</ParamField> + +<ParamField path="verify" type={<span>Promise<void></span>} required> + Initiates the WebAuthn challenge by calling `navigator.credentials.get()` with the options provided in `screen.data.publicKeyChallengeOptions`. If successful, it submits the resulting credential to Auth0 with `action: "default"`. If `navigator.credentials.get()` fails with a known WebAuthn API error (like `NotAllowedError`), this method will internally call `reportWebAuthnError` to inform Auth0. +</ParamField> + +<ParamField path="reportWebAuthnError" type={<span>Promise<void></span>} required> + Reports a specific WebAuthn API error to Auth0. This method should be used if `navigator.credentials.get()` fails in a way that `verify()` doesn't automatically handle, or if the developer wants to explicitly report an error before trying another action. It submits the error details with `action: "showError::"`. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows the user to opt-out of the WebAuthn challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate the user to an MFA factor selection screen. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx new file mode 100644 index 000000000..f2a5cb78f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx @@ -0,0 +1,119 @@ +--- +title: "MfaWebAuthnRoamingEnrollmentMembers" +description: "Interface defining the available methods and properties for the mfa-webauthn-roaming-enrollment screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaWebAuthnRoamingEnrollmentMembers extends BaseMembers { + screen: ScreenMembersOnMfaWebAuthnRoamingEnrollment; + /** + * Initiates the WebAuthn credential creation and submits the result to the server. + * This corresponds to the user interacting with the FIDO Security Keys prompt. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + * + * const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); + * try { + * // This will trigger the browser's WebAuthn prompt + * const credential = await navigator.credentials.create({ publicKey: webauthnEnrollment.screen.data.passkey.public_key }); + * // You would typically serialize the credential response here + * const response = JSON.stringify(credential); + * await webauthnEnrollment.enroll({ response }); + * } catch (error) { + * console.error('WebAuthn enrollment failed:', error); + * // Handle the error, e.g., show an error message to the user or submit the error details + * // await webauthnEnrollment.showError({ error: { name: error.name, message: error.message } }); + * } + * ``` + */ + enroll(payload: CustomOptions): Promise<void>; + /** + * Submits details about a WebAuthn browser error to the server. + * This is used when the browser's WebAuthn API encounters an error. + * @param payload The options containing the error details. + * @example + * ```typescript + * import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + * + * const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); + * // Example error handler for the browser's WebAuthn API call + * const handleError = async (error: any) => { + * console.error('WebAuthn error:', error); + * await webauthnEnrollment.showError({ + * error: { + * name: error.name, + * message: error.message, + * // Include other relevant error properties if available + * }, + * }); + * }; + * // ... use handleError in your WebAuthn API call's catch block + * ``` + */ + showError(payload: ShowErrorOptions): Promise<void>; + /** + * Allows the user to try another MFA method. + * This corresponds to the "Try Another Method" button. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + * + * const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); + * await webauthnEnrollment.tryAnotherMethod(); + * ``` + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment">ScreenMembersOnMfaWebAuthnRoamingEnrollment</a></span>} required> +</ParamField> + +<ParamField path="enroll" type={<span>Promise<void></span>} required> + Initiates the WebAuthn credential creation and submits the result to the server. This corresponds to the user interacting with the FIDO Security Keys prompt. +</ParamField> + +<ParamField path="showError" type={<span>Promise<void></span>} required> + Submits details about a WebAuthn browser error to the server. This is used when the browser's WebAuthn API encounters an error. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows the user to try another MFA method. This corresponds to the "Try Another Method" button. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-roaming-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext.mdx new file mode 100644 index 000000000..0d6c896f7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext.mdx @@ -0,0 +1,65 @@ +--- +title: "OrganizationContext" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface OrganizationContext { + id: string; + name: string; + usage: string; + display_name?: string; + branding?: { + logo_url?: string; + colors?: { + primary?: string; + page_background?: string; + }; + }; + metadata?: { + [key: string]: string; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="id" type={<span>string</span>} required> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="usage" type={<span>string</span>} required> +</ParamField> + +<ParamField path="display_name" type={<span>string</span>}> +</ParamField> + +<ParamField path="branding" type="object"> + <Expandable title="properties"> + <ParamField path="logo_url" type={<span>string</span>}> + </ParamField> + <ParamField path="colors" type="object"> + <Expandable title="properties"> + <ParamField path="primary" type={<span>string</span>}> + </ParamField> + <ParamField path="page_background" type={<span>string</span>}> + </ParamField> + </Expandable> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="metadata" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/models/organization.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/organization.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers.mdx new file mode 100644 index 000000000..c7293b2d9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers.mdx @@ -0,0 +1,45 @@ +--- +title: "OrganizationMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface OrganizationMembers { + id: string | null; + name: string | null; + usage: string | null; + displayName: string | null; + branding: Branding | null; + metadata: { [key: string]: string } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="id" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="name" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="usage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="displayName" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding">Branding</a> | null</span>}> +</ParamField> + +<ParamField path="metadata" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/models/organization.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/organization.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationPickerMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationPickerMembers.mdx new file mode 100644 index 000000000..6c8cc079a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationPickerMembers.mdx @@ -0,0 +1,65 @@ +--- +title: "OrganizationPickerMembers" +description: "Interface defining the available methods and properties for the organization-picker screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface OrganizationPickerMembers extends BaseMembers { + /** + * Selects an organization for the user. + * @param payload The options containing the organization ID. + */ + selectOrganization(payload: { organization: string; state: string }): Promise<void>; + + /** + * Skips the organization selection, proceeding with the user's personal account. + * @param payload Optional custom options to include with the request. + */ + skipOrganizationSelection(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="selectOrganization" type={<span>Promise<void></span>} required> + Selects an organization for the user. +</ParamField> + +<ParamField path="skipOrganizationSelection" type={<span>Promise<void></span>} required> + Skips the organization selection, proceeding with the user's personal account. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/organization-picker.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/organization-picker.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationSelectionMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationSelectionMembers.mdx new file mode 100644 index 000000000..f1a9d7185 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationSelectionMembers.mdx @@ -0,0 +1,60 @@ +--- +title: "OrganizationSelectionMembers" +description: "Interface defining the available methods and properties for the organization-selection screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface OrganizationSelectionMembers extends BaseMembers { + /** + * The screen properties. + */ + screen: ScreenMembersOnOrganizationSelection; + /** + * Continues with the selected organization name. + * @param payload The options containing the organization name. + */ + continueWithOrganizationName(payload: ContinueWithOrganizationNameOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnOrganizationSelection">ScreenMembersOnOrganizationSelection</a></span>} required> + The screen properties. +</ParamField> + +<ParamField path="continueWithOrganizationName" type={<span>Promise<void></span>} required> + Continues with the selected organization name. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/organization-selection.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/organization-selection.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Organizations.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Organizations.mdx new file mode 100644 index 000000000..51607ed9f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Organizations.mdx @@ -0,0 +1,35 @@ +--- +title: "Organizations" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface Organizations { + organizationId: string | undefined; + organizationName: string | undefined; + displayName: string | undefined; + branding: Branding; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="organizationId" type={<span>string | undefined</span>}> +</ParamField> + +<ParamField path="organizationName" type={<span>string | undefined</span>}> +</ParamField> + +<ParamField path="displayName" type={<span>string | undefined</span>}> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding">Branding</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/models/user.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/user.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OtpCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OtpCodeOptions.mdx new file mode 100644 index 000000000..40434a06e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OtpCodeOptions.mdx @@ -0,0 +1,30 @@ +--- +title: "OtpCodeOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface OtpCodeOptions extends CustomOptions { + /** + * The OTP code that the user enters to submit. + */ + code: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="code" type={<span>string</span>} required> + The OTP code that the user enters to submit. +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/email-otp-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Passkey.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Passkey.mdx new file mode 100644 index 000000000..5101ab0a8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Passkey.mdx @@ -0,0 +1,23 @@ +--- +title: "Passkey" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface Passkey { + enabled: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="enabled" type={<span>boolean</span>} required> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate.mdx new file mode 100644 index 000000000..1de630648 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate.mdx @@ -0,0 +1,85 @@ +--- +title: "PasskeyCreate" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PasskeyCreate { + public_key: { + user: { + id: string; + name: string; + displayName: string; + }; + rp: { + id: string; + name: string; + }; + challenge: string; + pubKeyCredParams: [ + { + type: string; + alg: number; + }, + ]; + authenticatorSelection: { + residentKey: string; + userVerification: string; + authenticatorAttachment?: string; + }; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="public_key" type="object" required> + <Expandable title="properties"> + <ParamField path="user" type="object" required> + <Expandable title="properties"> + <ParamField path="id" type={<span>string</span>} required> + </ParamField> + <ParamField path="name" type={<span>string</span>} required> + </ParamField> + <ParamField path="displayName" type={<span>string</span>} required> + </ParamField> + </Expandable> + </ParamField> + <ParamField path="rp" type="object" required> + <Expandable title="properties"> + <ParamField path="id" type={<span>string</span>} required> + </ParamField> + <ParamField path="name" type={<span>string</span>} required> + </ParamField> + </Expandable> + </ParamField> + <ParamField path="challenge" type={<span>string</span>} required> + </ParamField> + <ParamField path="pubKeyCredParams" type={<span>array of objects</span>} required> + <Expandable title="properties"> + <ParamField path="type" type={<span>string</span>} required> + </ParamField> + <ParamField path="alg" type={<span>number</span>} required> + </ParamField> + </Expandable> + </ParamField> + <ParamField path="authenticatorSelection" type="object" required> + <Expandable title="properties"> + <ParamField path="residentKey" type={<span>string</span>} required> + </ParamField> + <ParamField path="userVerification" type={<span>string</span>} required> + </ParamField> + <ParamField path="authenticatorAttachment" type={<span>string</span>}> + </ParamField> + </Expandable> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreateResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreateResponse.mdx new file mode 100644 index 000000000..35c286652 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreateResponse.mdx @@ -0,0 +1,39 @@ +--- +title: "PasskeyCreateResponse" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PasskeyCreateResponse { + id: string; + rawId: string | null; + type: string; + authenticatorAttachment: string | null; + response: CredentialResponse; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="id" type={<span>string</span>} required> +</ParamField> + +<ParamField path="rawId" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="type" type={<span>string</span>} required> +</ParamField> + +<ParamField path="authenticatorAttachment" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CredentialResponse">CredentialResponse</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCredentialResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCredentialResponse.mdx new file mode 100644 index 000000000..1d2dbda12 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCredentialResponse.mdx @@ -0,0 +1,58 @@ +--- +title: "PasskeyCredentialResponse" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PasskeyCredentialResponse { + id: string; + rawId: string | null; + type: string; + authenticatorAttachment: string | null; + response: { + clientDataJSON: string | null; + authenticatorData: string | null; + signature: string | null; + userHandle: string | null; + }; + isUserVerifyingPlatformAuthenticatorAvailable: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="id" type={<span>string</span>} required> +</ParamField> + +<ParamField path="rawId" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="type" type={<span>string</span>} required> +</ParamField> + +<ParamField path="authenticatorAttachment" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="response" type="object"> + <Expandable title="properties"> + <ParamField path="clientDataJSON" type={<span>string | null</span>}> + </ParamField> + <ParamField path="authenticatorData" type={<span>string | null</span>}> + </ParamField> + <ParamField path="signature" type={<span>string | null</span>}> + </ParamField> + <ParamField path="userHandle" type={<span>string | null</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="isUserVerifyingPlatformAuthenticatorAvailable" type={<span>boolean</span>} required> +</ParamField> + +--- + +**File:** [interfaces/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnroll.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnroll.mdx new file mode 100644 index 000000000..91c16ad3a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnroll.mdx @@ -0,0 +1,85 @@ +--- +title: "PasskeyEnroll" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PasskeyEnroll extends Passkey { + public_key: { + user: { + id: ArrayBuffer; + name: string; + displayName: string; + }; + rp: { + id: string; + name: string; + }; + challenge: ArrayBuffer; + pubKeyCredParams: [ + { + type: string; + alg: number; + }, + ]; + authenticatorSelection: { + residentKey: string; + userVerification: string; + }; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="public_key" type="object" required> + <Expandable title="properties"> + <ParamField path="user" type="object" required> + <Expandable title="properties"> + <ParamField path="id" type={<span>ArrayBuffer</span>} required> + </ParamField> + <ParamField path="name" type={<span>string</span>} required> + </ParamField> + <ParamField path="displayName" type={<span>string</span>} required> + </ParamField> + </Expandable> + </ParamField> + <ParamField path="rp" type="object" required> + <Expandable title="properties"> + <ParamField path="id" type={<span>string</span>} required> + </ParamField> + <ParamField path="name" type={<span>string</span>} required> + </ParamField> + </Expandable> + </ParamField> + <ParamField path="challenge" type={<span>ArrayBuffer</span>} required> + </ParamField> + <ParamField path="pubKeyCredParams" type={<span>array of objects</span>} required> + <Expandable title="properties"> + <ParamField path="type" type={<span>string</span>} required> + </ParamField> + <ParamField path="alg" type={<span>number</span>} required> + </ParamField> + </Expandable> + </ParamField> + <ParamField path="authenticatorSelection" type="object" required> + <Expandable title="properties"> + <ParamField path="residentKey" type={<span>string</span>} required> + </ParamField> + <ParamField path="userVerification" type={<span>string</span>} required> + </ParamField> + </Expandable> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="enabled" type={<span>boolean</span>} required> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollment.mdx new file mode 100644 index 000000000..d24f4003d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollment.mdx @@ -0,0 +1,61 @@ +--- +title: "PasskeyEnrollment" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PasskeyEnrollment extends BaseContext { + screen: ExtendedScreenContext; +} +``` + +```typescript Enroll with Passkey local +import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; + +const passkeyEnrollment = new PasskeyEnrollment(); +passkeyEnrollment.continuePasskeyEnrollment(); +``` + +```typescript Abort passkey enrolment local +import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; + +const passkeyEnrollment = new PasskeyEnrollment(); +passkeyEnrollment.abortPasskeyEnrollment(); +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext">ExtendedScreenContext</a></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> +</ParamField> + +<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/passkey-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocal.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocal.mdx new file mode 100644 index 000000000..27d355f4b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocal.mdx @@ -0,0 +1,157 @@ +--- +title: "PasskeyEnrollmentLocal" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PasskeyEnrollmentLocal extends BaseContext { + screen: ExtendedScreenContext; +} +``` + +```typescript continuePasskeyEnrollment +import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment-local'; + +// Create an instance of PasskeyEnrollment to handle the enrollment process +const passkeyEnrollment = new PasskeyEnrollment(); + +// Begin the passkey enrollment process for local authentication +// This will trigger the necessary flow for the user to enroll their passkey +passkeyEnrollment.continuePasskeyEnrollment(); +``` + +```typescript Abort local passkey enrolment +import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment-local'; + +const passkeyEnrollment = new PasskeyEnrollmentLocal(); +passkeyEnrollment.abortPasskeyEnrollment({ + doNotShowAgain: <boolean> +}); +``` + +```typescript PasskeyEnrollmentLocal React Example +import React, { useState } from 'react'; +import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local'; + +const PasskeyEnrollmentLocalScreen: React.FC = () => { + const [error, setError] = useState(''); + const [success, setSuccess] = useState(false); + const [aborted, setAborted] = useState(false); + const [doNotShowAgain, setDoNotShowAgain] = useState(false); + + const passkeyEnrollment = new PasskeyEnrollmentLocal(); + + const handleContinue = async (e) => { + e.preventDefault(); + setError(''); + setSuccess(false); + setAborted(false); + try { + await passkeyEnrollment.continuePasskeyEnrollment(); + setSuccess(true); + } catch (err) { + setError('Failed to enroll passkey. Please try again.'); + } + }; + + const handleAbort = async (e) => { + e.preventDefault(); + setError(''); + setSuccess(false); + setAborted(false); + try { + await passkeyEnrollment.abortPasskeyEnrollment({ doNotShowAgain }); + setAborted(true); + } catch (err) { + setError('Failed to abort enrollment. Please try again.'); + } + }; + + return ( + <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> + <div className="sm:mx-auto sm:w-full sm:max-w-md"> + <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> + Passkey Enrollment (Local) + </h2> + </div> + <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> + <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> + <form className="space-y-6" onSubmit={handleContinue}> + <div className="flex flex-col gap-2"> + <button + type="submit" + className="w-full py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" + > + Continue Passkey Enrollment + </button> + </div> + </form> + <form className="space-y-6 mt-4" onSubmit={handleAbort}> + <div className="flex items-center"> + <input + id="doNotShowAgain" + name="doNotShowAgain" + type="checkbox" + checked={doNotShowAgain} + onChange={(e) => setDoNotShowAgain(e.target.checked)} + className="h-4 w-4 text-blue-600 focus:ring-blue-500 border-gray-300 rounded" + /> + <label htmlFor="doNotShowAgain" className="ml-2 block text-sm text-gray-900"> + Do not show again + </label> + </div> + <button + type="submit" + className="w-full py-2 px-4 border border-red-600 rounded-md shadow-sm text-sm font-medium text-red-600 bg-white hover:bg-red-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-red-500" + > + Abort Enrollment + </button> + </form> + {error && <div className="text-red-600 text-sm mt-2">{error}</div>} + {success && <div className="text-green-600 text-sm mt-2">Passkey enrollment successful!</div>} + {aborted && <div className="text-blue-600 text-sm mt-2">Passkey enrollment aborted.</div>} + </div> + </div> + </div> + ); +}; + +export default PasskeyEnrollmentLocalScreen; +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext">ExtendedScreenContext</a></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> +</ParamField> + +<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/passkey-enrollment-local.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocalMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocalMembers.mdx new file mode 100644 index 000000000..0bdbe69ed --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocalMembers.mdx @@ -0,0 +1,55 @@ +--- +title: "PasskeyEnrollmentLocalMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PasskeyEnrollmentLocalMembers extends BaseMembers { + screen: ScreenMembersOnPasskeyEnrollmentLocal; + continuePasskeyEnrollment(payload?: CustomOptions): Promise<void>; + abortPasskeyEnrollment(payload: AbortEnrollmentOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollmentLocal">ScreenMembersOnPasskeyEnrollmentLocal</a></span>} required> +</ParamField> + +<ParamField path="continuePasskeyEnrollment" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="abortPasskeyEnrollment" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/passkey-enrollment-local.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentMembers.mdx new file mode 100644 index 000000000..a11d44416 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentMembers.mdx @@ -0,0 +1,55 @@ +--- +title: "PasskeyEnrollmentMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PasskeyEnrollmentMembers extends BaseMembers { + screen: ScreenMembersOnPasskeyEnrollment; + continuePasskeyEnrollment(payload?: CustomOptions): Promise<void>; + abortPasskeyEnrollment(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollment">ScreenMembersOnPasskeyEnrollment</a></span>} required> +</ParamField> + +<ParamField path="continuePasskeyEnrollment" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="abortPasskeyEnrollment" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/passkey-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyLogin.mdx new file mode 100644 index 000000000..60d00d254 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyLogin.mdx @@ -0,0 +1,32 @@ +--- +title: "PasskeyLogin" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PasskeyLogin extends Passkey { + public_key: { + challenge: ArrayBuffer; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="public_key" type="object" required> + <Expandable title="properties"> + <ParamField path="challenge" type={<span>ArrayBuffer</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="enabled" type={<span>boolean</span>} required> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead.mdx new file mode 100644 index 000000000..501832b08 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead.mdx @@ -0,0 +1,32 @@ +--- +title: "PasskeyRead" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PasskeyRead { + public_key: { + challenge: Base64URLString; + allowCredentials?: AllowCredential[]; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="public_key" type="object" required> + <Expandable title="properties"> + <ParamField path="challenge" type={<span>Base64URLString</span>} required> + </ParamField> + <ParamField path="allowCredentials" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AllowCredential">AllowCredential[]</a></span>}> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule.mdx new file mode 100644 index 000000000..786d3d073 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule.mdx @@ -0,0 +1,55 @@ +--- +title: "PasswordComplexityRule" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PasswordComplexityRule { + code: string; + label: string; + status: 'valid' | 'error'; + isValid: boolean; + args?: { + count: number; + total?: number; + example?: string; + }; + items?: PasswordComplexityRule[]; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="code" type={<span>string</span>} required> +</ParamField> + +<ParamField path="label" type={<span>string</span>} required> +</ParamField> + +<ParamField path="status" type={<span>'valid' | 'error'</span>} required> +</ParamField> + +<ParamField path="isValid" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="args" type="object"> + <Expandable title="properties"> + <ParamField path="count" type={<span>number</span>} required> + </ParamField> + <ParamField path="total" type={<span>number</span>}> + </ParamField> + <ParamField path="example" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="items" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule">PasswordComplexityRule[]</a></span>}> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy.mdx new file mode 100644 index 000000000..e65033d2a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy.mdx @@ -0,0 +1,35 @@ +--- +title: "PasswordPolicy" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PasswordPolicy { + enabled?: boolean; + minLength?: number; + policy: 'none' | 'low' | 'fair' | 'good' | 'excellent'; + passwordSecurityInfo?: PasswordComplexityRule[]; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="enabled" type={<span>boolean</span>}> +</ParamField> + +<ParamField path="minLength" type={<span>number</span>}> +</ParamField> + +<ParamField path="policy" type={<span>'none' | 'low' | 'fair' | 'good' | 'excellent'</span>} required> +</ParamField> + +<ParamField path="passwordSecurityInfo" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule">PasswordComplexityRule[]</a></span>}> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult.mdx new file mode 100644 index 000000000..14623ce0f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult.mdx @@ -0,0 +1,42 @@ +--- +title: "PasswordValidationResult" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PasswordValidationResult { + /** + * Overall outcome of all password policy checks. + * + * `true` only if every rule in {@link PasswordComplexityRule} has `status` equal to `"valid"`. + */ + isValid: boolean; + + /** + * Array of evaluated password rules. + * + * Each item is a {@link PasswordComplexityRule} whose + * {@link PasswordComplexityRule.status | status} field reflects the + * computed validation result for that rule. + */ + results: PasswordComplexityRule[]; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="isValid" type={<span>boolean</span>} required> + Overall outcome of all password policy checks. `true` only if every rule in has `status` equal to `"valid"`. +</ParamField> + +<ParamField path="results" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule">PasswordComplexityRule[]</a></span>} required> + Array of evaluated password rules. Each item is a whose field reflects the computed validation result for that rule. +</ParamField> + +--- + +**File:** [interfaces/utils/validate-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/validate-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordlessConnection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordlessConnection.mdx new file mode 100644 index 000000000..ef5e836ea --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordlessConnection.mdx @@ -0,0 +1,38 @@ +--- +title: "PasswordlessConnection" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PasswordlessConnection extends Connection { + options: { + signup_enabled: boolean; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="options" type="object" required> + <Expandable title="properties"> + <ParamField path="signup_enabled" type={<span>boolean</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="strategy" type={<span>string</span>} required> +</ParamField> + +<ParamField path="metadata" type={<span>Record<string, string></span>}> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneChallengeOptions.mdx new file mode 100644 index 000000000..57b91a497 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneChallengeOptions.mdx @@ -0,0 +1,31 @@ +--- +title: "PhoneChallengeOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PhoneChallengeOptions { + code: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="code" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captcha" type={<span>string</span>}> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/phone-identifier-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneEnrollmentOptions.mdx new file mode 100644 index 000000000..0b4c5cd1f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneEnrollmentOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "PhoneEnrollmentOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PhoneEnrollmentOptions { + type: 'text' | 'voice'; + [key: string]: string | number | boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="type" type={<span>'text' | 'voice'</span>} required> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean</span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/phone-identifier-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierChallengeMembers.mdx new file mode 100644 index 000000000..64d2118a8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierChallengeMembers.mdx @@ -0,0 +1,71 @@ +--- +title: "PhoneIdentifierChallengeMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PhoneIdentifierChallengeMembers extends BaseMembers { + screen: ScreenMembersOnPhoneIdentifierChallenge; + submitPhoneChallenge(payload: PhoneChallengeOptions): Promise<void>; + resendCode(payload?: CustomOptions): Promise<void>; + resendManager(options?: StartResendOptions): ResendControl; + returnToPrevious(payload?: CustomOptions): Promise<void>; + switchToVoice(payload?: CustomOptions): Promise<void>; + switchToText(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierChallenge">ScreenMembersOnPhoneIdentifierChallenge</a></span>} required> +</ParamField> + +<ParamField path="submitPhoneChallenge" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="resendCode" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> +</ParamField> + +<ParamField path="returnToPrevious" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="switchToVoice" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="switchToText" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/phone-identifier-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierEnrollmentMembers.mdx new file mode 100644 index 000000000..4cffaf8c0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierEnrollmentMembers.mdx @@ -0,0 +1,55 @@ +--- +title: "PhoneIdentifierEnrollmentMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PhoneIdentifierEnrollmentMembers extends BaseMembers { + screen: ScreenMembersOnPhoneIdentifierEnrollment; + continuePhoneEnrollment(payload: PhoneEnrollmentOptions): Promise<void>; + returnToPrevious(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierEnrollment">ScreenMembersOnPhoneIdentifierEnrollment</a></span>} required> +</ParamField> + +<ParamField path="continuePhoneEnrollment" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="returnToPrevious" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/phone-identifier-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix.mdx new file mode 100644 index 000000000..8e1e56e44 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix.mdx @@ -0,0 +1,37 @@ +--- +title: "PhonePrefix" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PhonePrefix { + /** The country name */ + country: string; + /** The country code (e.g. 'US', 'GB') */ + country_code: string; + /** The phone prefix (e.g. '+1', '+44') */ + phone_prefix: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="country" type={<span>string</span>} required> + The country name +</ParamField> + +<ParamField path="country_code" type={<span>string</span>} required> + The country code (e.g. 'US', 'GB') +</ParamField> + +<ParamField path="phone_prefix" type={<span>string</span>} required> + The phone prefix (e.g. '+1', '+44') +</ParamField> + +--- + +**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickAuthenticatorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickAuthenticatorOptions.mdx new file mode 100644 index 000000000..8a4ea18d0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickAuthenticatorOptions.mdx @@ -0,0 +1,21 @@ +--- +title: "PickAuthenticatorOptions" +description: "@interface PickAuthenticatorOptions Defines the options for the 'pick-authenticator' action. This allows the user to choose a different MFA method if available." +--- + +<RequestExample> + +```typescript Interface lines +export interface PickAuthenticatorOptions extends CustomOptions {} +``` + +</RequestExample> + +## Properties + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-phone-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickPhoneOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickPhoneOptions.mdx new file mode 100644 index 000000000..79d20a985 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickPhoneOptions.mdx @@ -0,0 +1,21 @@ +--- +title: "PickPhoneOptions" +description: "@interface PickPhoneOptions Defines the options for the 'pick-phone' action. Although the interface only shows one phone number, this action might be used in scenarios where the server needs to redirect to a phone selection screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface PickPhoneOptions extends CustomOptions {} +``` + +</RequestExample> + +## Properties + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-phone-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PostPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PostPayloadOptions.mdx new file mode 100644 index 000000000..55ef89597 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PostPayloadOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "PostPayloadOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PostPayloadOptions { + state: string; + [key: string]: string | number | boolean | null | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | null | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/utils/form-handler.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/form-handler.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext.mdx new file mode 100644 index 000000000..213c25862 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext.mdx @@ -0,0 +1,23 @@ +--- +title: "PromptContext" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PromptContext { + name: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +--- + +**File:** [interfaces/models/prompt.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/prompt.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers.mdx new file mode 100644 index 000000000..cd6379765 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers.mdx @@ -0,0 +1,23 @@ +--- +title: "PromptMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface PromptMembers { + name: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +--- + +**File:** [interfaces/models/prompt.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/prompt.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/RedeemTicketMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/RedeemTicketMembers.mdx new file mode 100644 index 000000000..b64bfe50c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/RedeemTicketMembers.mdx @@ -0,0 +1,70 @@ +--- +title: "RedeemTicketMembers" +description: "Interface describing the data available on the Redeem Ticket screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface RedeemTicketMembers extends BaseMembers { + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + transaction: TransactionMembers; + + /** + * Performs the default action on the redeem-ticket screen, which usually involves continuing the flow. + * @param {CustomOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the action is complete. + * @throws {Error} If the operation fails. + * @example + * ```typescript + * import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; + * + * const redeemTicket = new RedeemTicket(); + * await redeemTicket.continue(); + * ``` + */ + continue(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Performs the default action on the redeem-ticket screen, which usually involves continuing the flow. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/redeem-ticket.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions.mdx new file mode 100644 index 000000000..50fda0d7d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions.mdx @@ -0,0 +1,30 @@ +--- +title: "ReportBrowserErrorOptions" +description: "@interface ReportBrowserErrorOptions" +--- + +<RequestExample> + +```typescript Interface lines +export interface ReportBrowserErrorOptions { + /** + * The error object from the WebAuthn API. This typically is a `DOMException`. + * The SDK expects an object with at least `name` and `message` properties. + * @type {WebAuthnErrorDetails} + * @example { name: "NotAllowedError", message: "The operation was cancelled by the user." } + */ + error: WebAuthnErrorDetails; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="error" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>} required> + The error object from the WebAuthn API. This typically is a `DOMException`. The SDK expects an object with at least `name` and `message` properties. +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportWebAuthnErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportWebAuthnErrorOptions.mdx new file mode 100644 index 000000000..e3b3a20c8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportWebAuthnErrorOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "ReportWebAuthnErrorOptions" +description: "@interface ReportWebAuthnErrorOptions" +--- + +<RequestExample> + +```typescript Interface lines +export interface ReportWebAuthnErrorOptions { + error: WebAuthnErrorDetails; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="error" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions.mdx new file mode 100644 index 000000000..f87f94b1d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions.mdx @@ -0,0 +1,25 @@ +--- +title: "ResendCodeOptions" +description: "Options for resending the email code." +--- + +<RequestExample> + +```typescript Interface lines +export interface ResendCodeOptions { + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> + Any additional custom options +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-email-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl.mdx new file mode 100644 index 000000000..37fcfe880 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl.mdx @@ -0,0 +1,23 @@ +--- +title: "ResendControl" +description: "Control object returned by resendManager method" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResendControl { + startResend: () => void; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="startResend" type={<span>() => void</span>} required> +</ParamField> + +--- + +**File:** [interfaces/utils/resend-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/resend-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailMembers.mdx new file mode 100644 index 000000000..efec56e0d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailMembers.mdx @@ -0,0 +1,51 @@ +--- +title: "ResetPasswordEmailMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordEmailMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordEmail; + resendEmail(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordEmail">ScreenMembersOnResetPasswordEmail</a></span>} required> +</ParamField> + +<ParamField path="resendEmail" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-email.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailOptions.mdx new file mode 100644 index 000000000..c0ffe9470 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "ResetPasswordEmailOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordEmailOptions { + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-email.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorMembers.mdx new file mode 100644 index 000000000..a979164be --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorMembers.mdx @@ -0,0 +1,47 @@ +--- +title: "ResetPasswordErrorMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordErrorMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordError; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordError">ScreenMembersOnResetPasswordError</a></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-error.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorOptions.mdx new file mode 100644 index 000000000..10d6171ce --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "ResetPasswordErrorOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordErrorOptions { + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-error.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMembers.mdx new file mode 100644 index 000000000..31991de1f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMembers.mdx @@ -0,0 +1,56 @@ +--- +title: "ResetPasswordMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordMembers extends BaseMembers { + screen: ScreenMembersOnResetPassword; + transaction: TransactionMembersOnResetPassword; + resetPassword(payload: ResetPasswordOptions): Promise<void>; + validatePassword(password: string): PasswordValidationResult; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPassword">ScreenMembersOnResetPassword</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPassword">TransactionMembersOnResetPassword</a></span>} required> +</ParamField> + +<ParamField path="resetPassword" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="validatePassword" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx new file mode 100644 index 000000000..d2a6ff773 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx @@ -0,0 +1,87 @@ +--- +title: "ResetPasswordMfaEmailChallengeMembers" +description: "Interface defining the available methods and properties for the reset-password-mfa-email-challenge screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordMfaEmailChallengeMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordMfaEmailChallenge; + + /** + * Continues with the email challenge using the provided code. + * @param payload The options containing the code and rememberDevice flag. + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Resends the email code. + * @param payload Optional custom options to include with the request. + */ + resendCode(payload?: ResendCodeOptions): Promise<void>; + + /** + * Allows the user to try another MFA method. + * @param payload Optional custom options to include with the request. + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; + + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge">ScreenMembersOnResetPasswordMfaEmailChallenge</a></span>} required> +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Continues with the email challenge using the provided code. +</ParamField> + +<ParamField path="resendCode" type={<span>Promise<void></span>} required> + Resends the email code. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows the user to try another MFA method. +</ParamField> + +<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> + Gets resend functionality with timeout management for this screen +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-email-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx new file mode 100644 index 000000000..c3ab62c5c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx @@ -0,0 +1,64 @@ +--- +title: "ResetPasswordMfaOtpChallengeMembers" +description: "Interface defining the available methods and properties for the reset-password-mfa-otp-challenge screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordMfaOtpChallengeMembers extends BaseMembers { + /** + * Continues with the OTP challenge using the provided code. + * @param payload The options containing the code. + */ + continue(payload: ContinueOptions): Promise<void>; + /** + * Allows the user to try another MFA method. + * @param payload Optional custom options to include with the request. + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Continues with the OTP challenge using the provided code. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows the user to try another MFA method. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-otp-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx new file mode 100644 index 000000000..4243269cc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx @@ -0,0 +1,133 @@ +--- +title: "ResetPasswordMfaPhoneChallengeMembers" +description: "@interface ResetPasswordMfaPhoneChallengeMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordMfaPhoneChallengeMembers extends BaseMembers { + /** + * Access to client-specific information (e.g., client ID, name). + * @type {ClientMembers} + */ + client: ClientMembers; + + /** + * Access to organization-specific information, if applicable. + * @type {OrganizationMembers} + */ + organization: OrganizationMembers; + + /** + * Access to prompt details (e.g., prompt name). + * @type {PromptMembers} + */ + prompt: PromptMembers; + + /** + * Access to the specific properties and data of the 'reset-password-mfa-phone-challenge' screen. + * @type {ScreenMembersOnResetPasswordMfaPhoneChallenge} + */ + screen: ScreenMembersOnResetPasswordMfaPhoneChallenge; + + /** + * Access to the current transaction details (e.g., state, errors). + * @type {TransactionMembers} + */ + transaction: TransactionMembers; + + /** + * Sends the verification code to the user's phone via the specified method (SMS or Voice). + * This action corresponds to the user clicking the "Send Code via SMS" or "Send Code via Voice Call" button. + * It triggers the Auth0 backend to initiate the code delivery process. + * + * @param {ContinueOptions} payload - The options specifying the delivery type ('sms' or 'voice') and any custom data. + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted to the server. + * @throws {Error} Throws an error if the submission fails (e.g., network issue, invalid state). + * @example + * ```typescript + * import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; + * + * const screen = new ResetPasswordMfaPhoneChallenge(); + * + * // Send code via SMS + * await screen.continue({ type: 'sms' }); + * + * // Send code via Voice Call + * await screen.continue({ type: 'voice' }); + * ``` + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Navigates the user to the screen where they can select an alternative MFA method. + * This action corresponds to the user clicking a "Try Another Method" button. + * + * @param {TryAnotherMethodOptions} payload - The options specifying the current challenge type (`sms` or `voice`) and any custom data. The `type` field is necessary to inform the backend which flow the user is navigating away from. + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted to the server. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; + * + * const screen = new ResetPasswordMfaPhoneChallenge(); + * + * // If the user was presented with SMS option initially: + * await screen.tryAnotherMethod({ type: 'sms' }); + * + * // If the user was presented with Voice option initially: + * await screen.tryAnotherMethod({ type: 'voice' }); + * ``` + */ + tryAnotherMethod(payload: TryAnotherMethodOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> + Access to client-specific information (e.g., client ID, name). +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> + Access to organization-specific information, if applicable. +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> + Access to prompt details (e.g., prompt name). +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge">ScreenMembersOnResetPasswordMfaPhoneChallenge</a></span>} required> + Access to the specific properties and data of the 'reset-password-mfa-phone-challenge' screen. +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> + Access to the current transaction details (e.g., state, errors). +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Sends the verification code to the user's phone via the specified method (SMS or Voice). This action corresponds to the user clicking the "Send Code via SMS" or "Send Code via Voice Call" button. It triggers the Auth0 backend to initiate the code delivery process. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Navigates the user to the screen where they can select an alternative MFA method. This action corresponds to the user clicking a "Try Another Method" button. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-phone-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx new file mode 100644 index 000000000..f5572380d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx @@ -0,0 +1,97 @@ +--- +title: "ResetPasswordMfaPushChallengePushMembers" +description: "Interface defining the available methods and properties for the reset-password-mfa-push-challenge-push screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordMfaPushChallengePushMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordMfaPushChallengePush; + + /** + * Continues with the push notification challenge + * @param payload Optional custom options to include with the request + */ + continue(payload?: CustomOptions): Promise<void>; + + /** + * Resends the push notification + * @param payload Optional custom options to include with the request + */ + resendPushNotification(payload?: CustomOptions): Promise<void>; + + /** + * Switches to entering the verification code manually + * @param payload Optional custom options to include with the request + */ + enterCodeManually(payload?: CustomOptions): Promise<void>; + + /** + * Allows trying another authentication method + * @param payload Optional custom options to include with the request + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + + /** + * Allows polling for the push notification challenge to be approved. + * @param options of type {@link MfaPollingOptions} + */ + pollingManager(options?: MfaPollingOptions): MfaPushPollingControl; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush">ScreenMembersOnResetPasswordMfaPushChallengePush</a></span>} required> +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Continues with the push notification challenge +</ParamField> + +<ParamField path="resendPushNotification" type={<span>Promise<void></span>} required> + Resends the push notification +</ParamField> + +<ParamField path="enterCodeManually" type={<span>Promise<void></span>} required> + Switches to entering the verification code manually +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows trying another authentication method +</ParamField> + +<ParamField path="pollingManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>} required> + Allows polling for the push notification challenge to be approved. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-push-challenge-push.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx new file mode 100644 index 000000000..6de2a8959 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx @@ -0,0 +1,74 @@ +--- +title: "ResetPasswordMfaRecoveryCodeChallengeMembers" +description: "Interface describing the members of the Mfa Recovery Code Challenge screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordMfaRecoveryCodeChallengeMembers extends BaseMembers { + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + transaction: TransactionMembers; + + /** + * Continues with the provided recovery code. + * @param {string} code - The recovery code entered by the user. + * @param {CustomOptions} [payload] - Optional payload. + * @returns {Promise<void>} + */ + continue(code: string, payload?: CustomOptions): Promise<void>; + + /** + * Navigates to the screen where the user can pick another MFA method. + * @param {CustomOptions} [payload] - Optional payload. + * @returns {Promise<void>} + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Continues with the provided recovery code. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Navigates to the screen where the user can pick another MFA method. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx new file mode 100644 index 000000000..56d4b443b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx @@ -0,0 +1,72 @@ +--- +title: "ResetPasswordMfaSmsChallengeMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordMfaSmsChallengeMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordMfaSmsChallenge; + continueMfaSmsChallenge(payload: MfaSmsChallengeOptions): Promise<void>; + resendCode(payload?: CustomOptions): Promise<void>; + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + getACall(payload?: CustomOptions): Promise<void>; + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge">ScreenMembersOnResetPasswordMfaSmsChallenge</a></span>} required> +</ParamField> + +<ParamField path="continueMfaSmsChallenge" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="resendCode" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="getACall" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> + Gets resend functionality with timeout management for this screen +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-sms-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx new file mode 100644 index 000000000..db78f67da --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx @@ -0,0 +1,111 @@ +--- +title: "ResetPasswordMfaVoiceChallengeMembers" +description: "Interface defining the available methods and properties for the reset-password-mfa-voice-challenge screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordMfaVoiceChallengeMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordMfaVoiceChallenge; + + /** + * Continues with the voice challenge using the provided code. + * + * @param payload - The options containing the code. + * @returns A promise that resolves when the challenge is submitted. + * + * @example + * ```ts + * const reset = new ResetPasswordMfaVoiceChallenge(); + * await reset.continue({ code: '123456' }); + * ``` + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Switches to SMS verification. + * + * @param payload - Optional custom options to include with the request. + * @returns A promise that resolves when the action completes. + */ + switchToSms(payload?: CustomOptions): Promise<void>; + + /** + * Re-sends the code via voice call. + * + * @param payload - Optional custom options to include with the request. + * @returns A promise that resolves when the code is resent. + */ + resendCode(payload?: CustomOptions): Promise<void>; + + /** + * Allows the user to try another MFA method. + * + * @param payload - Optional custom options to include with the request. + * @returns A promise that resolves when the request is submitted. + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge">ScreenMembersOnResetPasswordMfaVoiceChallenge</a></span>} required> +</ParamField> + +<ParamField path="continue" type={<span>Promise<void></span>} required> + Continues with the voice challenge using the provided code. +</ParamField> + +<ParamField path="switchToSms" type={<span>Promise<void></span>} required> + Switches to SMS verification. +</ParamField> + +<ParamField path="resendCode" type={<span>Promise<void></span>} required> + Re-sends the code via voice call. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows the user to try another MFA method. +</ParamField> + +<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> + Gets resend functionality with timeout management for this screen +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-voice-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx new file mode 100644 index 000000000..d8e518cbc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx @@ -0,0 +1,146 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallengeMembers" +description: "@interface ResetPasswordMfaWebAuthnPlatformChallengeMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordMfaWebAuthnPlatformChallengeMembers extends BaseMembers { + /** + * Access to the specific properties and data of the 'reset-password-mfa-webauthn-platform-challenge' screen. + * @type {ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge} + */ + screen: ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge; + + /** + * Initiates the WebAuthn platform authenticator challenge by calling `navigator.credentials.get()` + * using the challenge options provided in `screen.publicKey`. + * If successful, it submits the resulting credential assertion to Auth0 with `action: "default"`. + * + * @param {ContinueWithPasskeyOptions} [options] - Optional parameters for the verification process, + * such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. + * @returns {Promise<void>} A promise that resolves when the verification attempt is submitted. + * A successful operation typically results in a redirect. + * @throws {Error} Throws an error if `screen.publicKey` is missing, + * if `navigator.credentials.get()` fails (e.g., user cancellation `NotAllowedError`), + * or if the form submission to Auth0 fails. If `navigator.credentials.get()` fails + * with a `DOMException`, it's recommended to catch that error and call `reportBrowserError`. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge + * try { + * await sdk.continueWithPasskey({ + * rememberDevice: true // if user checked the box and sdk.screen.showRememberDevice is true + * }); + * // On success, Auth0 handles redirection. + * } catch (error) { + * console.error("Platform authenticator verification failed:", error); + * // If it's a WebAuthn API error (DOMException), report it + * if (error instanceof DOMException && error.name && error.message) { + * await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + * } + * // Check sdk.transaction.errors for server-side validation messages if the page reloads. + * } + * ``` + */ + continueWithPasskey(options?: ContinueWithPasskeyOptions): Promise<void>; + + /** + * Reports a browser-side error that occurred during the `navigator.credentials.get()` API call. + * This is used to inform Auth0 about issues like user cancellation, timeout, or unsupported hardware. + * It submits the error details with `action: "showError::{errorDetailsJsonString}"`. + * + * @param {ReportBrowserErrorOptions} options - Contains the `error` object (with `name` and `message` + * from the WebAuthn API DOMException) and any custom options. + * @returns {Promise<void>} A promise that resolves when the error report is submitted. + * @throws {Error} If the form submission fails (e.g., network error). + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge + * // and 'webAuthnError' is a DOMException from a failed navigator.credentials.get() call. + * try { + * await sdk.reportBrowserError({ + * error: { name: webAuthnError.name, message: webAuthnError.message } + * }); + * // Auth0 may re-render the page or redirect based on the error. + * } catch (submitError) { + * console.error("Failed to report WebAuthn browser error:", submitError); + * } + * ``` + */ + reportBrowserError(options: ReportBrowserErrorOptions): Promise<void>; + + /** + * Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. + * This action submits `action: "pick-authenticator"` to Auth0, which should navigate + * the user to an MFA factor selection screen for the password reset flow. + * + * @param {TryAnotherMethodOptions} [options] - Optional. Any custom parameters to be sent with the request. + * @returns {Promise<void>} A promise that resolves when the 'pick-authenticator' action is submitted. + * @throws {Error} If the form submission fails. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge + * try { + * await sdk.tryAnotherMethod(); + * // On success, Auth0 handles redirection to MFA selection. + * } catch (error) { + * console.error("Failed to switch MFA method:", error); + * } + * ``` + */ + tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge">ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge</a></span>} required> + Access to the specific properties and data of the 'reset-password-mfa-webauthn-platform-challenge' screen. +</ParamField> + +<ParamField path="continueWithPasskey" type={<span>Promise<void></span>} required> + Initiates the WebAuthn platform authenticator challenge by calling `navigator.credentials.get()` using the challenge options provided in `screen.publicKey`. If successful, it submits the resulting credential assertion to Auth0 with `action: "default"`. +</ParamField> + +<ParamField path="reportBrowserError" type={<span>Promise<void></span>} required> + Reports a browser-side error that occurred during the `navigator.credentials.get()` API call. This is used to inform Auth0 about issues like user cancellation, timeout, or unsupported hardware. It submits the error details with `action: "showError::"`. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate the user to an MFA factor selection screen for the password reset flow. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx new file mode 100644 index 000000000..fc5865b50 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx @@ -0,0 +1,111 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallengeMembers" +description: "@interface ResetPasswordMfaWebAuthnRoamingChallengeMembers" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordMfaWebAuthnRoamingChallengeMembers extends BaseMembers { + + /** + * Access to the specific properties and data of the `reset-password-mfa-webauthn-roaming-challenge` screen, + * including WebAuthn `publicKey` challenge options and the `showRememberDevice` flag. + * @type {ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge} + */ + screen: ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge; + + /** + * Initiates the WebAuthn assertion process (security key challenge). + * This method will internally call `navigator.credentials.get()` using the challenge + * provided in `screen.publicKey`. + * On successful interaction with the security key, it submits the resulting + * `PublicKeyCredential` to Auth0 with `action: "default"`. + * + * @param {UseSecurityKeyOptions} [options] - Optional. Parameters for the operation, + * such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. + * The `response` field (the WebAuthn credential) is handled internally by the SDK. + * @returns {Promise<void>} A promise that resolves when the verification attempt is submitted. + * A successful operation typically results in a redirect by Auth0. + * @throws {Error} Throws an error if `screen.publicKey` is missing, if `navigator.credentials.get()` + * fails (e.g., user cancellation, no authenticator found), or if the form submission to Auth0 fails. + * It's recommended to catch these errors and potentially use `showError()` to report WebAuthn API specific issues. + */ + useSecurityKey(options?: UseSecurityKeyOptions): Promise<void>; + + /** + * Reports a client-side WebAuthn API error (from `navigator.credentials.get()`) to Auth0. + * This method should be used when `useSecurityKey()` (or a manual `navigator.credentials.get()` call) + * fails due to a browser-side WebAuthn issue (e.g., `NotAllowedError` if the user cancels the prompt, + * `NotFoundError` if no matching authenticator is found, or a timeout). + * It submits the error details with `action: "showError::{errorDetailsJsonString}"` and an empty `response`. + * + * @param {ShowErrorOptions} options - Contains the `error` object (with `name` and `message` + * from the WebAuthn API DOMException), an optional `rememberDevice` flag, and any other custom options. + * @returns {Promise<void>} A promise that resolves when the error report is submitted. + * Auth0 may re-render the page with error information or redirect. + * @throws {Error} Throws an error if the form submission fails (e.g., network error, invalid state). + */ + showError(options: ShowErrorOptions): Promise<void>; + + /** + * Allows the user to opt-out of the WebAuthn roaming challenge and select a different MFA method. + * This action submits `action: "pick-authenticator"` to Auth0, which should navigate + * the user to an MFA factor selection screen. + * + * @param {TryAnotherMethodOptions} [options] - Optional. Parameters for the operation, + * such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. + * @returns {Promise<void>} A promise that resolves when the 'pick-authenticator' action is submitted. + * @throws {Error} Throws an error if the form submission fails. + */ + tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge">ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge</a></span>} required> + Access to the specific properties and data of the `reset-password-mfa-webauthn-roaming-challenge` screen, including WebAuthn `publicKey` challenge options and the `showRememberDevice` flag. +</ParamField> + +<ParamField path="useSecurityKey" type={<span>Promise<void></span>} required> + Initiates the WebAuthn assertion process (security key challenge). This method will internally call `navigator.credentials.get()` using the challenge provided in `screen.publicKey`. On successful interaction with the security key, it submits the resulting `PublicKeyCredential` to Auth0 with `action: "default"`. +</ParamField> + +<ParamField path="showError" type={<span>Promise<void></span>} required> + Reports a client-side WebAuthn API error (from `navigator.credentials.get()`) to Auth0. This method should be used when `useSecurityKey()` (or a manual `navigator.credentials.get()` call) fails due to a browser-side WebAuthn issue (e.g., `NotAllowedError` if the user cancels the prompt, `NotFoundError` if no matching authenticator is found, or a timeout). It submits the error details with `action: "showError::"` and an empty `response`. +</ParamField> + +<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> + Allows the user to opt-out of the WebAuthn roaming challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate the user to an MFA factor selection screen. +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordOptions.mdx new file mode 100644 index 000000000..42c6de025 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordOptions.mdx @@ -0,0 +1,31 @@ +--- +title: "ResetPasswordOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordOptions { + 'password-reset': string; + 're-enter-password': string; + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="'password-reset'" type={<span>string</span>} required> +</ParamField> + +<ParamField path="'re-enter-password'" type={<span>string</span>} required> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestMembers.mdx new file mode 100644 index 000000000..9f45c6e2a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestMembers.mdx @@ -0,0 +1,60 @@ +--- +title: "ResetPasswordRequestMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordRequestMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordRequest; + transaction: TransactionMembersOnResetPasswordRequest; + resetPassword(payload: ResetPasswordRequestOptions): Promise<void>; + backToLogin(payload?: CustomOptions): Promise<void>; + getLoginIdentifiers(): IdentifierType[] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordRequest">ScreenMembersOnResetPasswordRequest</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPasswordRequest">TransactionMembersOnResetPasswordRequest</a></span>} required> +</ParamField> + +<ParamField path="resetPassword" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="backToLogin" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="getLoginIdentifiers" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-request.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions.mdx new file mode 100644 index 000000000..874e4e2b5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions.mdx @@ -0,0 +1,31 @@ +--- +title: "ResetPasswordRequestOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordRequestOptions { + username: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="username" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captcha" type={<span>string</span>}> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-request.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessMembers.mdx new file mode 100644 index 000000000..3d6b7b39f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessMembers.mdx @@ -0,0 +1,47 @@ +--- +title: "ResetPasswordSuccessMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordSuccessMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordSuccess; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordSuccess">ScreenMembersOnResetPasswordSuccess</a></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-success.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-success.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessOptions.mdx new file mode 100644 index 000000000..3f006f154 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "ResetPasswordSuccessOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ResetPasswordSuccessOptions { + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-success.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-success.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope.mdx new file mode 100644 index 000000000..68b6c6f8d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope.mdx @@ -0,0 +1,27 @@ +--- +title: "Scope" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface Scope { + value: string; + description?: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="value" type={<span>string</span>} required> +</ParamField> + +<ParamField path="description" type={<span>string</span>}> +</ParamField> + +--- + +**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext.mdx new file mode 100644 index 000000000..6a598c658 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext.mdx @@ -0,0 +1,39 @@ +--- +title: "ScreenContext" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenContext { + name: string; + links?: Record<string, string>; + captcha?: CaptchaContext; + data?: ScreenData; + texts?: Record<string, string>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string></span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a></span>}> +</ParamField> + +<ParamField path="data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData">ScreenData</a></span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string></span>}> +</ParamField> + +--- + +**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLogin.mdx new file mode 100644 index 000000000..a86298f72 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLogin.mdx @@ -0,0 +1,44 @@ +--- +title: "ScreenContextOnLogin" +description: "Extended screen context interface for the login screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenContextOnLogin extends ScreenContext { + links: { + signup: string; + reset_password: string; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="links" type="object" required> + <Expandable title="properties"> + <ParamField path="signup" type={<span>string</span>} required> + </ParamField> + <ParamField path="reset_password" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a></span>}> +</ParamField> + +<ParamField path="data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData">ScreenData</a></span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string></span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPassword.mdx new file mode 100644 index 000000000..056326aeb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPassword.mdx @@ -0,0 +1,47 @@ +--- +title: "ScreenContextOnLoginPassword" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenContextOnLoginPassword extends ScreenContext { + links: { + signup: string; + reset_password: string; + edit_identifier: string; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="links" type="object" required> + <Expandable title="properties"> + <ParamField path="signup" type={<span>string</span>} required> + </ParamField> + <ParamField path="reset_password" type={<span>string</span>} required> + </ParamField> + <ParamField path="edit_identifier" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a></span>}> +</ParamField> + +<ParamField path="data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData">ScreenData</a></span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string></span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPasswordlessSmsOtp.mdx new file mode 100644 index 000000000..19187e4a6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPasswordlessSmsOtp.mdx @@ -0,0 +1,47 @@ +--- +title: "ScreenContextOnLoginPasswordlessSmsOtp" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenContextOnLoginPasswordlessSmsOtp extends ScreenContext { + links: { + edit_identifier: string; + reset_password: string; + signup: string; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="links" type="object" required> + <Expandable title="properties"> + <ParamField path="edit_identifier" type={<span>string</span>} required> + </ParamField> + <ParamField path="reset_password" type={<span>string</span>} required> + </ParamField> + <ParamField path="signup" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a></span>}> +</ParamField> + +<ParamField path="data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData">ScreenData</a></span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string></span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-passwordless-sms-otp.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnSignupPassword.mdx new file mode 100644 index 000000000..f2dbdcfe0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnSignupPassword.mdx @@ -0,0 +1,58 @@ +--- +title: "ScreenContextOnSignupPassword" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenContextOnSignupPassword extends ScreenContext { + links: { + login: string; + edit_identifier: string; + }; + + data: { + email?: string; + phone_number?: string; + username?: string; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="links" type="object" required> + <Expandable title="properties"> + <ParamField path="login" type={<span>string</span>} required> + </ParamField> + <ParamField path="edit_identifier" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="data" type="object" required> + <Expandable title="properties"> + <ParamField path="email" type={<span>string</span>}> + </ParamField> + <ParamField path="phone_number" type={<span>string</span>}> + </ParamField> + <ParamField path="username" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a></span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string></span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/signup-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData.mdx new file mode 100644 index 000000000..5ce1bc4f5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData.mdx @@ -0,0 +1,23 @@ +--- +title: "ScreenData" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenData { + [key: string]: string | boolean | PasskeyRead | PasskeyCreate | string[] | Array<PhonePrefix | Scope | AuthorizationDetail> | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="unknown" type={<span>string | boolean | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a> | string[] | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope">Scope</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail">AuthorizationDetail</a>> | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge.mdx new file mode 100644 index 000000000..706370326 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,39 @@ +--- +title: "ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge" +description: "@interface ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge description Specific data available on the `screen.data` object for the `reset-password-mfa-webauthn-roaming-challenge` screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge { + /** + * The WebAuthn public key credential request options, specifically the challenge (`publicKey`) + * to be used with `navigator.credentials.get()`. + * @type {PasskeyRead} + */ + passkey: PasskeyRead; + /** + * Optional. If true, the UI should offer an option to remember the current device/browser, + * potentially skipping MFA for a defined period on subsequent logins from the same device. + * @type {boolean | undefined} + */ + show_remember_device?: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="passkey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a></span>} required> + The WebAuthn public key credential request options, specifically the challenge (`publicKey`) to be used with `navigator.credentials.get()`. +</ParamField> + +<ParamField path="show_remember_device" type={<span>boolean</span>}> + Optional. If true, the UI should offer an option to remember the current device/browser, potentially skipping MFA for a defined period on subsequent logins from the same device. +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions.mdx new file mode 100644 index 000000000..473d2a2b2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions.mdx @@ -0,0 +1,26 @@ +--- +title: "ScreenDataOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenDataOptions extends ScreenData { + username?: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="username" type={<span>string</span>}> +</ParamField> + +<ParamField path="unknown" type={<span>string | boolean | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a> | string[] | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope">Scope</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail">AuthorizationDetail</a>> | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers.mdx new file mode 100644 index 000000000..54dc73f4c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers.mdx @@ -0,0 +1,55 @@ +--- +title: "ScreenMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembers { + name: string; + captchaImage: string | null; + captchaSiteKey: string | null; + captchaProvider: string | null; + isCaptchaAvailable: boolean; + data: Record<string, string | boolean | string[] | Record<string, string[]> | Array<PhonePrefix> | PasskeyCreate> | null; + links: Record<string, string> | null; + texts: Record<string, string> | null; + captcha: CaptchaContext | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnAcceptInvitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnAcceptInvitation.mdx new file mode 100644 index 000000000..c4f09681a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnAcceptInvitation.mdx @@ -0,0 +1,56 @@ +--- +title: "ScreenMembersOnAcceptInvitation" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnAcceptInvitation extends ScreenMembers { + data: { + inviter: string; + email: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="inviter" type={<span>string</span>} required> + </ParamField> + <ParamField path="email" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/accept-invitation.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockFailure.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockFailure.mdx new file mode 100644 index 000000000..76840068c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockFailure.mdx @@ -0,0 +1,53 @@ +--- +title: "ScreenMembersOnBruteForceProtectionUnblockFailure" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnBruteForceProtectionUnblockFailure extends ScreenMembers { + data: { + errorType?: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="errorType" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/brute-force-protection-unblock-failure.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/brute-force-protection-unblock-failure.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockSuccess.mdx new file mode 100644 index 000000000..284b0a31b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockSuccess.mdx @@ -0,0 +1,45 @@ +--- +title: "ScreenMembersOnBruteForceProtectionUnblockSuccess" +description: "Represents the screen members specific to the Brute Force Protection Unblock Success screen. Extends the base ScreenMembers interface." +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnBruteForceProtectionUnblockSuccess extends ScreenMembers {} +``` + +</RequestExample> + +## Properties + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/brute-force-protection-unblock-success.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/brute-force-protection-unblock-success.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnConsent.mdx new file mode 100644 index 000000000..572b4d141 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnConsent.mdx @@ -0,0 +1,54 @@ +--- +title: "ScreenMembersOnConsent" +description: "@interface ScreenMembersOnConsent" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnConsent extends ScreenMembers { + scopes: Scope[]; + hideScopes: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="scopes" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope">Scope[]</a></span>} required> +</ParamField> + +<ParamField path="hideScopes" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/consent.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/consent.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnCustomizedConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnCustomizedConsent.mdx new file mode 100644 index 000000000..190b53a1c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnCustomizedConsent.mdx @@ -0,0 +1,69 @@ +--- +title: "ScreenMembersOnCustomizedConsent" +description: "@interface ScreenMembersOnCustomizedConsent" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnCustomizedConsent extends ScreenMembers { + /** + * An array of `Scope` objects detailing each permission (scope) being requested. + * These are typically high-level permissions like 'read:profile' or 'openid'. + * This list should be displayed to the user for their review. + */ + scopes: Scope[]; + + /** + * An array of `AuthorizationDetail` objects. + * Each object provides granular details about specific data or + * actions the application wants to perform, potentially related to + * Rich Authorization Requests (RAR) or other fine-grained permission models. + * This list should be displayed to the user for their review. + */ + authorizationDetails: AuthorizationDetail[]; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="scopes" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope">Scope[]</a></span>} required> + An array of `Scope` objects detailing each permission (scope) being requested. These are typically high-level permissions like 'read:profile' or 'openid'. This list should be displayed to the user for their review. +</ParamField> + +<ParamField path="authorizationDetails" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail">AuthorizationDetail[]</a></span>} required> + An array of `AuthorizationDetail` objects. Each object provides granular details about specific data or actions the application wants to perform, potentially related to Rich Authorization Requests (RAR) or other fine-grained permission models. This list should be displayed to the user for their review. +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/customized-consent.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/customized-consent.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx new file mode 100644 index 000000000..936583446 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx @@ -0,0 +1,53 @@ +--- +title: "ScreenMembersOnDeviceCodeConfirmation" +description: "Interface describing the data available on the Device Code Confirmation screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnDeviceCodeConfirmation extends ScreenMembers { + data: { + textCode: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="textCode" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/device-code-confirmation.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx new file mode 100644 index 000000000..9e0cad6b5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx @@ -0,0 +1,59 @@ +--- +title: "ScreenMembersOnEmailIdentifierChallenge" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnEmailIdentifierChallenge extends ScreenMembers { + data: { + messageType?: string; + email?: string; + resendLimitReached?: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="messageType" type={<span>string</span>}> + </ParamField> + <ParamField path="email" type={<span>string</span>}> + </ParamField> + <ParamField path="resendLimitReached" type={<span>boolean</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/email-identifier-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailOTPChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailOTPChallenge.mdx new file mode 100644 index 000000000..ed2c3d027 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailOTPChallenge.mdx @@ -0,0 +1,47 @@ +--- +title: "ScreenMembersOnEmailOTPChallenge" +description: "Represents the members of the Email OTP Challenge screen. Extends the base ScreenMembers interface." +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnEmailOTPChallenge extends ScreenMembers { + // Add any specific members for this screen here +} +``` + +</RequestExample> + +## Properties + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/email-otp-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailVerificationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailVerificationResult.mdx new file mode 100644 index 000000000..b216b7c21 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailVerificationResult.mdx @@ -0,0 +1,70 @@ +--- +title: "ScreenMembersOnEmailVerificationResult" +description: "@interface ScreenMembersOnEmailVerificationResult" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnEmailVerificationResult extends ScreenMembers { + /** + * Screen-specific data containing the status of the email verification. + * @type {{ status: string; } | null} + */ + data: { + /** + * The status of the email verification process. + * Possible values might include "success", "failure", "already_verified", etc. + * This status should be displayed to the user to inform them of the outcome. + */ + status: string; + } | null; + + /** + * Navigation links available on this screen. + * @type {string | null} + */ + loginLink: string | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="loginLink" type={<span>string | null</span>}> + Navigation links available on this screen. +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/email-verification-result.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLogin.mdx new file mode 100644 index 000000000..7f3fad931 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLogin.mdx @@ -0,0 +1,61 @@ +--- +title: "ScreenMembersOnLogin" +description: "Extended screen members interface for the login screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnLogin extends ScreenMembers { + signupLink: string | null; + resetPasswordLink: string | null; + data: { + username?: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="signupLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="resetPasswordLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="username" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginId.mdx new file mode 100644 index 000000000..386ebfbb0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginId.mdx @@ -0,0 +1,58 @@ +--- +title: "ScreenMembersOnLoginId" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnLoginId extends ScreenMembers { + signupLink: string | null; + resetPasswordLink: string | null; + publicKey: PasskeyRead['public_key'] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="signupLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="resetPasswordLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key'] | null</span>}> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPassword.mdx new file mode 100644 index 000000000..ed666980d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPassword.mdx @@ -0,0 +1,65 @@ +--- +title: "ScreenMembersOnLoginPassword" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnLoginPassword extends ScreenMembers { + signupLink: string | null; + resetPasswordLink: string | null; + editIdentifierLink: string | null; + data: { + username: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="signupLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="resetPasswordLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="editIdentifierLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="username" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx new file mode 100644 index 000000000..62c6c55b7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx @@ -0,0 +1,68 @@ +--- +title: "ScreenMembersOnLoginPasswordlessEmailCode" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnLoginPasswordlessEmailCode extends ScreenMembers { + editIdentifierLink: string | null; + resetPasswordLink: string | null; + signupLink: string | null; + data: { + email?: string; + username?: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="editIdentifierLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="resetPasswordLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="signupLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="email" type={<span>string</span>}> + </ParamField> + <ParamField path="username" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-passwordless-email-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx new file mode 100644 index 000000000..b136863d3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx @@ -0,0 +1,68 @@ +--- +title: "ScreenMembersOnLoginPasswordlessSmsOtp" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnLoginPasswordlessSmsOtp extends ScreenMembers { + signupLink: string | null; + resetPasswordLink: string | null; + backLink: string | null; + data: { + username: string; + phone_number: string; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="signupLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="resetPasswordLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="backLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="data" type="object" required> + <Expandable title="properties"> + <ParamField path="username" type={<span>string</span>} required> + </ParamField> + <ParamField path="phone_number" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-passwordless-sms-otp.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaCountryCodes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaCountryCodes.mdx new file mode 100644 index 000000000..c35da48a4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaCountryCodes.mdx @@ -0,0 +1,52 @@ +--- +title: "ScreenMembersOnMfaCountryCodes" +description: "Interface for screen data specific to mfa-country-codes screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaCountryCodes extends ScreenMembers { + data: { + /** List of available phone prefixes */ + phone_prefixes: PhonePrefix[]; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-country-codes.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailChallenge.mdx new file mode 100644 index 000000000..06c9c1a66 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailChallenge.mdx @@ -0,0 +1,56 @@ +--- +title: "ScreenMembersOnMfaEmailChallenge" +description: "Interface for the screen data specific to mfa-email-challenge screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaEmailChallenge extends ScreenMembers { + data: { + email: string; + showRememberDevice?: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="email" type={<span>string</span>} required> + </ParamField> + <ParamField path="showRememberDevice" type={<span>boolean</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-email-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailList.mdx new file mode 100644 index 000000000..50a1f3d60 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailList.mdx @@ -0,0 +1,52 @@ +--- +title: "ScreenMembersOnMfaEmailList" +description: "Interface for the screen data specific to mfa-email-list screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaEmailList extends ScreenMembers { + data: { + /** List of enrolled email addresses */ + enrolled_emails: string[]; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-email-list.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEnrollResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEnrollResult.mdx new file mode 100644 index 000000000..f9daec671 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEnrollResult.mdx @@ -0,0 +1,61 @@ +--- +title: "ScreenMembersOnMfaEnrollResult" +description: "@interface ScreenMembersOnMfaEnrollResult" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaEnrollResult extends ScreenMembers { + /** + * Screen-specific data containing the status of the MFA enrollment. + * @type {{ status: string; } | null} + */ + data: { + /** + * The status of the MFA enrollment process. + * Possible values might include "success", "failure", or other specific status codes. + * This status can be used to display an appropriate message to the user. + * @type {string} + */ + status: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-enroll-result.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaLoginOptions.mdx new file mode 100644 index 000000000..a3987fcc4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaLoginOptions.mdx @@ -0,0 +1,52 @@ +--- +title: "ScreenMembersOnMfaLoginOptions" +description: "Interface for the screen data specific to mfa-login-options screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaLoginOptions extends ScreenMembers { + data: { + /** List of enrolled MFA factors for the user */ + enrolled_factors: string[]; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-login-options.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpChallenge.mdx new file mode 100644 index 000000000..e2a1fbe85 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpChallenge.mdx @@ -0,0 +1,53 @@ +--- +title: "ScreenMembersOnMfaOtpChallenge" +description: "Interface for the screen data specific to mfa-otp-challenge screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaOtpChallenge extends ScreenMembers { + data: { + showRememberDevice?: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="showRememberDevice" type={<span>boolean</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-otp-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx new file mode 100644 index 000000000..44e0812d6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx @@ -0,0 +1,54 @@ +--- +title: "ScreenMembersOnMfaOtpEnrollmentCode" +description: "Interface for the screen data specific to the mfa-otp-enrollment-code screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaOtpEnrollmentCode extends ScreenMembers { + data: { + /** + * The text code to display to the user. + */ + text_code: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-otp-enrollment-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx new file mode 100644 index 000000000..646aa3266 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx @@ -0,0 +1,53 @@ +--- +title: "ScreenMembersOnMfaOtpEnrollmentQr" +description: "Interface for the screen data specific to mfa-otp-enrollment-qr screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaOtpEnrollmentQr extends ScreenMembers { + data: { + qr_code: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="qr_code" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-otp-enrollment-qr.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx new file mode 100644 index 000000000..42461ca05 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx @@ -0,0 +1,56 @@ +--- +title: "ScreenMembersOnMfaPhoneChallenge" +description: "@interface ScreenMembersOnMfaPhoneChallenge" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaPhoneChallenge extends ScreenMembers { + /** + * @property {object | null} data - Screen-specific data. + * @property {string} data.phone_number - The phone number (often masked) associated with this MFA challenge. + */ + data: { + /** The phone number (often masked) associated with this MFA challenge. */ + phoneNumber: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-phone-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushChallengePush.mdx new file mode 100644 index 000000000..3f1c04458 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushChallengePush.mdx @@ -0,0 +1,54 @@ +--- +title: "ScreenMembersOnMfaPushChallengePush" +description: "Interface for the screen data specific to mfa-push-challenge-push screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaPushChallengePush extends ScreenMembers { + data: { + /** The name of the device receiving the push notification */ + deviceName: string; + /** Whether to show the remember device option */ + showRememberDevice?: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-push-challenge-push.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx new file mode 100644 index 000000000..3102abe3c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx @@ -0,0 +1,59 @@ +--- +title: "ScreenMembersOnMfaPushEnrollmentQr" +description: "Interface for the screen data specific to mfa-push-enrollment-qr screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaPushEnrollmentQr extends ScreenMembers { + data: { + qrCode: string; + qrUri: string; + showCodeCopy: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="qrCode" type={<span>string</span>} required> + </ParamField> + <ParamField path="qrUri" type={<span>string</span>} required> + </ParamField> + <ParamField path="showCodeCopy" type={<span>boolean</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-push-enrollment-qr.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushWelcome.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushWelcome.mdx new file mode 100644 index 000000000..c3a55ad59 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushWelcome.mdx @@ -0,0 +1,68 @@ +--- +title: "ScreenMembersOnMfaPushWelcome" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaPushWelcome extends ScreenMembers { + screen: { + name: string; + links: { + ios: string; + android: string; + }; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type="object" required> + <Expandable title="properties"> + <ParamField path="name" type={<span>string</span>} required> + </ParamField> + <ParamField path="links" type="object" required> + <Expandable title="properties"> + <ParamField path="ios" type={<span>string</span>} required> + </ParamField> + <ParamField path="android" type={<span>string</span>} required> + </ParamField> + </Expandable> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-push-welcome.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx new file mode 100644 index 000000000..f79ca078f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx @@ -0,0 +1,59 @@ +--- +title: "ScreenMembersOnMfaRecoveryCodeChallengeNewCode" +description: "@interface ScreenMembersOnMfaRecoveryCodeChallengeNewCode" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaRecoveryCodeChallengeNewCode extends ScreenMembers { + /** + * @property {object | null} data - Screen-specific data. + * @property {string} data.textCode - The newly generated recovery code that the user must save. + */ + data: { + /** + * The newly generated recovery code to display to the user. + * It is crucial that the user saves this code securely as it will be needed for future logins if other MFA factors are unavailable. + */ + textCode: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-recovery-code-challenge-new-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx new file mode 100644 index 000000000..ac7ef71de --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx @@ -0,0 +1,54 @@ +--- +title: "ScreenMembersOnMfaRecoveryCodeEnrollment" +description: "Interface describing the data available on the Mfa Recovery Code Enrollment screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaRecoveryCodeEnrollment extends ScreenMembers { + data: { + /** + * The recovery code to display to the user. + */ + textCode: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-recovery-code-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsChallenge.mdx new file mode 100644 index 000000000..656ea61e3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsChallenge.mdx @@ -0,0 +1,62 @@ +--- +title: "ScreenMembersOnMfaSmsChallenge" +description: "Interface for the screen data specific to mfa-sms-challenge screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaSmsChallenge extends ScreenMembers { + data: { + /** + * The phone number where the SMS was sent + */ + phoneNumber?: string; + /** + * Whether to show the remember device option + */ + showRememberDevice?: boolean; + /** + * Whether to show the link to switch to voice call verification + */ + showLinkVoice?: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-sms-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx new file mode 100644 index 000000000..fb6bb9941 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx @@ -0,0 +1,53 @@ +--- +title: "ScreenMembersOnMfaSmsEnrollment" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaSmsEnrollment extends ScreenMembers { + data: { + phone?: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="phone" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-sms-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx new file mode 100644 index 000000000..5f64cbc1c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx @@ -0,0 +1,67 @@ +--- +title: "ScreenMembersOnMfaVoiceChallenge" +description: "Extended screen members interface for the MFA Voice Challenge screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaVoiceChallenge extends ScreenMembers { + /** + * Additional screen data specific to MFA voice challenge. + */ + data: { + /** + * The phone number where the voice code was sent. + */ + phoneNumber?: string; + + /** + * Whether to show the remember device option. + */ + showRememberDevice?: boolean; + + /** + * Whether to show the link to switch to SMS verification. + */ + showLinkSms?: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-voice-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx new file mode 100644 index 000000000..0733487d2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx @@ -0,0 +1,62 @@ +--- +title: "ScreenMembersOnMfaWebAuthnChangeKeyNickname" +description: "@interface ScreenMembersOnMfaWebAuthnChangeKeyNickname" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaWebAuthnChangeKeyNickname extends ScreenMembers { + /** + * Screen-specific data containing the current nickname of the WebAuthn key. + * @type {{ nickname: string; } | null} + */ + data: { + /** + * The current nickname of the WebAuthn security key that the user is about to change. + * This value should be displayed to the user for context. + * @type {string} + * @example "My YubiKey" + * @example "Work Security Key" + */ + nickname: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-change-key-nickname.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx new file mode 100644 index 000000000..59822a41d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx @@ -0,0 +1,69 @@ +--- +title: "ScreenMembersOnMfaWebAuthnEnrollmentSuccess" +description: "@interface ScreenMembersOnMfaWebAuthnEnrollmentSuccess" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaWebAuthnEnrollmentSuccess extends ScreenMembers { + /** + * Screen-specific data containing details about the successful WebAuthn enrollment. + * @type {{ nickname: string; webauthnType: WebAuthnType; } | null} + */ + data: { + /** + * The nickname that the user (or system) assigned to the newly enrolled WebAuthn authenticator. + * This helps the user identify the authenticator later. + * @type {string} + * @example "YubiKey 5" + * @example "My Laptop's Touch ID" + */ + nickname: string; + /** + * The type of WebAuthn authenticator that was successfully enrolled. + * - `'webauthn-roaming'`: Indicates a roaming authenticator like a USB security key. + * - `'webauthn-platform'`: Indicates a platform authenticator like Touch ID or Windows Hello. + * @type {WebAuthnType} + */ + webauthnType: WebAuthnType; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-enrollment-success.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnError.mdx new file mode 100644 index 000000000..bdc1cf5f8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnError.mdx @@ -0,0 +1,65 @@ +--- +title: "ScreenMembersOnMfaWebAuthnError" +description: "@interface ScreenMembersOnMfaWebAuthnError" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaWebAuthnError extends ScreenMembers { + /** + * @property {object | null} data - Screen-specific data detailing the WebAuthn error. + * @property {string} data.errorType - A string code or message describing the nature of the WebAuthn error + * (e.g., "NotAllowedError", "TimeoutError", "InvalidStateError"). + * @property {WebAuthnType} data.webauthnType - Indicates whether the error occurred with a 'webauthn-roaming' + * or 'webauthn-platform' authenticator. + */ + data: { + /** + * A code or message describing the WebAuthn error. + */ + errorType: string; + /** + * The type of WebAuthn authenticator involved. + */ + webauthnType: WebAuthnType; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-error.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx new file mode 100644 index 000000000..d15452ed9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,67 @@ +--- +title: "ScreenMembersOnMfaWebAuthnPlatformChallenge" +description: "@interface ScreenMembersOnMfaWebAuthnPlatformChallenge" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaWebAuthnPlatformChallenge extends ScreenMembers { + /** + * Direct access to the `PublicKeyCredentialRequestOptions` (specifically the challenge part) + * needed for `navigator.credentials.get()`. + * This is a convenience accessor for `data?.passkey?.public_key`. + * @type {PasskeyRead['public_key'] | null} + */ + publicKey: PasskeyRead['public_key'] | null; + + /** + * Indicates whether the "Remember this device" checkbox should be displayed. + * @type {boolean} + */ + showRememberDevice: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key'] | null</span>}> + Direct access to the `PublicKeyCredentialRequestOptions` (specifically the challenge part) needed for `navigator.credentials.get()`. This is a convenience accessor for `data?.passkey?.public_key`. +</ParamField> + +<ParamField path="showRememberDevice" type={<span>boolean</span>} required> + Indicates whether the "Remember this device" checkbox should be displayed. +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-platform-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx new file mode 100644 index 000000000..424ae2b8a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx @@ -0,0 +1,56 @@ +--- +title: "ScreenMembersOnMfaWebAuthnPlatformEnrollment" +description: "@interface ScreenMembersOnMfaWebAuthnPlatformEnrollment" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaWebAuthnPlatformEnrollment extends ScreenMembers { + /** + * @property {PasskeyCreate['public_key'] | null} publicKey - Direct access to the `PublicKeyCredentialCreationOptions`. + * This is a convenience accessor for `data?.passkeys?.public_key`. It provides the necessary options + * for `navigator.credentials.create()`. + */ + publicKey: PasskeyCreate['public_key'] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>['public_key'] | null</span>}> + Direct access to the `PublicKeyCredentialCreationOptions`. This is a convenience accessor for `data?.passkeys?.public_key`. It provides the necessary options for `navigator.credentials.create()`. +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-platform-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx new file mode 100644 index 000000000..14ef49a43 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,58 @@ +--- +title: "ScreenMembersOnMfaWebAuthnRoamingChallenge" +description: "@interface ScreenMembersOnMfaWebAuthnRoamingChallenge" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaWebAuthnRoamingChallenge extends ScreenMembers { + showRememberDevice?: boolean; + webauthnType: string | null; + publicKey: PasskeyRead['public_key'] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="showRememberDevice" type={<span>boolean</span>}> +</ParamField> + +<ParamField path="webauthnType" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key'] | null</span>}> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx new file mode 100644 index 000000000..96afa301a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx @@ -0,0 +1,54 @@ +--- +title: "ScreenMembersOnMfaWebAuthnRoamingEnrollment" +description: "Interface for screen data specific to mfa-webauthn-roaming-enrollment screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnMfaWebAuthnRoamingEnrollment extends ScreenMembers { + webauthnType: string | null; + publicKey: PasskeyCreate['public_key'] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="webauthnType" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>['public_key'] | null</span>}> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-roaming-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnOrganizationSelection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnOrganizationSelection.mdx new file mode 100644 index 000000000..58dded037 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnOrganizationSelection.mdx @@ -0,0 +1,70 @@ +--- +title: "ScreenMembersOnOrganizationSelection" +description: "Interface for the screen data specific to organization-selection screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnOrganizationSelection extends ScreenMembers { + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + transaction: TransactionMembers; + User: UserMembers; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> +</ParamField> + +<ParamField path="User" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/organization-selection.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/organization-selection.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollment.mdx new file mode 100644 index 000000000..43d291601 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollment.mdx @@ -0,0 +1,58 @@ +--- +title: "ScreenMembersOnPasskeyEnrollment" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnPasskeyEnrollment extends ScreenMembers { + backLink: string | null; + loginLink: string | null; + publicKey: PasskeyCreate['public_key'] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="backLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="loginLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>['public_key'] | null</span>}> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/passkey-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx new file mode 100644 index 000000000..1a0771e6e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx @@ -0,0 +1,50 @@ +--- +title: "ScreenMembersOnPasskeyEnrollmentLocal" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnPasskeyEnrollmentLocal extends ScreenMembers { + publicKey: PasskeyCreate['public_key'] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>['public_key'] | null</span>}> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/passkey-enrollment-local.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx new file mode 100644 index 000000000..9003f520b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx @@ -0,0 +1,65 @@ +--- +title: "ScreenMembersOnPhoneIdentifierChallenge" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnPhoneIdentifierChallenge extends ScreenMembers { + data: { + messageType?: 'text' | 'voice'; + phone?: string; + resendLimitReached?: boolean; + showLinkSms?: boolean; + showLinkVoice?: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="messageType" type={<span>'text' | 'voice'</span>}> + </ParamField> + <ParamField path="phone" type={<span>string</span>}> + </ParamField> + <ParamField path="resendLimitReached" type={<span>boolean</span>}> + </ParamField> + <ParamField path="showLinkSms" type={<span>boolean</span>}> + </ParamField> + <ParamField path="showLinkVoice" type={<span>boolean</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/phone-identifier-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx new file mode 100644 index 000000000..93eaf9c5a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx @@ -0,0 +1,60 @@ +--- +title: "ScreenMembersOnPhoneIdentifierEnrollment" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnPhoneIdentifierEnrollment extends ScreenMembers { + data: { + phone?: 'string'; + messageType?: 'text' | 'voice'; + } | null; + editIdentifierLink: string | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="phone" type={<span>'string'</span>}> + </ParamField> + <ParamField path="messageType" type={<span>'text' | 'voice'</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="editIdentifierLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/phone-identifier-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPassword.mdx new file mode 100644 index 000000000..93591af33 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPassword.mdx @@ -0,0 +1,53 @@ +--- +title: "ScreenMembersOnResetPassword" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnResetPassword extends ScreenMembers { + data: { + username?: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="username" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordEmail.mdx new file mode 100644 index 000000000..dce9b7054 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordEmail.mdx @@ -0,0 +1,53 @@ +--- +title: "ScreenMembersOnResetPasswordEmail" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnResetPasswordEmail extends ScreenMembers { + data: { + username?: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="username" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-email.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordError.mdx new file mode 100644 index 000000000..dc718cbbb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordError.mdx @@ -0,0 +1,53 @@ +--- +title: "ScreenMembersOnResetPasswordError" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnResetPasswordError extends ScreenMembers { + data: { + username?: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="username" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-error.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx new file mode 100644 index 000000000..08f584883 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx @@ -0,0 +1,53 @@ +--- +title: "ScreenMembersOnResetPasswordMfaEmailChallenge" +description: "Interface for the screen data specific to reset-password-mfa-email-challenge screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnResetPasswordMfaEmailChallenge extends ScreenMembers { + data: { + email: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="email" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-email-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx new file mode 100644 index 000000000..e4b4ccce0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx @@ -0,0 +1,56 @@ +--- +title: "ScreenMembersOnResetPasswordMfaPhoneChallenge" +description: "@interface ScreenMembersOnResetPasswordMfaPhoneChallenge" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnResetPasswordMfaPhoneChallenge extends ScreenMembers { + /** + * @property {object | null} data - Screen-specific data. + * @property {string} data.phoneNumber - The phone number (often masked for security) associated with this MFA challenge during password reset. + */ + data: { + /** The phone number (often masked) associated with this MFA challenge. */ + phoneNumber: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-phone-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx new file mode 100644 index 000000000..307d396bc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx @@ -0,0 +1,57 @@ +--- +title: "ScreenMembersOnResetPasswordMfaPushChallengePush" +description: "Interface for the screen data specific to reset-password-mfa-push-challenge-push screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnResetPasswordMfaPushChallengePush + extends ScreenMembers { + data: { + deviceName: string; + rememberDevice?: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="deviceName" type={<span>string</span>} required> + </ParamField> + <ParamField path="rememberDevice" type={<span>boolean</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-push-challenge-push.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx new file mode 100644 index 000000000..8ae464465 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx @@ -0,0 +1,57 @@ +--- +title: "ScreenMembersOnResetPasswordMfaSmsChallenge" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnResetPasswordMfaSmsChallenge extends ScreenMembers { + data: { + phoneNumber: string; + /** + * Whether to show the link to switch to voice call verification + */ + showLinkVoice?: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="phoneNumber" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-sms-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx new file mode 100644 index 000000000..8549378e3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx @@ -0,0 +1,59 @@ +--- +title: "ScreenMembersOnResetPasswordMfaVoiceChallenge" +description: "Interface for the screen data specific to reset-password-mfa-voice-challenge screen." +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnResetPasswordMfaVoiceChallenge extends ScreenMembers { + data: { + /** + * The phone number to send the voice call to. + */ + phoneNumber: string; + + /** + * Whether to show the link to switch to SMS verification. + */ + showLinkSms?: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-voice-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx new file mode 100644 index 000000000..2de0d6f63 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,68 @@ +--- +title: "ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge" +description: "@interface ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge extends ScreenMembers { + /** + * Convenience getter for the public key credential request options (challenge) needed for WebAuthn. + * This is derived from `screen.data.passkey.public_key`. + * If `screen.data.passkey` or `screen.data.passkey.public_key` is not available, this will be `null`. + * @type {PasskeyRead['public_key'] | null} + */ + publicKey: PasskeyRead['public_key'] | null; + + /** + * Convenience getter for whether the "Remember this device" option should be shown. + * Derived from `screen.data.show_remember_device`. Defaults to `false` if not specified. + * @type {boolean} + */ + showRememberDevice: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key'] | null</span>}> + Convenience getter for the public key credential request options (challenge) needed for WebAuthn. This is derived from `screen.data.passkey.public_key`. If `screen.data.passkey` or `screen.data.passkey.public_key` is not available, this will be `null`. +</ParamField> + +<ParamField path="showRememberDevice" type={<span>boolean</span>} required> + Convenience getter for whether the "Remember this device" option should be shown. Derived from `screen.data.show_remember_device`. Defaults to `false` if not specified. +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx new file mode 100644 index 000000000..f8d2f3621 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,72 @@ +--- +title: "ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge" +description: "@interface ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge extends ScreenMembers { + /** + * A direct accessor for the `passkey.public_key` data from `screen.data`. + * This object contains the challenge and other options necessary for the + * `navigator.credentials.get()` WebAuthn API call. + * It is `null` if `screen.data.passkey.public_key` is not available. + * @type {PasskeyRead['public_key'] | null} + * @public + */ + publicKey: PasskeyRead['public_key'] | null; + + /** + * A direct accessor for the `show_remember_device` flag from `screen.data`. + * Indicates whether the UI should present an option to the user to remember this device/browser + * to potentially bypass MFA on future logins. Defaults to `false` if not set in `screen.data`. + * @type {boolean} + * @public + */ + showRememberDevice: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key'] | null</span>}> + A direct accessor for the `passkey.public_key` data from `screen.data`. This object contains the challenge and other options necessary for the `navigator.credentials.get()` WebAuthn API call. It is `null` if `screen.data.passkey.public_key` is not available. +</ParamField> + +<ParamField path="showRememberDevice" type={<span>boolean</span>} required> + A direct accessor for the `show_remember_device` flag from `screen.data`. Indicates whether the UI should present an option to the user to remember this device/browser to potentially bypass MFA on future logins. Defaults to `false` if not set in `screen.data`. +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordRequest.mdx new file mode 100644 index 000000000..9cdab6448 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordRequest.mdx @@ -0,0 +1,59 @@ +--- +title: "ScreenMembersOnResetPasswordRequest" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnResetPasswordRequest extends ScreenMembers { + data: { + phone?: string; + email?: string; + username?: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="phone" type={<span>string</span>}> + </ParamField> + <ParamField path="email" type={<span>string</span>}> + </ParamField> + <ParamField path="username" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-request.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordSuccess.mdx new file mode 100644 index 000000000..fc68e25e4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordSuccess.mdx @@ -0,0 +1,45 @@ +--- +title: "ScreenMembersOnResetPasswordSuccess" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnResetPasswordSuccess extends ScreenMembers {} +``` + +</RequestExample> + +## Properties + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-success.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-success.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignup.mdx new file mode 100644 index 000000000..db32b61fc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignup.mdx @@ -0,0 +1,50 @@ +--- +title: "ScreenMembersOnSignup" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnSignup extends ScreenMembers { + loginLink: string | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="loginLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/signup.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupId.mdx new file mode 100644 index 000000000..7481245cc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupId.mdx @@ -0,0 +1,50 @@ +--- +title: "ScreenMembersOnSignupId" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnSignupId extends ScreenMembers { + loginLink: string | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="loginLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/signup-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupPassword.mdx new file mode 100644 index 000000000..5671fb387 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupPassword.mdx @@ -0,0 +1,67 @@ +--- +title: "ScreenMembersOnSignupPassword" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ScreenMembersOnSignupPassword extends ScreenMembers { + loginLink: string | null; + editLink: string | null; + data: { + email?: string; + phoneNumber?: string; + username?: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="loginLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="editLink" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="data" type="object"> + <Expandable title="properties"> + <ParamField path="email" type={<span>string</span>}> + </ParamField> + <ParamField path="phoneNumber" type={<span>string</span>}> + </ParamField> + <ParamField path="username" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captchaImage" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaSiteKey" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="captchaProvider" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="links" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="texts" type={<span>Record<string, string> | null</span>}> +</ParamField> + +<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/signup-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectCountryCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectCountryCodeOptions.mdx new file mode 100644 index 000000000..71e91c9cf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectCountryCodeOptions.mdx @@ -0,0 +1,37 @@ +--- +title: "SelectCountryCodeOptions" +description: "Options for selecting a country code" +--- + +<RequestExample> + +```typescript Interface lines +export interface SelectCountryCodeOptions { + /** The country code (e.g. 'US', 'GB') */ + country_code: string; + /** The phone prefix (e.g. '+1', '+44') */ + phone_prefix: string; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="country_code" type={<span>string</span>} required> + The country code (e.g. 'US', 'GB') +</ParamField> + +<ParamField path="phone_prefix" type={<span>string</span>} required> + The phone prefix (e.g. '+1', '+44') +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> + Any additional custom options +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-country-codes.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaEmailOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaEmailOptions.mdx new file mode 100644 index 000000000..24fecf9c6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaEmailOptions.mdx @@ -0,0 +1,34 @@ +--- +title: "SelectMfaEmailOptions" +description: "Options for selecting an email address" +--- + +<RequestExample> + +```typescript Interface lines +export interface SelectMfaEmailOptions { + /** + * @param {number} index - The index of the phone number to select. + * + */ + index: number; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="index" type={<span>number</span>} required> + @param index - The index of the phone number to select. +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> + Any additional custom options +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-email-list.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaPushDeviceOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaPushDeviceOptions.mdx new file mode 100644 index 000000000..2534cabd8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaPushDeviceOptions.mdx @@ -0,0 +1,32 @@ +--- +title: "SelectMfaPushDeviceOptions" +description: "Options for selecting an MFA push device." +--- + +<RequestExample> + +```typescript Interface lines +export interface SelectMfaPushDeviceOptions { + /** + * The index of the device to select from the list of enrolled devices. + * The index is 0-based. + */ + deviceIndex: number; + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="deviceIndex" type={<span>number</span>} required> + The index of the device to select from the list of enrolled devices. The index is 0-based. +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-push-list.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectOrganizationOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectOrganizationOptions.mdx new file mode 100644 index 000000000..645cff9ad --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectOrganizationOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "SelectOrganizationOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface SelectOrganizationOptions { + organization: string; + state: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="organization" type={<span>string</span>} required> +</ParamField> + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/organization-picker.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/organization-picker.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions.mdx new file mode 100644 index 000000000..6ca5968d9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions.mdx @@ -0,0 +1,42 @@ +--- +title: "ShowErrorOptions" +description: "@interface ShowErrorOptions" +--- + +<RequestExample> + +```typescript Interface lines +export interface ShowErrorOptions { + /** + * The error object captured from a failed `navigator.credentials.get()` call. + * This should include at least `name` and `message` properties of the DOMException. + * @type {WebAuthnErrorDetails} + * @example { name: "NotAllowedError", message: "The operation was aborted by the user." } + */ + error: WebAuthnErrorDetails; + + /** + * Optional. If `true`, and if the screen context (`screen.showRememberDevice`) + * indicates that remembering the device is an option, this signals the user's + * intent to remember this browser/device. + * @type {boolean | undefined} + */ + rememberDevice?: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="error" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>} required> + The error object captured from a failed `navigator.credentials.get()` call. This should include at least `name` and `message` properties of the DOMException. +</ParamField> + +<ParamField path="rememberDevice" type={<span>boolean</span>}> + Optional. If `true`, and if the screen context (`screen.showRememberDevice`) indicates that remembering the device is an option, this signals the user's intent to remember this browser/device. +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupId.mdx new file mode 100644 index 000000000..fad5202de --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupId.mdx @@ -0,0 +1,283 @@ +--- +title: "SignupId" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface SignupId extends BaseContext { + screen: ExtendedScreenContext; + untrusted_data?: ExtendedUntrustedDataContext; +} +``` + +```typescript signup +import SignupId from "@auth0/auth0-acul-js/signup-id"; + const signupIdManager = new SignupId(); + + //get mandatory & optional identifiers required for signup + const { transaction } = signupIdManager; + const mandatoryIdentifier = transaction.getRequiredIdentifiers(); // eg: email + const optionalIdentifiers = transaction.getOptionalIdentifiers() // eg: phone + + /* Based on mandatory & optional identifiers users can render corresponding field on signup-id screen */ + + const signupParams = { + email : "testEmail", + phone : "+91923456789" + } + + signupIdManager.signup(signupParams); +``` + +```typescript socialSignup +import SignupId from "@auth0/auth0-acul-js/signup-id"; + + const signupIdManager = new SignupId(); + const { transaction } = signupIdManager; + + //get social connections + const socialConnection = transaction.alternateConnections; //eg: "google-oauth2" + const signupParams = { + connection : socialConnection[0].name, // "google-oauth2" + }; + + signupIdManager.federatedSignup(signupParams); +``` + +```typescript signupId Example +import React, { useState, useEffect } from 'react'; +import SignupId from '@auth0/auth0-acul-js/signup-id'; +import { Logo } from '../../components/Logo'; +import Button from '../../components/Button'; + +const SignupIdScreen: React.FC = () => { + const [email, setEmail] = useState(''); + const [phone, setPhone] = useState(''); + const [username, setUsername] = useState(''); + const [error, setError] = useState(''); + const [success, setSuccess] = useState(false); + const [identifiers, setIdentifiers] = useState<Array<{ type: string; required: boolean }>>([]); + + const signupIdManager = new SignupId(); + + const title = signupIdManager.screen.texts?.title || ''; + const description = signupIdManager.screen.texts?.description || ''; + const federatedConnections = signupIdManager.transaction.alternateConnections ?? []; + const links = signupIdManager.screen.links ?? {}; + + const { isValid, errors } = signupIdManager.validateUsername(username); + + + useEffect(() => { + const enabledIds = signupIdManager.getSignupIdentifiers(); + setIdentifiers(enabledIds ?? []); + }, []); + + const handleSignup = async (e: React.FormEvent) => { + e.preventDefault(); + setError(''); + setSuccess(false); + + const emailRequired = identifiers.find((id) => id.type === 'email')?.required; + const phoneRequired = identifiers.find((id) => id.type === 'phone')?.required; + const usernameRequired = identifiers.find((id) => id.type === 'username')?.required; + + if (emailRequired && !email) { + setError('Email is required.'); + return; + } + if (phoneRequired && !phone) { + setError('Phone number is required.'); + return; + } + if (usernameRequired && !username) { + setError('Username is required.'); + return; + } + + if(!isValid){ + setError(errors[0].message); + return; + } + + try { + await signupIdManager.signup({ + email, + phone, + username, + }); + setSuccess(true); + } catch { + setError('Signup failed. Please try again later.'); + } + }; + + const handleFederatedSignup = (connectionName: string) => { + signupIdManager.federatedSignup({ connection: connectionName }); + }; + + return ( + <div className="prompt-container"> + <Logo /> + {/* Title Section */} + <div className="title-container"> + <h1 className="mt-6 text-center text-3xl font-extrabold text-gray-900">{title}</h1> + <div> + <p className="mt-2 text-center text-sm text-gray-600">{description}</p> + </div> + </div> + + {/* Form Section */} + <div className="input-container"> + <form onSubmit={handleSignup}> + {/* Email */} + {identifiers.find((id) => id.type === 'email') && ( + <div> + <label>Email {identifiers.find((id) => id.type === 'email')?.required && '*'}</label> + <input + type="email" + id="email" + placeholder="Enter your email" + value={email} + onChange={(e) => setEmail(e.target.value)} + className="input-field" + /> + </div> + )} + + {/* Phone */} + {identifiers.find((id) => id.type === 'phone') && ( + <div> + <label>Phone {identifiers.find((id) => id.type === 'phone')?.required && '*'}</label> + <input + type="tel" + id="phone" + placeholder="Enter your phone number" + value={phone} + onChange={(e) => setPhone(e.target.value)} + className="input-field" + /> + </div> + )} + + {/* Username */} + {identifiers.find((id) => id.type === 'username') && ( + <div> + <label>Username {identifiers.find((id) => id.type === 'username')?.required && '*'}</label> + <input + type="text" + id="username" + placeholder="Enter your username" + value={username} + onChange={(e) => setUsername(e.target.value)} + className={`input-field ${username && !isValid ? 'border-red-500' : 'border-gray-300' + }`} + /> + + {username.length > 0 && errors.length > 0 && ( + <ul className="mt-1 text-sm text-red-500"> + {errors.map((err, i) => ( + <li key={i}>{err.message}</li> + ))} + </ul> + )} + </div> + )} + + {/* Error & Success Messages */} + {error && ( + <div className="error-container"> + <p>{error}</p> + </div> + )} + {success && ( + <div className="success-message"> + Signup successful! Please check your email to verify your account. + </div> + )} + + {/* Submit Button */} + <div className="button-container"> + <Button onClick={() => handleSignup}> + Sign Up + </Button> + </div> + </form> + + {/* Login Link */} + {links?.login && ( + <div className="mt-6 text-center text-sm"> + <span> + Already have an account? + </span> + <a + href={links.loginLink} + className="text-indigo-600 hover:underline" + > + Log in + </a> + </div> + )} + {/* OR separator */} + <div className="flex items-center my-4"> + <div className="flex-1 border-t border-gray-300"></div> + <span className="px-3 text-sm text-gray-400">OR</span> + <div className="flex-1 border-t border-gray-300"></div> + </div> + + {/* Google login */} + {federatedConnections.length > 0 && federatedConnections.map((conn: any) => ( + <button + key={conn.name} + onClick={() => handleFederatedSignup(conn.name)} + className="w-full flex items-center justify-center gap-2 rounded-md border border-gray-300 bg-white px-4 py-2 text-sm font-medium text-gray-700 hover:bg-gray-50" + > + {/* <img src="/google-icon.svg" alt="" className="h-4 w-4" /> */} + Continue with {conn.options?.display_name || conn.name} + </button> + ))} + + </div> + </div> + ); +}; + +export default SignupIdScreen; +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext">ExtendedScreenContext</a></span>} required> +</ParamField> + +<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext">ExtendedUntrustedDataContext</a></span>}> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/signup-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupIdMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupIdMembers.mdx new file mode 100644 index 000000000..acba2f1b8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupIdMembers.mdx @@ -0,0 +1,68 @@ +--- +title: "SignupIdMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface SignupIdMembers extends BaseMembers { + screen: ScreenMembersOnSignupId; + transaction: TransactionMembersOnSignupId; + signup(payload: SignupOptions): Promise<void>; + federatedSignup(payload: FederatedSignupOptions): Promise<void>; + getSignupIdentifiers(): Identifier[] | null; + pickCountryCode(payload?: CustomOptions): Promise<void>; + validateUsername(username: string): UsernameValidationResult; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupId">ScreenMembersOnSignupId</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a></span>} required> +</ParamField> + +<ParamField path="signup" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="federatedSignup" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="getSignupIdentifiers" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier">Identifier[]</a> | null</span>}> +</ParamField> + +<ParamField path="pickCountryCode" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="validateUsername" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/signup-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupMembers.mdx new file mode 100644 index 000000000..dffde6731 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupMembers.mdx @@ -0,0 +1,94 @@ +--- +title: "SignupMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface SignupMembers extends BaseMembers { + screen: ScreenMembersOnSignup; + transaction: TransactionMembersOnSignup; + signup(payload: SignupOptions): Promise<void>; + federatedSignup(payload: FederatedSignupOptions): Promise<void>; + pickCountryCode(payload?: CustomOptions): Promise<void>; + validatePassword(password: string): PasswordValidationResult; + /** + * Returns a list of enabled identifiers (e.g. email, phone, username) + * based on the current transaction state. + * + * Identifiers may be required or optional depending on the connection strategy + * and configuration provided during the authentication or signup flow. + * + * @returns An array of enabled {@link Identifier} objects, or `null` if the transaction is not initialized. + * + * @example + * ```ts + * const identifiers = authClient.getSignupIdentifiers(); + * if (identifiers) { + * identifiers.forEach(({ type, required }) => { + * console.log(`${type} is ${required ? 'required' : 'optional'}`); + * }); + * } + * ``` + * @utilityFeature + * @see Identifier + */ + getSignupIdentifiers(): Identifier[] | null; + validateUsername(username: string): UsernameValidationResult; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignup">ScreenMembersOnSignup</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignup">TransactionMembersOnSignup</a></span>} required> +</ParamField> + +<ParamField path="signup" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="federatedSignup" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="pickCountryCode" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="validatePassword" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>} required> +</ParamField> + +<ParamField path="getSignupIdentifiers" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier">Identifier[]</a> | null</span>}> + Returns a list of enabled identifiers (e.g. email, phone, username) based on the current transaction state. Identifiers may be required or optional depending on the connection strategy and configuration provided during the authentication or signup flow. +</ParamField> + +<ParamField path="validateUsername" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/signup.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions.mdx new file mode 100644 index 000000000..864f45efb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions.mdx @@ -0,0 +1,43 @@ +--- +title: "SignupOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface SignupOptions { + email?: string; + username?: string; + phoneNumber?: string; + password?: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="email" type={<span>string</span>}> +</ParamField> + +<ParamField path="username" type={<span>string</span>}> +</ParamField> + +<ParamField path="phoneNumber" type={<span>string</span>}> +</ParamField> + +<ParamField path="password" type={<span>string</span>}> +</ParamField> + +<ParamField path="captcha" type={<span>string</span>}> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/signup.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPassword.mdx new file mode 100644 index 000000000..2994aa6b2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPassword.mdx @@ -0,0 +1,238 @@ +--- +title: "SignupPassword" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface SignupPassword extends BaseContext { + screen: ScreenContextOnSignupPassword; +} +``` + +```typescript signup +import SignupPassword from "@auth0/auth0-acul-js/signup-password"; + + const signupPasswordManager = new SignupPassword(); + const { transaction, screen } = signupPasswordManager; + + //get mandatory & optional identifiers required for signup-password screen to proceed + const mandatoryIdentifier = transaction.getRequiredIdentifiers(); //eg: email + const optionalIdentifiers = transaction.getOptionalIdentifiers() //eg: phone + + //get signup data submitted on previous screen from previous screen + const data = screen.data; //eg: email, phone + + + const signupParams = { + email : data.email, + phone : data.phone_number, + password : "********" + }; + + signupPasswordManager.signup(signupParams); +``` + +```typescript signupPassword Example using validatePassword +import React, { useState } from 'react'; +import SignupPassword from '@auth0/auth0-acul-js/signup-password'; +import { Logo } from '../../components/Logo'; +import Button from '../../components/Button'; + +const SignupPasswordScreen: React.FC = () => { + const [password, setPassword] = useState(''); + const [error, setError] = useState(''); + const [success, setSuccess] = useState(false); + + const signupPasswordManager = new SignupPassword(); + + const email = signupPasswordManager.screen.data?.email || ''; + const phone = signupPasswordManager.screen.data?.phoneNumber || ''; + const username = signupPasswordManager.screen.data?.username || ''; + + const title = signupPasswordManager.screen.texts?.title || ''; + const description = signupPasswordManager.screen.texts?.description || ''; + + const { isValid, results } = signupPasswordManager.validatePassword(password); + + const handleSignup = async (e: React.FormEvent) => { + e.preventDefault(); + setError(''); + setSuccess(false); + + if (!email || !password) { + setError('Email and password are required.'); + return; + } + + if (!isValid) return; + + try { + await signupPasswordManager.signup({ email, username, phone, password }); + setSuccess(true); + } catch { + setError('Signup failed. Please try again later.'); + } + }; + + return ( + <div className="prompt-container"> + <Logo /> + + {/* Title Section (inline, not imported) */} + <div className="title-container"> + <h1 className="mt-6 text-center text-3xl font-extrabold text-gray-900">{title}</h1> + <div> + <p className="mt-2 text-center text-sm text-gray-600">{description}</p> + </div> + </div> + + {/* Form */} + <div className="input-container"> + <form onSubmit={handleSignup}> + {email && ( + <div> + <label>Email</label> + <input + type="email" + id="email" + placeholder="Enter your email" + value={email} + disabled + /> + </div> + )} + + + {username && ( + <div> + <label>Username</label> + <input + type="text" + id="username" + placeholder="Enter your username" + value={username} + disabled + /> + </div> + )} + + { + phone && ( + <div> + <label>Phone</label> + <input + type="tel" + id="phone" + placeholder="Enter your phone number" + value={phone} + disabled + /> + </div> + ) + } + + + + <label>Password</label> + <input + type="password" + id="password" + placeholder="Enter your password" + value={password} + onChange={(e) => setPassword(e.target.value)} + className={!isValid && password.length > 0 ? 'error' : ''} + /> + + {/* Password Validation Rules */} + + {password.length > 0 && results.length > 0 && ( + <div className="mt-2 border border-gray-300 rounded p-2 text-sm"> + <p className="text-gray-700 mb-1">Your password must contain:</p> + <ul className="list-disc ml-4"> + {results.map((rule) => ( + <li + key={rule.code} + className={rule.status === 'valid' ? 'text-green-600' : 'text-gray-700'} + > + {rule.label} + {rule.items && rule.items.length > 0 && ( + <ul className="ml-5 list-disc"> + {rule.items.map((sub) => ( + <li + key={sub.code} + className={sub.status === 'valid' ? 'text-green-600' : 'text-gray-700'} + > + {sub.label} + </li> + ))} + </ul> + )} + </li> + ))} + </ul> + </div> + )} + {/* Error & Success messages */} + {error && ( + <div className="error-container"> + <p>{error}</p> + </div> + )} + + {success && ( + <div className="success-message"> + Signup successful! Please check your email to verify your account. + </div> + )} + + {/* Submit Button */} + <div className="button-container"> + <Button onClick={() => handleSignup}> + Sign Up + </Button> + </div> + </form> + </div> + </div> + ); +}; + +export default SignupPasswordScreen; +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnSignupPassword">ScreenContextOnSignupPassword</a></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> +</ParamField> + +<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/signup-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordMembers.mdx new file mode 100644 index 000000000..f33e08cf3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordMembers.mdx @@ -0,0 +1,60 @@ +--- +title: "SignupPasswordMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface SignupPasswordMembers extends BaseMembers { + screen: ScreenMembersOnSignupPassword; + transaction: TransactionMembersOnSignupPassword; + signup(payload: SignupPasswordOptions): Promise<void>; + federatedSignup(payload: FederatedSignupOptions): Promise<void>; + validatePassword(password: string): PasswordValidationResult; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupPassword">ScreenMembersOnSignupPassword</a></span>} required> +</ParamField> + +<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupPassword">TransactionMembersOnSignupPassword</a></span>} required> +</ParamField> + +<ParamField path="signup" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="federatedSignup" type={<span>Promise<void></span>} required> +</ParamField> + +<ParamField path="validatePassword" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>} required> +</ParamField> + +<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> +</ParamField> + +<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> +</ParamField> + +<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> +</ParamField> + +<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> +</ParamField> + +<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> +</ParamField> + +<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> +</ParamField> + +<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/signup-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordOptions.mdx new file mode 100644 index 000000000..38f3bf2f5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordOptions.mdx @@ -0,0 +1,43 @@ +--- +title: "SignupPasswordOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface SignupPasswordOptions { + email?: string; + username?: string; + phoneNumber?: string; + password: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="email" type={<span>string</span>}> +</ParamField> + +<ParamField path="username" type={<span>string</span>}> +</ParamField> + +<ParamField path="phoneNumber" type={<span>string</span>}> +</ParamField> + +<ParamField path="password" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captcha" type={<span>string</span>}> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/signup-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SocialConnection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SocialConnection.mdx new file mode 100644 index 000000000..1844b2495 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SocialConnection.mdx @@ -0,0 +1,27 @@ +--- +title: "SocialConnection" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface SocialConnection extends Connection {} +``` + +</RequestExample> + +## Properties + +<ParamField path="name" type={<span>string</span>} required> +</ParamField> + +<ParamField path="strategy" type={<span>string</span>} required> +</ParamField> + +<ParamField path="metadata" type={<span>Record<string, string></span>}> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions.mdx new file mode 100644 index 000000000..714e28cc8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions.mdx @@ -0,0 +1,31 @@ +--- +title: "StartResendOptions" +description: "Options for configuring resend functionality" +--- + +<RequestExample> + +```typescript Interface lines +export interface StartResendOptions { + timeoutSeconds?: number; + onStatusChange?: OnStatusChangeCallback; + onTimeout?: () => void; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="timeoutSeconds" type={<span>number</span>}> +</ParamField> + +<ParamField path="onStatusChange" type={<span>OnStatusChangeCallback</span>}> +</ParamField> + +<ParamField path="onTimeout" type={<span>() => void</span>}> +</ParamField> + +--- + +**File:** [interfaces/utils/resend-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/resend-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCaptchaOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCaptchaOptions.mdx new file mode 100644 index 000000000..292edebd0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCaptchaOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "SubmitCaptchaOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface SubmitCaptchaOptions { + captcha: string; + [key: string]: string | number; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="captcha" type={<span>string</span>} required> +</ParamField> + +<ParamField path="unknown" type={<span>string | number</span>} required> +</ParamField> + +--- + +**File:** [interfaces/screens/interstitial-captcha.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCodeOptions.mdx new file mode 100644 index 000000000..73941ea2c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCodeOptions.mdx @@ -0,0 +1,31 @@ +--- +title: "SubmitCodeOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface SubmitCodeOptions { + code: string | number; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="code" type={<span>string | number</span>} required> +</ParamField> + +<ParamField path="captcha" type={<span>string</span>}> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-passwordless-email-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitOTPOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitOTPOptions.mdx new file mode 100644 index 000000000..d4dcca7d6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitOTPOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "SubmitOTPOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface SubmitOTPOptions { + username?: string; + code: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="username" type={<span>string</span>}> +</ParamField> + +<ParamField path="code" type={<span>string</span>} required> +</ParamField> + +<ParamField path="captcha" type={<span>string</span>}> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-passwordless-sms-otp.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitPasskeyCredentialOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitPasskeyCredentialOptions.mdx new file mode 100644 index 000000000..652c9269c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitPasskeyCredentialOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "SubmitPasskeyCredentialOptions" +description: "@interface SubmitPasskeyCredentialOptions" +--- + +<RequestExample> + +```typescript Interface lines +export interface SubmitPasskeyCredentialOptions extends CustomOptions { + // No longer requires publicKey here, as it's sourced from this.screen.publicKey +} +``` + +</RequestExample> + +## Properties + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-platform-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext.mdx new file mode 100644 index 000000000..cec85e231 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext.mdx @@ -0,0 +1,35 @@ +--- +title: "TenantContext" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface TenantContext { + name?: string; + friendly_name?: string; + enabled_locales?: string[]; + enabled_factors?: string[]; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="name" type={<span>string</span>}> +</ParamField> + +<ParamField path="friendly_name" type={<span>string</span>}> +</ParamField> + +<ParamField path="enabled_locales" type={<span>string[]</span>}> +</ParamField> + +<ParamField path="enabled_factors" type={<span>string[]</span>}> +</ParamField> + +--- + +**File:** [interfaces/models/tenant.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/tenant.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers.mdx new file mode 100644 index 000000000..875344247 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers.mdx @@ -0,0 +1,35 @@ +--- +title: "TenantMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface TenantMembers { + name: string | null; + friendlyName: string | null; + enabledLocales: string[] | null; + enabledFactors: string[] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="name" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="friendlyName" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="enabledLocales" type={<span>string[] | null</span>}> +</ParamField> + +<ParamField path="enabledFactors" type={<span>string[] | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/models/tenant.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/tenant.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext.mdx new file mode 100644 index 000000000..1d1d420a3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext.mdx @@ -0,0 +1,43 @@ +--- +title: "TransactionContext" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface TransactionContext { + state: string; + locale: string; + errors?: Error[]; + country_code?: CountryCode; + connection?: DBConnection | PasswordlessConnection; + alternate_connections?: (Connection | EnterpriseConnectionContext)[]; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="locale" type={<span>string</span>} required> +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a></span>}> +</ParamField> + +<ParamField path="country_code" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a></span>}> +</ParamField> + +<ParamField path="connection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection">DBConnection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordlessConnection">PasswordlessConnection</a></span>}> +</ParamField> + +<ParamField path="alternate_connections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext">EnterpriseConnectionContext</a>)[]</span>}> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLogin.mdx new file mode 100644 index 000000000..abfae3170 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLogin.mdx @@ -0,0 +1,38 @@ +--- +title: "TransactionContextOnLogin" +description: "Extended transaction context interface for the login screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface TransactionContextOnLogin extends TransactionContext { + connection: DBConnection; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="connection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection">DBConnection</a></span>} required> +</ParamField> + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="locale" type={<span>string</span>} required> +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a></span>}> +</ParamField> + +<ParamField path="country_code" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a></span>}> +</ParamField> + +<ParamField path="alternate_connections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext">EnterpriseConnectionContext</a>)[]</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLoginPassword.mdx new file mode 100644 index 000000000..5cf12422d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLoginPassword.mdx @@ -0,0 +1,38 @@ +--- +title: "TransactionContextOnLoginPassword" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface TransactionContextOnLoginPassword extends TransactionContext { + connection: DBConnection; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="connection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection">DBConnection</a></span>} required> +</ParamField> + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="locale" type={<span>string</span>} required> +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a></span>}> +</ParamField> + +<ParamField path="country_code" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a></span>}> +</ParamField> + +<ParamField path="alternate_connections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext">EnterpriseConnectionContext</a>)[]</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers.mdx new file mode 100644 index 000000000..967868051 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers.mdx @@ -0,0 +1,55 @@ +--- +title: "TransactionMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface TransactionMembers { + state: string; + locale: string; + countryCode: CountryCode['code'] | null; + countryPrefix: CountryCode['prefix'] | null; + connectionStrategy: string | null; + hasErrors: boolean; + errors: Error[] | null; + currentConnection: Connection | null; + alternateConnections: (Connection | EnterpriseConnection)[] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="locale" type={<span>string</span>} required> +</ParamField> + +<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> +</ParamField> + +<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> +</ParamField> + +<ParamField path="connectionStrategy" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="hasErrors" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> +</ParamField> + +<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> +</ParamField> + +<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLogin.mdx new file mode 100644 index 000000000..c37c12eec --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLogin.mdx @@ -0,0 +1,66 @@ +--- +title: "TransactionMembersOnLogin" +description: "Extended transaction members interface for the login screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface TransactionMembersOnLogin extends TransactionMembers { + isSignupEnabled: boolean; + isForgotPasswordEnabled: boolean; + isPasskeyEnabled: boolean; + passwordPolicy: PasswordPolicy | null; + allowedIdentifiers: IdentifierType[] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="isSignupEnabled" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="isForgotPasswordEnabled" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="isPasskeyEnabled" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="passwordPolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy">PasswordPolicy</a> | null</span>}> +</ParamField> + +<ParamField path="allowedIdentifiers" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="locale" type={<span>string</span>} required> +</ParamField> + +<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> +</ParamField> + +<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> +</ParamField> + +<ParamField path="connectionStrategy" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="hasErrors" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> +</ParamField> + +<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> +</ParamField> + +<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId.mdx new file mode 100644 index 000000000..aad8b7373 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId.mdx @@ -0,0 +1,70 @@ +--- +title: "TransactionMembersOnLoginId" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface TransactionMembersOnLoginId extends TransactionMembers { + isSignupEnabled: boolean; + isPasskeyEnabled: boolean; + isForgotPasswordEnabled: boolean; + isUsernameRequired: boolean; + usernamePolicy: UsernamePolicy | null; + allowedIdentifiers: IdentifierType[] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="isSignupEnabled" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="isPasskeyEnabled" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="isForgotPasswordEnabled" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="isUsernameRequired" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="usernamePolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy">UsernamePolicy</a> | null</span>}> +</ParamField> + +<ParamField path="allowedIdentifiers" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="locale" type={<span>string</span>} required> +</ParamField> + +<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> +</ParamField> + +<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> +</ParamField> + +<ParamField path="connectionStrategy" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="hasErrors" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> +</ParamField> + +<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> +</ParamField> + +<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPassword.mdx new file mode 100644 index 000000000..604b043d3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPassword.mdx @@ -0,0 +1,70 @@ +--- +title: "TransactionMembersOnLoginPassword" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface TransactionMembersOnLoginPassword extends TransactionMembers { + isSignupEnabled: boolean; + isForgotPasswordEnabled: boolean; + isPasskeyEnabled: boolean; + getPasswordPolicy(): PasswordPolicy | null; + getUsernamePolicy(): UsernamePolicy | null; + getAllowedIdentifiers(): IdentifierType[] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="isSignupEnabled" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="isForgotPasswordEnabled" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="isPasskeyEnabled" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="getPasswordPolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy">PasswordPolicy</a> | null</span>}> +</ParamField> + +<ParamField path="getUsernamePolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy">UsernamePolicy</a> | null</span>}> +</ParamField> + +<ParamField path="getAllowedIdentifiers" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="locale" type={<span>string</span>} required> +</ParamField> + +<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> +</ParamField> + +<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> +</ParamField> + +<ParamField path="connectionStrategy" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="hasErrors" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> +</ParamField> + +<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> +</ParamField> + +<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx new file mode 100644 index 000000000..cb74cb595 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx @@ -0,0 +1,50 @@ +--- +title: "TransactionMembersOnLoginPasswordlessEmailCode" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface TransactionMembersOnLoginPasswordlessEmailCode extends TransactionMembers { + isSignupEnabled: boolean | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="isSignupEnabled" type={<span>boolean | null</span>}> +</ParamField> + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="locale" type={<span>string</span>} required> +</ParamField> + +<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> +</ParamField> + +<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> +</ParamField> + +<ParamField path="connectionStrategy" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="hasErrors" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> +</ParamField> + +<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> +</ParamField> + +<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-passwordless-email-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx new file mode 100644 index 000000000..37b6b472b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx @@ -0,0 +1,50 @@ +--- +title: "TransactionMembersOnLoginPasswordlessSmsOtp" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface TransactionMembersOnLoginPasswordlessSmsOtp extends TransactionMembers { + isSignupEnabled: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="isSignupEnabled" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="locale" type={<span>string</span>} required> +</ParamField> + +<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> +</ParamField> + +<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> +</ParamField> + +<ParamField path="connectionStrategy" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="hasErrors" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> +</ParamField> + +<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> +</ParamField> + +<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/login-passwordless-sms-otp.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPassword.mdx new file mode 100644 index 000000000..071bf61ea --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPassword.mdx @@ -0,0 +1,50 @@ +--- +title: "TransactionMembersOnResetPassword" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface TransactionMembersOnResetPassword extends TransactionMembers { + passwordPolicy: PasswordPolicy | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="passwordPolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy">PasswordPolicy</a> | null</span>}> +</ParamField> + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="locale" type={<span>string</span>} required> +</ParamField> + +<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> +</ParamField> + +<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> +</ParamField> + +<ParamField path="connectionStrategy" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="hasErrors" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> +</ParamField> + +<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> +</ParamField> + +<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPasswordRequest.mdx new file mode 100644 index 000000000..ce6f2afe0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPasswordRequest.mdx @@ -0,0 +1,58 @@ +--- +title: "TransactionMembersOnResetPasswordRequest" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface TransactionMembersOnResetPasswordRequest extends TransactionMembers { + allowedIdentifiers: IdentifierType[] | null; + requiredIdentifiers: IdentifierType[] | null; + hasFlexibleIdentifier: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="allowedIdentifiers" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +<ParamField path="requiredIdentifiers" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +<ParamField path="hasFlexibleIdentifier" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="locale" type={<span>string</span>} required> +</ParamField> + +<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> +</ParamField> + +<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> +</ParamField> + +<ParamField path="connectionStrategy" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="hasErrors" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> +</ParamField> + +<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> +</ParamField> + +<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-request.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignup.mdx new file mode 100644 index 000000000..e41aaa212 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignup.mdx @@ -0,0 +1,66 @@ +--- +title: "TransactionMembersOnSignup" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface TransactionMembersOnSignup extends TransactionMembers { + isPasskeyEnabled: boolean; + usernamePolicy: UsernamePolicy | null; + requiredIdentifiers: IdentifierType[] | null; + optionalIdentifiers: IdentifierType[] | null; + passwordPolicy: PasswordPolicy | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="isPasskeyEnabled" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="usernamePolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy">UsernamePolicy</a> | null</span>}> +</ParamField> + +<ParamField path="requiredIdentifiers" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +<ParamField path="optionalIdentifiers" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +<ParamField path="passwordPolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy">PasswordPolicy</a> | null</span>}> +</ParamField> + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="locale" type={<span>string</span>} required> +</ParamField> + +<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> +</ParamField> + +<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> +</ParamField> + +<ParamField path="connectionStrategy" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="hasErrors" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> +</ParamField> + +<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> +</ParamField> + +<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/signup.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId.mdx new file mode 100644 index 000000000..2ec54456c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId.mdx @@ -0,0 +1,62 @@ +--- +title: "TransactionMembersOnSignupId" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface TransactionMembersOnSignupId extends TransactionMembers { + isPasskeyEnabled: boolean; + usernamePolicy: UsernamePolicy | null; + requiredIdentifiers: IdentifierType[] | null; + optionalIdentifiers: IdentifierType[] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="isPasskeyEnabled" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="usernamePolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy">UsernamePolicy</a> | null</span>}> +</ParamField> + +<ParamField path="requiredIdentifiers" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +<ParamField path="optionalIdentifiers" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="locale" type={<span>string</span>} required> +</ParamField> + +<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> +</ParamField> + +<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> +</ParamField> + +<ParamField path="connectionStrategy" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="hasErrors" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> +</ParamField> + +<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> +</ParamField> + +<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/signup-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupPassword.mdx new file mode 100644 index 000000000..c38579e60 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupPassword.mdx @@ -0,0 +1,62 @@ +--- +title: "TransactionMembersOnSignupPassword" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface TransactionMembersOnSignupPassword extends TransactionMembers { + isPasskeyEnabled: boolean; + passwordPolicy: PasswordPolicy | null; + requiredIdentifiers: IdentifierType[] | null; + optionalIdentifiers: IdentifierType[] | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="isPasskeyEnabled" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="passwordPolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy">PasswordPolicy</a> | null</span>}> +</ParamField> + +<ParamField path="requiredIdentifiers" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +<ParamField path="optionalIdentifiers" type={<span>IdentifierType[] | null</span>}> +</ParamField> + +<ParamField path="state" type={<span>string</span>} required> +</ParamField> + +<ParamField path="locale" type={<span>string</span>} required> +</ParamField> + +<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> +</ParamField> + +<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> +</ParamField> + +<ParamField path="connectionStrategy" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="hasErrors" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> +</ParamField> + +<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> +</ParamField> + +<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/signup-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions.mdx new file mode 100644 index 000000000..2685ad104 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions.mdx @@ -0,0 +1,33 @@ +--- +title: "TryAnotherMethodOptions" +description: "@interface TryAnotherMethodOptions" +--- + +<RequestExample> + +```typescript Interface lines +export interface TryAnotherMethodOptions extends CustomOptions { + /** + * Optional. If `true`, and if the screen context (`screen.showRememberDevice`) + * indicates that remembering the device is an option, this signals the user's + * intent to remember this browser/device. + * @type {boolean | undefined} + */ + rememberDevice?: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="rememberDevice" type={<span>boolean</span>}> + Optional. If `true`, and if the screen context (`screen.showRememberDevice`) indicates that remembering the device is an option, this signals the user's intent to remember this browser/device. +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext.mdx new file mode 100644 index 000000000..70625574b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext.mdx @@ -0,0 +1,45 @@ +--- +title: "UntrustedDataContext" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface UntrustedDataContext { + submitted_form_data?: { + [key: string]: string | undefined | boolean | null; + [key: `ulp_${string}`]: string | undefined; + }; + authorization_params?: { + login_hint?: string; + screen_hint?: string; + ui_locales?: string; + [key: `ext-${string}`]: string; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="submitted_form_data" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="authorization_params" type="object"> + <Expandable title="properties"> + <ParamField path="login_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="screen_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="ui_locales" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/models/untrusted-data.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/untrusted-data.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers.mdx new file mode 100644 index 000000000..1f0d34c93 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers.mdx @@ -0,0 +1,42 @@ +--- +title: "UntrustedDataMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface UntrustedDataMembers { + submittedFormData: { [key: string]: string | number | boolean | undefined | null } | null; + authorizationParams: { + login_hint?: string; + screen_hint?: string; + ui_locales?: string; + [key: `ext-${string}`]: string; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="submittedFormData" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="authorizationParams" type="object"> + <Expandable title="properties"> + <ParamField path="login_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="screen_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="ui_locales" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/models/untrusted-data.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/untrusted-data.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx new file mode 100644 index 000000000..c4cbafd8a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx @@ -0,0 +1,40 @@ +--- +title: "UntrustedDataMembersOnMfaEmailChallenge" +description: "Interface for untrusted data specific to mfa-email-challenge screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface UntrustedDataMembersOnMfaEmailChallenge extends UntrustedDataMembers { + submittedFormData: { + rememberDevice: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="submittedFormData" type="object"> + <Expandable title="properties"> + <ParamField path="rememberDevice" type={<span>boolean</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="authorizationParams" type="object"> + <Expandable title="properties"> + <ParamField path="login_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="screen_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="ui_locales" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-email-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx new file mode 100644 index 000000000..cbe8cb89e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx @@ -0,0 +1,40 @@ +--- +title: "UntrustedDataMembersOnMfaOtpChallenge" +description: "Interface for untrusted data specific to mfa-otp-challenge screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface UntrustedDataMembersOnMfaOtpChallenge extends UntrustedDataMembers { + submittedFormData: { + rememberDevice: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="submittedFormData" type="object"> + <Expandable title="properties"> + <ParamField path="rememberDevice" type={<span>boolean</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="authorizationParams" type="object"> + <Expandable title="properties"> + <ParamField path="login_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="screen_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="ui_locales" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-otp-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx new file mode 100644 index 000000000..3a5c8c2bc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx @@ -0,0 +1,41 @@ +--- +title: "UntrustedDataMembersOnMfaPushChallengePush" +description: "Interface for untrusted data specific to mfa-push-challenge-push screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface UntrustedDataMembersOnMfaPushChallengePush + extends UntrustedDataMembers { + submittedFormData: { + rememberDevice: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="submittedFormData" type="object"> + <Expandable title="properties"> + <ParamField path="rememberDevice" type={<span>boolean</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="authorizationParams" type="object"> + <Expandable title="properties"> + <ParamField path="login_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="screen_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="ui_locales" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-push-challenge-push.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx new file mode 100644 index 000000000..21f509acf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx @@ -0,0 +1,40 @@ +--- +title: "UntrustedDataMembersOnMfaSmsChallenge" +description: "Interface for untrusted data specific to mfa-sms-challenge screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface UntrustedDataMembersOnMfaSmsChallenge extends UntrustedDataMembers { + submittedFormData: { + rememberDevice: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="submittedFormData" type="object"> + <Expandable title="properties"> + <ParamField path="rememberDevice" type={<span>boolean</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="authorizationParams" type="object"> + <Expandable title="properties"> + <ParamField path="login_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="screen_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="ui_locales" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-sms-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx new file mode 100644 index 000000000..a17b96f43 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx @@ -0,0 +1,40 @@ +--- +title: "UntrustedDataMembersOnMfaVoiceChallenge" +description: "Interface for untrusted data specific to mfa-voice-challenge screen" +--- + +<RequestExample> + +```typescript Interface lines +export interface UntrustedDataMembersOnMfaVoiceChallenge extends UntrustedDataMembers { + submittedFormData: { + rememberDevice: boolean; + } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="submittedFormData" type="object"> + <Expandable title="properties"> + <ParamField path="rememberDevice" type={<span>boolean</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="authorizationParams" type="object"> + <Expandable title="properties"> + <ParamField path="login_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="screen_hint" type={<span>string</span>}> + </ParamField> + <ParamField path="ui_locales" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-voice-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UseSecurityKeyOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UseSecurityKeyOptions.mdx new file mode 100644 index 000000000..33c1a1e9b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UseSecurityKeyOptions.mdx @@ -0,0 +1,34 @@ +--- +title: "UseSecurityKeyOptions" +description: "@interface UseSecurityKeyOptions" +--- + +<RequestExample> + +```typescript Interface lines +export interface UseSecurityKeyOptions extends CustomOptions { + /** + * Optional. If `true`, and if the screen context (`screen.showRememberDevice`) + * indicates that remembering the device is an option, this signals the user's + * intent to remember this browser/device for future authentications. + * The SDK will submit `rememberBrowser=true` in this case. + * @type {boolean | undefined} + */ + rememberDevice?: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="rememberDevice" type={<span>boolean</span>}> + Optional. If `true`, and if the screen context (`screen.showRememberDevice`) indicates that remembering the device is an option, this signals the user's intent to remember this browser/device for future authentications. The SDK will submit `rememberBrowser=true` in this case. +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext.mdx new file mode 100644 index 000000000..cd19daf89 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext.mdx @@ -0,0 +1,67 @@ +--- +title: "UserContext" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface UserContext { + id: string; + email?: string; + username?: string; + phone_number?: string; + picture?: string; + enrolled_factors?: string[]; + enrolled_emails?: EnrolledEmail[]; + enrolled_phone_numbers?: EnrolledPhoneNumber[]; + enrolled_devices?: EnrolledDevice[]; + organizations?: OrganizationContext[]; + user_metadata?: Record<string, string>; + app_metadata?: Record<string, string>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="id" type={<span>string</span>} required> +</ParamField> + +<ParamField path="email" type={<span>string</span>}> +</ParamField> + +<ParamField path="username" type={<span>string</span>}> +</ParamField> + +<ParamField path="phone_number" type={<span>string</span>}> +</ParamField> + +<ParamField path="picture" type={<span>string</span>}> +</ParamField> + +<ParamField path="enrolled_factors" type={<span>string[]</span>}> +</ParamField> + +<ParamField path="enrolled_emails" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail">EnrolledEmail[]</a></span>}> +</ParamField> + +<ParamField path="enrolled_phone_numbers" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber">EnrolledPhoneNumber[]</a></span>}> +</ParamField> + +<ParamField path="enrolled_devices" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice">EnrolledDevice[]</a></span>}> +</ParamField> + +<ParamField path="organizations" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext[]</a></span>}> +</ParamField> + +<ParamField path="user_metadata" type={<span>Record<string, string></span>}> +</ParamField> + +<ParamField path="app_metadata" type={<span>Record<string, string></span>}> +</ParamField> + +--- + +**File:** [interfaces/models/user.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/user.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers.mdx new file mode 100644 index 000000000..d50745585 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers.mdx @@ -0,0 +1,71 @@ +--- +title: "UserMembers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface UserMembers { + id: string | null; + email: string | null; + username: string | null; + phoneNumber: string | null; + picture: string | null; + enrolledFactors: Array<string> | null; + enrolledEmails: Array<EnrolledEmail> | null; + enrolledPhoneNumbers: Array<EnrolledPhoneNumber> | null; + enrolledDevices: Array<EnrolledDevice> | null; + organizations: Organizations[] | null; + userMetadata: { [key: string]: string } | null; + appMetadata: { [key: string]: string } | null; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="id" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="email" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="username" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="phoneNumber" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="picture" type={<span>string | null</span>}> +</ParamField> + +<ParamField path="enrolledFactors" type={<span>Array<string> | null</span>}> +</ParamField> + +<ParamField path="enrolledEmails" type={<span>Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail">EnrolledEmail</a>> | null</span>}> +</ParamField> + +<ParamField path="enrolledPhoneNumbers" type={<span>Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber">EnrolledPhoneNumber</a>> | null</span>}> +</ParamField> + +<ParamField path="enrolledDevices" type={<span>Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice">EnrolledDevice</a>> | null</span>}> +</ParamField> + +<ParamField path="organizations" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Organizations">Organizations[]</a> | null</span>}> +</ParamField> + +<ParamField path="userMetadata" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +<ParamField path="appMetadata" type="object"> + <Expandable title="properties"> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/models/user.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/user.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy.mdx new file mode 100644 index 000000000..a9374cc10 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy.mdx @@ -0,0 +1,44 @@ +--- +title: "UsernamePolicy" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface UsernamePolicy { + isActive?: boolean + maxLength: number; + minLength: number; + allowedFormats?: { + usernameInEmailFormat?: boolean; + usernameInPhoneFormat?: boolean; + }; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="isActive" type={<span>boolean</span>}> +</ParamField> + +<ParamField path="maxLength" type={<span>number</span>} required> +</ParamField> + +<ParamField path="minLength" type={<span>number</span>} required> +</ParamField> + +<ParamField path="allowedFormats" type="object"> + <Expandable title="properties"> + <ParamField path="usernameInEmailFormat" type={<span>boolean</span>}> + </ParamField> + <ParamField path="usernameInPhoneFormat" type={<span>boolean</span>}> + </ParamField> + </Expandable> +</ParamField> + +--- + +**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationError.mdx new file mode 100644 index 000000000..1e8b8e312 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationError.mdx @@ -0,0 +1,49 @@ +--- +title: "UsernameValidationError" +description: "Represents a single username validation error returned during validation. Each error has a machine-readable `code` and a human-readable `message`." +--- + +<RequestExample> + +```typescript Interface lines +export interface UsernameValidationError { + /** + * A unique identifier for the validation rule that failed. + * + * Example: `"username-too-short"`, `"username-invalid-characters"` + */ + code: string; + + /** + * A human-readable description of the error. + * + * Example: `"Username must be at least 3 characters long."` + */ + message: string; + + /** + * The field associated with the validation error, typically "username", "email", or "phone". + */ + field: string; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="code" type={<span>string</span>} required> + A unique identifier for the validation rule that failed. Example: `"username-too-short"`, `"username-invalid-characters"` +</ParamField> + +<ParamField path="message" type={<span>string</span>} required> + A human-readable description of the error. Example: `"Username must be at least 3 characters long."` +</ParamField> + +<ParamField path="field" type={<span>string</span>} required> + The field associated with the validation error, typically "username", "email", or "phone". +</ParamField> + +--- + +**File:** [interfaces/utils/validate-username.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/validate-username.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult.mdx new file mode 100644 index 000000000..40d2d2063 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult.mdx @@ -0,0 +1,39 @@ +--- +title: "UsernameValidationResult" +description: "The result of validating a username against one or more rules." +--- + +<RequestExample> + +```typescript Interface lines +export interface UsernameValidationResult { + /** + * Indicates whether the username passed all validation rules. + */ + isValid: boolean; + + /** + * An array of {@link UsernameValidationError} objects representing + * the individual rules that failed, if any. + * + * This array is empty if {@link UsernameValidationResult.isValid} is `true`. + */ + errors: UsernameValidationError[]; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="isValid" type={<span>boolean</span>} required> + Indicates whether the username passed all validation rules. +</ParamField> + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationError">UsernameValidationError[]</a></span>} required> + An array of objects representing the individual rules that failed, if any. This array is empty if is `true`. +</ParamField> + +--- + +**File:** [interfaces/utils/validate-username.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/validate-username.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifyPlatformAuthenticatorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifyPlatformAuthenticatorOptions.mdx new file mode 100644 index 000000000..c28c322fe --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifyPlatformAuthenticatorOptions.mdx @@ -0,0 +1,32 @@ +--- +title: "VerifyPlatformAuthenticatorOptions" +description: "@interface VerifyPlatformAuthenticatorOptions" +--- + +<RequestExample> + +```typescript Interface lines +export interface VerifyPlatformAuthenticatorOptions extends CustomOptions { + /** + * Optional. If true and `screen.showRememberDevice` is true, this indicates the user + * has chosen to remember this device, typically for 30 days, to bypass MFA on subsequent logins. + * @type {boolean} + */ + rememberDevice?: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="rememberDevice" type={<span>boolean</span>}> + Optional. If true and `screen.showRememberDevice` is true, this indicates the user has chosen to remember this device, typically for 30 days, to bypass MFA on subsequent logins. +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-platform-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifySecurityKeyOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifySecurityKeyOptions.mdx new file mode 100644 index 000000000..6a3d3bc03 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifySecurityKeyOptions.mdx @@ -0,0 +1,26 @@ +--- +title: "VerifySecurityKeyOptions" +description: "@interface VerifySecurityKeyOptions" +--- + +<RequestExample> + +```typescript Interface lines +export interface VerifySecurityKeyOptions extends CustomOptions { + rememberDevice?: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="rememberDevice" type={<span>boolean</span>}> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails.mdx new file mode 100644 index 000000000..00eaa5ec6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails.mdx @@ -0,0 +1,43 @@ +--- +title: "WebAuthnErrorDetails" +description: "Details of a WebAuthn browser error." +--- + +<RequestExample> + +```typescript Interface lines +export interface WebAuthnErrorDetails { + /** + * The name of the error (e.g., "NotAllowedError"). + */ + name: string; + /** + * The error message. + */ + message: string; + /** + * Any additional error properties. + */ + [key: string]: string | number | boolean | undefined; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="name" type={<span>string</span>} required> + The name of the error (e.g., "NotAllowedError"). +</ParamField> + +<ParamField path="message" type={<span>string</span>} required> + The error message. +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> + Any additional error properties. +</ParamField> + +--- + +**File:** [interfaces/common/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/common/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WithRememberOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WithRememberOptions.mdx new file mode 100644 index 000000000..c23f22190 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WithRememberOptions.mdx @@ -0,0 +1,26 @@ +--- +title: "WithRememberOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface WithRememberOptions extends CustomOptions { + rememberDevice?: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="rememberDevice" type={<span>boolean</span>}> +</ParamField> + +<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> +</ParamField> + +--- + +**File:** [interfaces/screens/mfa-push-challenge-push.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/navigation.json b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/navigation.json new file mode 100644 index 000000000..770842d2b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/navigation.json @@ -0,0 +1,581 @@ +{ + "group": "@auth0/auth0-acul-js", + "pages": [ + { + "group": "Classes", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BaseContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Client", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Organization", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Prompt", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Screen", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Tenant", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Transaction", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedData", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/User", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AcceptInvitation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblock", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockFailure", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Consent", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/CustomizedConsent", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationAllowed", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationDenied", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeConfirmation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailOTPChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailVerificationResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/InterstitialCaptcha", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Login", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginEmailVerification", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Logout", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutAborted", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutComplete", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaBeginEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaCountryCodes", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaDetectBrowserCapabilities", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailList", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEnrollResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushList", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushWelcome", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallengeNewCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsList", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnChangeKeyNickname", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnEnrollmentSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnNotAvailableError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationPicker", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationSelection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollmentLocal", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/RedeemTicket", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordEmail", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaRecoveryCodeChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Signup", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AculError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UserInputError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SDKUsageError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Auth0ServerError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/FormHandler" + ] + }, + { + "group": "Interfaces", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CurrentScreenOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FlattenedTheme", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingThemes", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Branding", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AllowCredential", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Passkey", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyLogin", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnroll", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordlessConnection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SocialConnection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Organizations", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnAcceptInvitation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AcceptInvitationMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockFailure", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockSuccessMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnConsent", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConsentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnCustomizedConsent", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomizedConsentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationAllowedMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationDeniedMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnDeviceCodeConfirmation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeConfirmationMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailIdentifierChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailOTPChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OtpCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailOTPChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailVerificationResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailVerificationResultMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCaptchaOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/InterstitialCaptchaMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEmailVerificationMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginIdMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessEmailCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitOTPOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessSmsOtpMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Login", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutAbortedMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutCompleteMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConfirmLogoutOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaBeginEnrollOptionsMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaCountryCodes", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectCountryCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaCountryCodesMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaDetectBrowserCapabilitiesMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailList", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaEmailOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailListMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEnrollResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollResultMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaLoginOptionsMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentQrMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickPhoneOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickAuthenticatorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WithRememberOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushChallengePushMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushEnrollmentQrMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaPushDeviceOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushListMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushWelcome", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeNewCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnChangeKeyNicknameMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnEnrollmentSuccessMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnNotAvailableErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifyPlatformAuthenticatorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitPasskeyCredentialOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifySecurityKeyOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportWebAuthnErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectOrganizationOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationPickerMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithOrganizationNameOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnOrganizationSelection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationSelectionMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocal", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AbortEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollmentLocal", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocalMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/RedeemTicketMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordEmail", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaEmailChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaOtpChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPhoneChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPushChallengePushMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaSmsChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaVoiceChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithPasskeyOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UseSecurityKeyOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupIdMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignup", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignup", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FormOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PostPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCredentialResponse", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CredentialResponse", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreateResponse", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConditionalMediationCapable", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult" + ] + }, + { + "group": "Types", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/Base64URLString", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/AuthenticatorTransport", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/WebAuthnType", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/MfaPollingOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/OnStatusChangeCallback", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/IdentifierType" + ] + }, + { + "group": "Functions", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreen", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreenOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getErrors", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/updatePayloadByIdentifier", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupLink", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBackLink", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginLink", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getResetPasswordLink", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getForgotPasswordLink", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getEditIdentifierLink", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPublicKey", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getShowRememberDevice", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getWebAuthnType", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getScopes", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isSignupEnabled", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isForgotPasswordEnabled", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeyEnabled", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isUsernameRequired", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getUsernamePolicy", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasswordPolicy", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getActiveIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getAllowedIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getRequiredIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getOptionalIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/hasFlexibleIdentifier", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/extractIdentifiersByStatus", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenColors", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenFonts", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenBorders", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenPageBackground", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenWidget", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isBrave", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthAvailable", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isJsAvailable", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthPlatformAvailable", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeySupported", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBrowserCapabilities", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/base64UrlToUint8Array", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/uint8ArrayToBase64Url", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/safeBase64Url", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/decodePublicKey", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isAuthenticatorAssertionResponse", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasskeyCredentials", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPasskeyCredentials", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/registerPasskeyAutofill", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPollingControl", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/internalPoll", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/startPolling", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/stopPolling", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isRunning", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/parseErrorMessage", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createResendControl", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validatePassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validateUsername" + ] + } + ] +} \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/AuthenticatorTransport.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/AuthenticatorTransport.mdx new file mode 100644 index 000000000..ecd21b6a8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/AuthenticatorTransport.mdx @@ -0,0 +1,14 @@ +--- +title: "AuthenticatorTransport" +description: "" +--- + +## Type Definition + +```typescript +type AuthenticatorTransport = 'usb' | 'nfc' | 'ble' | 'internal' | 'hybrid'; +``` + +--- + +**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/Base64URLString.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/Base64URLString.mdx new file mode 100644 index 000000000..18f813fcc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/Base64URLString.mdx @@ -0,0 +1,14 @@ +--- +title: "Base64URLString" +description: "" +--- + +## Type Definition + +```typescript +type Base64URLString = string; +``` + +--- + +**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/IdentifierType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/IdentifierType.mdx new file mode 100644 index 000000000..5bf35ef23 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/IdentifierType.mdx @@ -0,0 +1,14 @@ +--- +title: "IdentifierType" +description: "Represents the types of user identifiers that can be used during signup. - `'email'`: The user will provide an email address. - `'phone'`: The user will provide a phone number. - `'username'`: The user will choose a username. This type is typically used in identity selection or signup flows to define which identifiers are enabled and how they behave." +--- + +## Type Definition + +```typescript +type IdentifierType = 'email' | 'phone' | 'username'; +``` + +--- + +**File:** [interfaces/utils/signup-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/MfaPollingOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/MfaPollingOptions.mdx new file mode 100644 index 000000000..203a15c14 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/MfaPollingOptions.mdx @@ -0,0 +1,45 @@ +--- +title: "MfaPollingOptions" +description: "Configuration options for managing an MFA push-notification polling process. Supply these options when starting a polling session to control how often the challenge endpoint is queried and how success or failure is handled." +--- + +## Type Definition + +```typescript +type MfaPollingOptions = { + /** + * Optional interval, in **milliseconds**, between consecutive polling requests. + * + * - If omitted, the SDK’s internal default interval is used (typically 5000 ms). + * - Choose a value that balances responsiveness with rate-limit considerations. + * + * @defaultValue Implementation-specific (commonly 5000 ms) + */ + intervalMs?: number; + + /** + * Optional callback executed once the MFA push challenge is successfully + * approved and polling completes. + * + * - Called exactly **once**, after which polling stops automatically. + * - Useful for advancing the login flow (e.g., calling `continue()`). + */ + onCompleted?: () => void; + + /** + * Optional callback invoked if an error occurs while polling. + * + * Receives an {@link ULError} object containing: + * - `status` — the HTTP status code from the failed request + * - `responseText` — the raw response body, if available + * + * - Called once per error event; polling may retry depending on error type. + * - Use to surface error messages or trigger custom retry/abort logic. + */ + onError?: (error: ULError) => void; +}; +``` + +--- + +**File:** [interfaces/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/OnStatusChangeCallback.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/OnStatusChangeCallback.mdx new file mode 100644 index 000000000..57b68f24e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/OnStatusChangeCallback.mdx @@ -0,0 +1,14 @@ +--- +title: "OnStatusChangeCallback" +description: "Callback function for status changes during resend countdown." +--- + +## Type Definition + +```typescript +type OnStatusChangeCallback = (remainingSeconds: number, isDisabled: boolean) => void; +``` + +--- + +**File:** [interfaces/utils/resend-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/resend-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/WebAuthnType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/WebAuthnType.mdx new file mode 100644 index 000000000..13d1ca8a3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/WebAuthnType.mdx @@ -0,0 +1,14 @@ +--- +title: "WebAuthnType" +description: "@type description Specifies the type of WebAuthn authenticator involved in the error. - `webauthn-roaming`: Error related to a roaming authenticator (e.g., USB security key). - `webauthn-platform`: Error related to a platform authenticator (e.g., Touch ID, Windows Hello)." +--- + +## Type Definition + +```typescript +type WebAuthnType = 'webauthn-roaming' | 'webauthn-platform'; +``` + +--- + +**File:** [interfaces/screens/mfa-webauthn-error.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/README.md b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/README.md new file mode 100644 index 000000000..d8fced167 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/README.md @@ -0,0 +1,50 @@ +# Auth0 ACUL React Documentation + +Generated on 11/12/2025, 2:23:00 PM + +## Classes (2) + +- [ErrorStore](./classes/ErrorStore.mdx) +- [ContextHooks](./classes/ContextHooks.mdx) + +## Interfaces (12) + +- [ErrorsResult](./interfaces/ErrorsResult.mdx) +- [UseErrorOptions](./interfaces/UseErrorOptions.mdx) +- [UseErrorsResult](./interfaces/UseErrorsResult.mdx) +- [WithLoginIdentifiers](./interfaces/WithLoginIdentifiers.mdx) +- [MfaPollingResult](./interfaces/MfaPollingResult.mdx) +- [UseResendReturn](./interfaces/UseResendReturn.mdx) +- [UseResendOptions](./interfaces/UseResendOptions.mdx) +- [WithResendManager](./interfaces/WithResendManager.mdx) +- [WithSignupIdentifiers](./interfaces/WithSignupIdentifiers.mdx) +- [WithValidatePassword](./interfaces/WithValidatePassword.mdx) +- ... and 2 more + +## Functions (243) + +- [classifyKind](./functions/classifyKind.mdx) +- [toErrorObject](./functions/toErrorObject.mdx) +- [filterByField](./functions/filterByField.mdx) +- [withError](./functions/withError.mdx) +- [listsEqual](./functions/listsEqual.mdx) +- [registerScreen](./functions/registerScreen.mdx) +- [getScreen](./functions/getScreen.mdx) +- [clearScreen](./functions/clearScreen.mdx) +- [acceptInvitation](./functions/acceptInvitation.mdx) +- [useAcceptInvitation](./functions/useAcceptInvitation.mdx) +- ... and 233 more + +## Screens (76) + +- [accept-invitation](./screens/accept-invitation.mdx) +- [consent](./screens/consent.mdx) +- [customized-consent](./screens/customized-consent.mdx) +- [device-code-activation-allowed](./screens/device-code-activation-allowed.mdx) +- [device-code-activation-denied](./screens/device-code-activation-denied.mdx) +- [device-code-activation](./screens/device-code-activation.mdx) +- [device-code-confirmation](./screens/device-code-confirmation.mdx) +- [email-identifier-challenge](./screens/email-identifier-challenge.mdx) +- [email-otp-challenge](./screens/email-otp-challenge.mdx) +- [email-verification-result](./screens/email-verification-result.mdx) +- ... and 66 more diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ContextHooks.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ContextHooks.mdx new file mode 100644 index 000000000..acc179d11 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ContextHooks.mdx @@ -0,0 +1,46 @@ +--- +title: "ContextHooks" +description: "Factory class that creates context hooks for accessing Auth0 Universal Login data. These hooks provide access to various aspects of the authentication flow and tenant configuration." +--- + +## Properties + +<ParamField path="useUser" type={<span>any</span>} required> + Hook to access user information and profile data. +</ParamField> + +<ParamField path="useTenant" type={<span>any</span>} required> + Hook to access tenant configuration and settings. +</ParamField> + +<ParamField path="useBranding" type={<span>any</span>} required> + Hook to access branding and theme configuration. +</ParamField> + +<ParamField path="useClient" type={<span>any</span>} required> + Hook to access Auth0 application (client) configuration. +</ParamField> + +<ParamField path="useOrganization" type={<span>any</span>} required> + Hook to access organization context and settings. +</ParamField> + +<ParamField path="usePrompt" type={<span>any</span>} required> + Hook to access prompt configuration and flow settings. +</ParamField> + +<ParamField path="useUntrustedData" type={<span>any</span>} required> + Hook to access untrusted data from URL parameters and form submissions. +</ParamField> + +<ParamField path="useScreen" type={<span>any</span>} required> + Hook to access current screen information and metadata. +</ParamField> + +<ParamField path="useTransaction" type={<span>any</span>} required> + Hook to access transaction state and authentication flow data. +</ParamField> + +--- + +**File:** [src/hooks/context/index.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/context/index.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ErrorStore.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ErrorStore.mdx new file mode 100644 index 000000000..16bc2c94d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ErrorStore.mdx @@ -0,0 +1,95 @@ +--- +title: "ErrorStore" +description: "Global error store for ACUL (one screen per page). - Holds a single bucket of errors across the current page. - Generates stable ids for every inserted error. - Emits immutable snapshots to subscribers." +--- + +## Properties + +<ParamField path="bucket" type={<span>Bucket</span>} required> +</ParamField> + +<ParamField path="listeners" type={<span>Set<Listener></span>} required> +</ParamField> + +## Methods + +<ParamField path="subscribe" type={<span>() => void</span>}> + <Expandable title="parameters"> + <ParamField path="cb" type={<span>Listener</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="snapshot" type={<span>Readonly<Bucket></span>}> +</ParamField> + +<ParamField path="normalize" type={<span>ReadonlyArray<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>}> + Add ids and freeze an array of ErrorItem-like objects. + + <Expandable title="parameters"> + <ParamField path="list" type={<span>Array<Omit<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>, 'id'> & { id?: string }></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="replace" type={<span>void</span>}> + Replace an entire kind with a new list (generating ids if needed). + + <Expandable title="parameters"> + <ParamField path="kind" type={<span>ErrorKind</span>} required> + </ParamField> + <ParamField path="list" type={<span>Array<Omit<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>, 'id'> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="replacePartial" type={<span>void</span>}> + Replace only errors for a specific field within a kind. - Keeps all existing errors for other fields. - Normalizes incoming errors and replaces matching field ones. + + <Expandable title="parameters"> + <ParamField path="kind" type={<span>ErrorKind</span>} required> + </ParamField> + <ParamField path="list" type={<span>Array<Omit<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>, 'id'> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>} required> + </ParamField> + <ParamField path="field" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="push" type={<span>void</span>}> + Append one or more items to a kind. + + <Expandable title="parameters"> + <ParamField path="kind" type={<span>ErrorKind</span>} required> + </ParamField> + <ParamField path="list" type={<span>Omit<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>, 'id'> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a> | Array<Omit<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>, 'id'> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="clear" type={<span>void</span>}> + Clear one or more kinds (default: all kinds). + + <Expandable title="parameters"> + <ParamField path="kinds" type={<span>ErrorKind[]</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="remove" type={<span>void</span>}> + Remove errors that match a given id or predicate from specified kinds. + + <Expandable title="parameters"> + <ParamField path="kinds" type={<span>ErrorKind[]</span>} required> + </ParamField> + <ParamField path="test" type={<span>string | ((e: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>) => boolean)</span>} required> + </ParamField> + </Expandable> +</ParamField> + +<ParamField path="notify" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/state/error-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/error-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/abortPasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/abortPasskeyEnrollment.mdx new file mode 100644 index 000000000..04c51036b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/abortPasskeyEnrollment.mdx @@ -0,0 +1,18 @@ +--- +title: "abortPasskeyEnrollment" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/passkey-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/accept.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/accept.mdx new file mode 100644 index 000000000..1d12e8afe --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/accept.mdx @@ -0,0 +1,18 @@ +--- +title: "accept" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/customized-consent.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/customized-consent.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/acceptInvitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/acceptInvitation.mdx new file mode 100644 index 000000000..a0ad028b3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/acceptInvitation.mdx @@ -0,0 +1,18 @@ +--- +title: "acceptInvitation" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/accept-invitation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/accept-invitation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backAction.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backAction.mdx new file mode 100644 index 000000000..979802cde --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backAction.mdx @@ -0,0 +1,18 @@ +--- +title: "backAction" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-sms-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backToLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backToLogin.mdx new file mode 100644 index 000000000..1e7348bd8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backToLogin.mdx @@ -0,0 +1,18 @@ +--- +title: "backToLogin" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-request.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-request.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/cancel.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/cancel.mdx new file mode 100644 index 000000000..1520c6acc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/cancel.mdx @@ -0,0 +1,18 @@ +--- +title: "cancel" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/device-code-confirmation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/classifyKind.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/classifyKind.mdx new file mode 100644 index 000000000..8b12a8e94 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/classifyKind.mdx @@ -0,0 +1,18 @@ +--- +title: "classifyKind" +description: "" +--- + +## Parameters + +<ParamField path="e" type={<span>unknown</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>ErrorKind | null</span>}> +</ParamField> + +--- + +**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/clearScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/clearScreen.mdx new file mode 100644 index 000000000..1570e47e6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/clearScreen.mdx @@ -0,0 +1,15 @@ +--- +title: "clearScreen" +description: "Clear the current instance." +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/state/instance-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/instance-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirm.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirm.mdx new file mode 100644 index 000000000..1b4c98667 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirm.mdx @@ -0,0 +1,18 @@ +--- +title: "confirm" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/device-code-confirmation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirmLogout.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirmLogout.mdx new file mode 100644 index 000000000..9455b1e44 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirmLogout.mdx @@ -0,0 +1,18 @@ +--- +title: "confirmLogout" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>ConfirmLogoutOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/logout.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/logout.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueEnrollment.mdx new file mode 100644 index 000000000..03e34363f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueEnrollment.mdx @@ -0,0 +1,24 @@ +--- +title: "continueEnrollment" +description: "" +--- + +## Parameters + +<ParamField path="payload" type="object" required> + <Expandable title="properties"> + <ParamField path="phone" type={<span>string</span>} required> + </ParamField> + <ParamField path="captcha" type={<span>string</span>}> + </ParamField> + </Expandable> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-sms-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod.mdx new file mode 100644 index 000000000..b784bb8b0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod.mdx @@ -0,0 +1,18 @@ +--- +title: "continueMethod" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>ContinueOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMfaSmsChallenge.mdx new file mode 100644 index 000000000..a65c3902c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMfaSmsChallenge.mdx @@ -0,0 +1,18 @@ +--- +title: "continueMfaSmsChallenge" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>MfaSmsChallengeOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-sms-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePasskeyEnrollment.mdx new file mode 100644 index 000000000..3d79e895c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePasskeyEnrollment.mdx @@ -0,0 +1,18 @@ +--- +title: "continuePasskeyEnrollment" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/passkey-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePhoneEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePhoneEnrollment.mdx new file mode 100644 index 000000000..5cb45e88f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePhoneEnrollment.mdx @@ -0,0 +1,18 @@ +--- +title: "continuePhoneEnrollment" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>PhoneEnrollmentOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/phone-identifier-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithCode.mdx new file mode 100644 index 000000000..d49be72c5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithCode.mdx @@ -0,0 +1,18 @@ +--- +title: "continueWithCode" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>ContinueWithCodeOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/login-email-verification.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-email-verification.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithNewNickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithNewNickname.mdx new file mode 100644 index 000000000..4e906bb6d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithNewNickname.mdx @@ -0,0 +1,18 @@ +--- +title: "continueWithNewNickname" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>ContinueOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-change-key-nickname.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithOrganizationName.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithOrganizationName.mdx new file mode 100644 index 000000000..f4032c0e9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithOrganizationName.mdx @@ -0,0 +1,18 @@ +--- +title: "continueWithOrganizationName" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>ContinueWithOrganizationNameOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/organization-selection.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/organization-selection.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithPasskey.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithPasskey.mdx new file mode 100644 index 000000000..7744102f7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithPasskey.mdx @@ -0,0 +1,18 @@ +--- +title: "continueWithPasskey" +description: "" +--- + +## Parameters + +<ParamField path="options" type={<span>ContinueWithPasskeyOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-webauthn-platform-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/deny.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/deny.mdx new file mode 100644 index 000000000..4dfd1d4d2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/deny.mdx @@ -0,0 +1,18 @@ +--- +title: "deny" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/customized-consent.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/customized-consent.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/detectCapabilities.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/detectCapabilities.mdx new file mode 100644 index 000000000..25ebdba4b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/detectCapabilities.mdx @@ -0,0 +1,18 @@ +--- +title: "detectCapabilities" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-detect-browser-capabilities.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll.mdx new file mode 100644 index 000000000..eefd3194d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll.mdx @@ -0,0 +1,18 @@ +--- +title: "enroll" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-roaming-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enterCodeManually.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enterCodeManually.mdx new file mode 100644 index 000000000..2041f17b2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enterCodeManually.mdx @@ -0,0 +1,18 @@ +--- +title: "enterCodeManually" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-push-challenge-push.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin.mdx new file mode 100644 index 000000000..78126f05a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin.mdx @@ -0,0 +1,18 @@ +--- +title: "federatedLogin" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>FederatedLoginOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/login.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup.mdx new file mode 100644 index 000000000..46bab7926 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup.mdx @@ -0,0 +1,18 @@ +--- +title: "federatedSignup" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>FederatedSignupOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/signup.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/filterByField.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/filterByField.mdx new file mode 100644 index 000000000..a4e8bf3c5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/filterByField.mdx @@ -0,0 +1,21 @@ +--- +title: "filterByField" +description: "" +--- + +## Parameters + +<ParamField path="list" type={<span>ReadonlyArray<T></span>} required> +</ParamField> + +<ParamField path="field" type={<span>string</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>ReadonlyArray<T></span>}> +</ParamField> + +--- + +**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getACall.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getACall.mdx new file mode 100644 index 000000000..09c2e5d39 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getACall.mdx @@ -0,0 +1,18 @@ +--- +title: "getACall" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-sms-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getScreen.mdx new file mode 100644 index 000000000..dba6bab89 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getScreen.mdx @@ -0,0 +1,15 @@ +--- +title: "getScreen" +description: "Get the current screen instance (throws if not initialized)." +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>T</span>}> +</ParamField> + +--- + +**File:** [src/state/instance-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/instance-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack.mdx new file mode 100644 index 000000000..7847a8094 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack.mdx @@ -0,0 +1,18 @@ +--- +title: "goBack" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-push-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/listsEqual.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/listsEqual.mdx new file mode 100644 index 000000000..7b2a9b0cd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/listsEqual.mdx @@ -0,0 +1,21 @@ +--- +title: "listsEqual" +description: "Compare two error lists by id only for maximal speed." +--- + +## Parameters + +<ParamField path="a" type={<span>ReadonlyArray<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>} required> +</ParamField> + +<ParamField path="b" type={<span>ReadonlyArray<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/state/error-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/error-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login.mdx new file mode 100644 index 000000000..d223b3da0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login.mdx @@ -0,0 +1,18 @@ +--- +title: "login" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>LoginOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/login.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/noThanks.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/noThanks.mdx new file mode 100644 index 000000000..57b0709d5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/noThanks.mdx @@ -0,0 +1,18 @@ +--- +title: "noThanks" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/passkeyLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/passkeyLogin.mdx new file mode 100644 index 000000000..f388a4f19 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/passkeyLogin.mdx @@ -0,0 +1,18 @@ +--- +title: "passkeyLogin" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/login-id.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-id.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickAuthenticator.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickAuthenticator.mdx new file mode 100644 index 000000000..8f21c0f5d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickAuthenticator.mdx @@ -0,0 +1,18 @@ +--- +title: "pickAuthenticator" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-push-welcome.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode.mdx new file mode 100644 index 000000000..6e6176168 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode.mdx @@ -0,0 +1,18 @@ +--- +title: "pickCountryCode" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/signup.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickEmail.mdx new file mode 100644 index 000000000..38c9bbb21 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickEmail.mdx @@ -0,0 +1,18 @@ +--- +title: "pickEmail" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-email-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickPhone.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickPhone.mdx new file mode 100644 index 000000000..b55677a2c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickPhone.mdx @@ -0,0 +1,18 @@ +--- +title: "pickPhone" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickSms.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickSms.mdx new file mode 100644 index 000000000..827d5ebaf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickSms.mdx @@ -0,0 +1,18 @@ +--- +title: "pickSms" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-sms-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/refuseEnrollmentOnThisDevice.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/refuseEnrollmentOnThisDevice.mdx new file mode 100644 index 000000000..0ded85af7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/refuseEnrollmentOnThisDevice.mdx @@ -0,0 +1,18 @@ +--- +title: "refuseEnrollmentOnThisDevice" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-platform-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/registerScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/registerScreen.mdx new file mode 100644 index 000000000..2e9f133c8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/registerScreen.mdx @@ -0,0 +1,18 @@ +--- +title: "registerScreen" +description: "Register a screen class. If its identifier matches the current screen, instantiate it immediately and store as the singleton. Returns the instance if created, or null otherwise." +--- + +## Parameters + +<ParamField path="Constructor" type={<span>ScreenConstructor<T></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>T | null</span>}> +</ParamField> + +--- + +**File:** [src/state/instance-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/instance-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError.mdx new file mode 100644 index 000000000..4acb62e69 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError.mdx @@ -0,0 +1,18 @@ +--- +title: "reportBrowserError" +description: "" +--- + +## Parameters + +<ParamField path="options" type={<span>ReportBrowserErrorOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-webauthn-platform-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportWebAuthnError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportWebAuthnError.mdx new file mode 100644 index 000000000..b696b7eaf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportWebAuthnError.mdx @@ -0,0 +1,18 @@ +--- +title: "reportWebAuthnError" +description: "" +--- + +## Parameters + +<ParamField path="options" type={<span>ReportWebAuthnErrorOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode.mdx new file mode 100644 index 000000000..d8f74622b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode.mdx @@ -0,0 +1,18 @@ +--- +title: "resendCode" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendEmail.mdx new file mode 100644 index 000000000..50293253a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendEmail.mdx @@ -0,0 +1,18 @@ +--- +title: "resendEmail" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-email.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-email.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendOTP.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendOTP.mdx new file mode 100644 index 000000000..f78a6c90c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendOTP.mdx @@ -0,0 +1,18 @@ +--- +title: "resendOTP" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/login-passwordless-sms-otp.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendPushNotification.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendPushNotification.mdx new file mode 100644 index 000000000..4bd7555eb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendPushNotification.mdx @@ -0,0 +1,18 @@ +--- +title: "resendPushNotification" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-push-challenge-push.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resetPassword.mdx new file mode 100644 index 000000000..3688b2125 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resetPassword.mdx @@ -0,0 +1,18 @@ +--- +title: "resetPassword" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>ResetPasswordOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious.mdx new file mode 100644 index 000000000..f0292279a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious.mdx @@ -0,0 +1,18 @@ +--- +title: "returnToPrevious" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/phone-identifier-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectCountryCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectCountryCode.mdx new file mode 100644 index 000000000..5eb0ab928 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectCountryCode.mdx @@ -0,0 +1,18 @@ +--- +title: "selectCountryCode" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>SelectCountryCodeOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-country-codes.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaEmail.mdx new file mode 100644 index 000000000..84b6b10ff --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaEmail.mdx @@ -0,0 +1,18 @@ +--- +title: "selectMfaEmail" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>SelectMfaEmailOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-email-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-email-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaPushDevice.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaPushDevice.mdx new file mode 100644 index 000000000..d445cdb0e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaPushDevice.mdx @@ -0,0 +1,18 @@ +--- +title: "selectMfaPushDevice" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>SelectMfaPushDeviceOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-push-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectOrganization.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectOrganization.mdx new file mode 100644 index 000000000..a9fa90ced --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectOrganization.mdx @@ -0,0 +1,24 @@ +--- +title: "selectOrganization" +description: "" +--- + +## Parameters + +<ParamField path="payload" type="object" required> + <Expandable title="properties"> + <ParamField path="organization" type={<span>string</span>} required> + </ParamField> + <ParamField path="state" type={<span>string</span>} required> + </ParamField> + </Expandable> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/organization-picker.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/organization-picker.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneCountryCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneCountryCode.mdx new file mode 100644 index 000000000..43e36901f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneCountryCode.mdx @@ -0,0 +1,18 @@ +--- +title: "selectPhoneCountryCode" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-voice-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneNumber.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneNumber.mdx new file mode 100644 index 000000000..c6ecb6846 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneNumber.mdx @@ -0,0 +1,18 @@ +--- +title: "selectPhoneNumber" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>MfaSmsListOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-sms-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/showError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/showError.mdx new file mode 100644 index 000000000..36f64301b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/showError.mdx @@ -0,0 +1,18 @@ +--- +title: "showError" +description: "" +--- + +## Parameters + +<ParamField path="options" type={<span>ShowErrorOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup.mdx new file mode 100644 index 000000000..04edf2c80 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup.mdx @@ -0,0 +1,18 @@ +--- +title: "signup" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>SignupOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/signup.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/skipOrganizationSelection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/skipOrganizationSelection.mdx new file mode 100644 index 000000000..2573e6634 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/skipOrganizationSelection.mdx @@ -0,0 +1,18 @@ +--- +title: "skipOrganizationSelection" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/organization-picker.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/organization-picker.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/snoozeEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/snoozeEnrollment.mdx new file mode 100644 index 000000000..d14ce986b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/snoozeEnrollment.mdx @@ -0,0 +1,18 @@ +--- +title: "snoozeEnrollment" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-platform-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitCode.mdx new file mode 100644 index 000000000..bb5b5c33d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitCode.mdx @@ -0,0 +1,18 @@ +--- +title: "submitCode" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>SubmitCodeOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/login-passwordless-email-code.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitEmailChallenge.mdx new file mode 100644 index 000000000..4e1b0cdc8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitEmailChallenge.mdx @@ -0,0 +1,18 @@ +--- +title: "submitEmailChallenge" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>EmailChallengeOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/email-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitOTP.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitOTP.mdx new file mode 100644 index 000000000..d9a1eb3d0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitOTP.mdx @@ -0,0 +1,18 @@ +--- +title: "submitOTP" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>SubmitOTPOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/login-passwordless-sms-otp.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPasskeyCredential.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPasskeyCredential.mdx new file mode 100644 index 000000000..d0f79fff2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPasskeyCredential.mdx @@ -0,0 +1,18 @@ +--- +title: "submitPasskeyCredential" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>SubmitPasskeyCredentialOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-platform-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPhoneChallenge.mdx new file mode 100644 index 000000000..2dc682839 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPhoneChallenge.mdx @@ -0,0 +1,18 @@ +--- +title: "submitPhoneChallenge" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>PhoneChallengeOptions</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/phone-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToSms.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToSms.mdx new file mode 100644 index 000000000..cd2d866ba --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToSms.mdx @@ -0,0 +1,18 @@ +--- +title: "switchToSms" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToText.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToText.mdx new file mode 100644 index 000000000..f23de4812 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToText.mdx @@ -0,0 +1,18 @@ +--- +title: "switchToText" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/phone-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToVoice.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToVoice.mdx new file mode 100644 index 000000000..04d01dfcc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToVoice.mdx @@ -0,0 +1,18 @@ +--- +title: "switchToVoice" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/phone-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toErrorObject.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toErrorObject.mdx new file mode 100644 index 000000000..c52b70a2e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toErrorObject.mdx @@ -0,0 +1,18 @@ +--- +title: "toErrorObject" +description: "" +--- + +## Parameters + +<ParamField path="e" type={<span>unknown</span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>Omit<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>, 'id'></span>}> +</ParamField> + +--- + +**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toggleView.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toggleView.mdx new file mode 100644 index 000000000..1b3590552 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toggleView.mdx @@ -0,0 +1,18 @@ +--- +title: "toggleView" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-otp-enrollment-qr.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAgain.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAgain.mdx new file mode 100644 index 000000000..0f85bc240 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAgain.mdx @@ -0,0 +1,18 @@ +--- +title: "tryAgain" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod.mdx new file mode 100644 index 000000000..1cdaef2a2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod.mdx @@ -0,0 +1,18 @@ +--- +title: "tryAnotherMethod" +description: "" +--- + +## Parameters + +<ParamField path="options" type={<span>TryAnotherMethodOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAcceptInvitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAcceptInvitation.mdx new file mode 100644 index 000000000..bdda39ec4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAcceptInvitation.mdx @@ -0,0 +1,15 @@ +--- +title: "useAcceptInvitation" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>AcceptInvitationMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/accept-invitation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/accept-invitation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAuth0Themes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAuth0Themes.mdx new file mode 100644 index 000000000..9d3ca6836 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAuth0Themes.mdx @@ -0,0 +1,15 @@ +--- +title: "useAuth0Themes" +description: "React hook to get the current theme options with flattened configuration from branding context." +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>FlattenedTheme | null</span>}> +</ParamField> + +--- + +**File:** [src/hooks/common/auth0-themes.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/auth0-themes.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useConsent.mdx new file mode 100644 index 000000000..84dab8e01 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useConsent.mdx @@ -0,0 +1,15 @@ +--- +title: "useConsent" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>ConsentMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/consent.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/consent.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCurrentScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCurrentScreen.mdx new file mode 100644 index 000000000..ec86f1611 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCurrentScreen.mdx @@ -0,0 +1,15 @@ +--- +title: "useCurrentScreen" +description: "React hook that gets the current screen context and state. This hook provides access to client configuration, organization details, screen identification, tenant settings, transaction state, and authorization parameters for building custom authentication UI. ## Return Value Returns `CurrentScreenOptions` object with the following properties, or `null` if unavailable: - **`client`** - Application identifier and metadata - **`organization`** - Organization ID and metadata (for Auth0 Organizations) - **`prompt`** - Current prompt name (e.g., \"login\", \"consent\", \"mfa\") - **`screen`** - Current screen name (e.g., \"login-id\", \"login-password\", \"mfa-otp-challenge\") - **`tenant`** - Tenant configuration including enabled locales - **`transaction`** - Transaction state, errors array, and current locale - **`untrustedData`** - Authorization parameters from the client (validate before use) ## Key Points - Use `screen.name` for conditional rendering of authentication screens - Always use optional chaining (`?.`) as nested properties can be `null` - Check `transaction.errors` for displaying validation errors - Access `organization.metadata` for organization-specific branding" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>CurrentScreenOptions | null</span>}> +</ParamField> + +--- + +**File:** [src/hooks/common/current-screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/current-screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCustomizedConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCustomizedConsent.mdx new file mode 100644 index 000000000..15d4f0dd5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCustomizedConsent.mdx @@ -0,0 +1,15 @@ +--- +title: "useCustomizedConsent" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>CustomizedConsentMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/customized-consent.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/customized-consent.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivation.mdx new file mode 100644 index 000000000..0ba37a876 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivation.mdx @@ -0,0 +1,15 @@ +--- +title: "useDeviceCodeActivation" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>DeviceCodeActivationMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/device-code-activation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-activation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationAllowed.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationAllowed.mdx new file mode 100644 index 000000000..b29f0d7c9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationAllowed.mdx @@ -0,0 +1,15 @@ +--- +title: "useDeviceCodeActivationAllowed" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>DeviceCodeActivationAllowedMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/device-code-activation-allowed.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationDenied.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationDenied.mdx new file mode 100644 index 000000000..9af80795c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationDenied.mdx @@ -0,0 +1,15 @@ +--- +title: "useDeviceCodeActivationDenied" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>DeviceCodeActivationDeniedMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/device-code-activation-denied.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeConfirmation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeConfirmation.mdx new file mode 100644 index 000000000..0e72f5016 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeConfirmation.mdx @@ -0,0 +1,15 @@ +--- +title: "useDeviceCodeConfirmation" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>DeviceCodeConfirmationMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/device-code-confirmation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailIdentifierChallenge.mdx new file mode 100644 index 000000000..df729a06b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailIdentifierChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useEmailIdentifierChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>EmailIdentifierChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/email-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailOTPChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailOTPChallenge.mdx new file mode 100644 index 000000000..7a42e2c23 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailOTPChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useEmailOTPChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>EmailOTPChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/email-otp-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailVerificationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailVerificationResult.mdx new file mode 100644 index 000000000..9f60af9d6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailVerificationResult.mdx @@ -0,0 +1,15 @@ +--- +title: "useEmailVerificationResult" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>EmailVerificationResultMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/email-verification-result.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/email-verification-result.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useErrors.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useErrors.mdx new file mode 100644 index 000000000..b34ddc4ca --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useErrors.mdx @@ -0,0 +1,18 @@ +--- +title: "useErrors" +description: "React hook for reading and managing errors in ACUL (Advanced Customization of Universal Login). With all validation and server-side errors. It groups errors into three kinds: - `server` — errors returned by Auth0 or your own backend. - `client` — errors from client-side validation (e.g., invalid form input). - `developer` — errors caused by incorrect integration or SDK misuse." +--- + +## Parameters + +<ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorOptions">UseErrorOptions</a></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorsResult">UseErrorsResult</a></span>}> +</ParamField> + +--- + +**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useInterstitialCaptcha.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useInterstitialCaptcha.mdx new file mode 100644 index 000000000..a7cb99217 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useInterstitialCaptcha.mdx @@ -0,0 +1,15 @@ +--- +title: "useInterstitialCaptcha" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>InterstitialCaptchaMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/interstitial-captcha.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogin.mdx new file mode 100644 index 000000000..cbda1f214 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogin.mdx @@ -0,0 +1,15 @@ +--- +title: "useLogin" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>LoginMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/login.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginEmailVerification.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginEmailVerification.mdx new file mode 100644 index 000000000..5a3eaf823 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginEmailVerification.mdx @@ -0,0 +1,15 @@ +--- +title: "useLoginEmailVerification" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>LoginEmailVerificationMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/login-email-verification.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-email-verification.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginId.mdx new file mode 100644 index 000000000..69677d85c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginId.mdx @@ -0,0 +1,15 @@ +--- +title: "useLoginId" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>LoginIdMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/login-id.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-id.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginIdentifiers.mdx new file mode 100644 index 000000000..e4b148da9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginIdentifiers.mdx @@ -0,0 +1,15 @@ +--- +title: "useLoginIdentifiers" +description: "Returns a list of active identifier types (such as `'email'`, `'phone'`, or `'username'`) currently in use in the authentication flow or login process." +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>IdentifierType[]</span>}> +</ParamField> + +--- + +**File:** [src/hooks/utility/login-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/login-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPassword.mdx new file mode 100644 index 000000000..596d57222 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPassword.mdx @@ -0,0 +1,15 @@ +--- +title: "useLoginPassword" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>LoginPasswordMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/login-password.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-password.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessEmailCode.mdx new file mode 100644 index 000000000..439e3e16e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessEmailCode.mdx @@ -0,0 +1,15 @@ +--- +title: "useLoginPasswordlessEmailCode" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>LoginPasswordlessEmailCodeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/login-passwordless-email-code.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessSmsOtp.mdx new file mode 100644 index 000000000..1767723fe --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessSmsOtp.mdx @@ -0,0 +1,15 @@ +--- +title: "useLoginPasswordlessSmsOtp" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>LoginPasswordlessSmsOtpMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/login-passwordless-sms-otp.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogout.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogout.mdx new file mode 100644 index 000000000..34581fd40 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogout.mdx @@ -0,0 +1,15 @@ +--- +title: "useLogout" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>LogoutMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/logout.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/logout.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutAborted.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutAborted.mdx new file mode 100644 index 000000000..4c84ded48 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutAborted.mdx @@ -0,0 +1,15 @@ +--- +title: "useLogoutAborted" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>LogoutAbortedMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/logout-aborted.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/logout-aborted.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutComplete.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutComplete.mdx new file mode 100644 index 000000000..79a58ba87 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutComplete.mdx @@ -0,0 +1,15 @@ +--- +title: "useLogoutComplete" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>LogoutCompleteMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/logout-complete.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/logout-complete.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaBeginEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaBeginEnrollOptions.mdx new file mode 100644 index 000000000..bb1da7a7d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaBeginEnrollOptions.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaBeginEnrollOptions" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaBeginEnrollOptionsMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-begin-enroll-options.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaCountryCodes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaCountryCodes.mdx new file mode 100644 index 000000000..6ad6b794e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaCountryCodes.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaCountryCodes" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaCountryCodesMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-country-codes.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaDetectBrowserCapabilities.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaDetectBrowserCapabilities.mdx new file mode 100644 index 000000000..5ffe3f2ca --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaDetectBrowserCapabilities.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaDetectBrowserCapabilities" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaDetectBrowserCapabilitiesMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-detect-browser-capabilities.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailChallenge.mdx new file mode 100644 index 000000000..69a081403 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaEmailChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaEmailChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-email-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailList.mdx new file mode 100644 index 000000000..7b5bd8e5b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailList.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaEmailList" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaEmailListMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-email-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-email-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEnrollResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEnrollResult.mdx new file mode 100644 index 000000000..fcf70895d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEnrollResult.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaEnrollResult" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaEnrollResultMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-enroll-result.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaLoginOptions.mdx new file mode 100644 index 000000000..08dd6f640 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaLoginOptions.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaLoginOptions" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaLoginOptionsMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-login-options.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-login-options.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpChallenge.mdx new file mode 100644 index 000000000..b56d61ae0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaOtpChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaOtpChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-otp-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentCode.mdx new file mode 100644 index 000000000..897b80500 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentCode.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaOtpEnrollmentCode" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaOtpEnrollmentCodeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-otp-enrollment-code.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentQr.mdx new file mode 100644 index 000000000..9986d454f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentQr.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaOtpEnrollmentQr" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaOtpEnrollmentQrMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-otp-enrollment-qr.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneChallenge.mdx new file mode 100644 index 000000000..98075a8fe --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaPhoneChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaPhoneChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-phone-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneEnrollment.mdx new file mode 100644 index 000000000..0c5957453 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneEnrollment.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaPhoneEnrollment" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaPhoneEnrollmentMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-phone-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPolling.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPolling.mdx new file mode 100644 index 000000000..3e0696c9f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPolling.mdx @@ -0,0 +1,18 @@ +--- +title: "useMfaPolling" +description: "- The `onError` callback receives an object with `status` and `responseText` describing the server response. - Internal rate-limit responses (`429`) are automatically handled: polling waits for the reset window before retrying. - Calling `startPolling()` repeatedly while running is safe and idempotent." +--- + +## Parameters + +<ParamField path="options" type={<span>MfaPollingOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/MfaPollingResult">MfaPollingResult</a></span>}> +</ParamField> + +--- + +**File:** [src/hooks/utility/polling-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushChallengePush.mdx new file mode 100644 index 000000000..4981352ab --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushChallengePush.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaPushChallengePush" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaPushChallengePushMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-push-challenge-push.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushEnrollmentQr.mdx new file mode 100644 index 000000000..86beee5cb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushEnrollmentQr.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaPushEnrollmentQr" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaPushEnrollmentQrMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-push-enrollment-qr.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushList.mdx new file mode 100644 index 000000000..a4e4c3d81 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushList.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaPushList" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaPushListMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-push-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushWelcome.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushWelcome.mdx new file mode 100644 index 000000000..9175ea4f4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushWelcome.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaPushWelcome" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaPushWelcomeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-push-welcome.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallenge.mdx new file mode 100644 index 000000000..b9cab015e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaRecoveryCodeChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaRecoveryCodeChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-recovery-code-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallengeNewCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallengeNewCode.mdx new file mode 100644 index 000000000..60737f7f4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallengeNewCode.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaRecoveryCodeChallengeNewCode" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaRecoveryCodeChallengeNewCodeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-recovery-code-challenge-new-code.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeEnrollment.mdx new file mode 100644 index 000000000..efc9edc1f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeEnrollment.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaRecoveryCodeEnrollment" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaRecoveryCodeEnrollmentMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-recovery-code-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsChallenge.mdx new file mode 100644 index 000000000..798505571 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaSmsChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaSmsChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-sms-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsEnrollment.mdx new file mode 100644 index 000000000..63c30961b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsEnrollment.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaSmsEnrollment" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaSmsEnrollmentMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-sms-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsList.mdx new file mode 100644 index 000000000..10bfb3ebf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsList.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaSmsList" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaSmsListMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-sms-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceChallenge.mdx new file mode 100644 index 000000000..a29993189 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaVoiceChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaVoiceChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceEnrollment.mdx new file mode 100644 index 000000000..df49ef27a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceEnrollment.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaVoiceEnrollment" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaVoiceEnrollmentMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-voice-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnChangeKeyNickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnChangeKeyNickname.mdx new file mode 100644 index 000000000..8809731fa --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnChangeKeyNickname.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaWebAuthnChangeKeyNickname" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaWebAuthnChangeKeyNicknameMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-change-key-nickname.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnEnrollmentSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnEnrollmentSuccess.mdx new file mode 100644 index 000000000..b75f668a3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnEnrollmentSuccess.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaWebAuthnEnrollmentSuccess" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaWebAuthnEnrollmentSuccessMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-enrollment-success.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnError.mdx new file mode 100644 index 000000000..e8aeb2b6d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnError.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaWebAuthnError" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaWebAuthnErrorMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnNotAvailableError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnNotAvailableError.mdx new file mode 100644 index 000000000..b607139ae --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnNotAvailableError.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaWebAuthnNotAvailableError" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaWebAuthnNotAvailableErrorMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-not-available-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformChallenge.mdx new file mode 100644 index 000000000..21f303f12 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaWebAuthnPlatformChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaWebAuthnPlatformChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-platform-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformEnrollment.mdx new file mode 100644 index 000000000..69810e44d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformEnrollment.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaWebAuthnPlatformEnrollment" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaWebAuthnPlatformEnrollmentMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-platform-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingChallenge.mdx new file mode 100644 index 000000000..96dc8966e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaWebAuthnRoamingChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaWebAuthnRoamingChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingEnrollment.mdx new file mode 100644 index 000000000..d0c183003 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingEnrollment.mdx @@ -0,0 +1,15 @@ +--- +title: "useMfaWebAuthnRoamingEnrollment" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>MfaWebAuthnRoamingEnrollmentMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-roaming-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationPicker.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationPicker.mdx new file mode 100644 index 000000000..3160d768e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationPicker.mdx @@ -0,0 +1,15 @@ +--- +title: "useOrganizationPicker" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>OrganizationPickerMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/organization-picker.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/organization-picker.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationSelection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationSelection.mdx new file mode 100644 index 000000000..69f762d1d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationSelection.mdx @@ -0,0 +1,15 @@ +--- +title: "useOrganizationSelection" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>OrganizationSelectionMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/organization-selection.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/organization-selection.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollment.mdx new file mode 100644 index 000000000..94374ec81 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollment.mdx @@ -0,0 +1,15 @@ +--- +title: "usePasskeyEnrollment" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>PasskeyEnrollmentMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/passkey-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollmentLocal.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollmentLocal.mdx new file mode 100644 index 000000000..3e0761934 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollmentLocal.mdx @@ -0,0 +1,15 @@ +--- +title: "usePasskeyEnrollmentLocal" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>PasskeyEnrollmentLocalMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/passkey-enrollment-local.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePassword.mdx new file mode 100644 index 000000000..575ad9aeb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePassword.mdx @@ -0,0 +1,18 @@ +--- +title: "usePassword" +description: "" +--- + +## Parameters + +<ParamField path="payload" type={<span>CustomOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasswordValidation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasswordValidation.mdx new file mode 100644 index 000000000..7206f3520 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasswordValidation.mdx @@ -0,0 +1,25 @@ +--- +title: "usePasswordValidation" +description: "This React hook validates a password against the current Auth0 password policy and returns a structured result describing whether the password satisfies each rule. Optionally, it can send the validation results to the global error manager so that form error components can update automatically." +--- + +## Parameters + +<ParamField path="password" type={<span>string</span>} required> +</ParamField> + +<ParamField path="options" type="object"> + <Expandable title="properties"> + <ParamField path="includeInErrors" type={<span>boolean</span>}> + </ParamField> + </Expandable> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>PasswordValidationResult</span>}> +</ParamField> + +--- + +**File:** [src/hooks/utility/validate-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/validate-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierChallenge.mdx new file mode 100644 index 000000000..3b4e9eded --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "usePhoneIdentifierChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>PhoneIdentifierChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/phone-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierEnrollment.mdx new file mode 100644 index 000000000..1baab3d08 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierEnrollment.mdx @@ -0,0 +1,15 @@ +--- +title: "usePhoneIdentifierEnrollment" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>PhoneIdentifierEnrollmentMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/phone-identifier-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useRedeemTicket.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useRedeemTicket.mdx new file mode 100644 index 000000000..612a6de64 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useRedeemTicket.mdx @@ -0,0 +1,15 @@ +--- +title: "useRedeemTicket" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>RedeemTicketMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/redeem-ticket.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/redeem-ticket.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResend.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResend.mdx new file mode 100644 index 000000000..a039275b5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResend.mdx @@ -0,0 +1,18 @@ +--- +title: "useResend" +description: "This React hook manages \"resend\" actions (e.g., resending a verification code) on ACUL screens. This hook: - Tracks the remaining cooldown time. - Tells you whether the resend button should be disabled. - Provides a `startResend` function to trigger a resend immediately." +--- + +## Parameters + +<ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendOptions">UseResendOptions</a></span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendReturn">UseResendReturn</a></span>}> +</ParamField> + +--- + +**File:** [src/hooks/utility/resend-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPassword.mdx new file mode 100644 index 000000000..b1c600ada --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPassword.mdx @@ -0,0 +1,15 @@ +--- +title: "useResetPassword" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>ResetPasswordMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordEmail.mdx new file mode 100644 index 000000000..8b09f673b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordEmail.mdx @@ -0,0 +1,15 @@ +--- +title: "useResetPasswordEmail" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>ResetPasswordEmailMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-email.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-email.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordError.mdx new file mode 100644 index 000000000..15cf9ad41 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordError.mdx @@ -0,0 +1,15 @@ +--- +title: "useResetPasswordError" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>ResetPasswordErrorMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaEmailChallenge.mdx new file mode 100644 index 000000000..0d22d403d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaEmailChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useResetPasswordMfaEmailChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>ResetPasswordMfaEmailChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-email-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaOtpChallenge.mdx new file mode 100644 index 000000000..09e3d54a0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaOtpChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useResetPasswordMfaOtpChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>ResetPasswordMfaOtpChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-otp-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPhoneChallenge.mdx new file mode 100644 index 000000000..c4b8e125e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPhoneChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useResetPasswordMfaPhoneChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>ResetPasswordMfaPhoneChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-phone-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPushChallengePush.mdx new file mode 100644 index 000000000..ccf5c1336 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPushChallengePush.mdx @@ -0,0 +1,15 @@ +--- +title: "useResetPasswordMfaPushChallengePush" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>ResetPasswordMfaPushChallengePushMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-push-challenge-push.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaRecoveryCodeChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaRecoveryCodeChallenge.mdx new file mode 100644 index 000000000..312b84976 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaRecoveryCodeChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useResetPasswordMfaRecoveryCodeChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>ResetPasswordMfaRecoveryCodeChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-recovery-code-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaSmsChallenge.mdx new file mode 100644 index 000000000..5bf137d6a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaSmsChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useResetPasswordMfaSmsChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>ResetPasswordMfaSmsChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-sms-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaVoiceChallenge.mdx new file mode 100644 index 000000000..59d98bd7c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaVoiceChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useResetPasswordMfaVoiceChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>ResetPasswordMfaVoiceChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnPlatformChallenge.mdx new file mode 100644 index 000000000..f7ec8e9c5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useResetPasswordMfaWebAuthnPlatformChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>ResetPasswordMfaWebAuthnPlatformChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-webauthn-platform-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnRoamingChallenge.mdx new file mode 100644 index 000000000..f98809fda --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,15 @@ +--- +title: "useResetPasswordMfaWebAuthnRoamingChallenge" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>ResetPasswordMfaWebAuthnRoamingChallengeMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordRequest.mdx new file mode 100644 index 000000000..8a053cdd3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordRequest.mdx @@ -0,0 +1,15 @@ +--- +title: "useResetPasswordRequest" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>ResetPasswordRequestMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-request.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-request.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordSuccess.mdx new file mode 100644 index 000000000..334f2c744 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordSuccess.mdx @@ -0,0 +1,15 @@ +--- +title: "useResetPasswordSuccess" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>ResetPasswordSuccessMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-success.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-success.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSecurityKey.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSecurityKey.mdx new file mode 100644 index 000000000..0f2d7a8c6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSecurityKey.mdx @@ -0,0 +1,18 @@ +--- +title: "useSecurityKey" +description: "" +--- + +## Parameters + +<ParamField path="options" type={<span>UseSecurityKeyOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignup.mdx new file mode 100644 index 000000000..80b133046 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignup.mdx @@ -0,0 +1,15 @@ +--- +title: "useSignup" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>SignupMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/signup.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupId.mdx new file mode 100644 index 000000000..6053d72e3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupId.mdx @@ -0,0 +1,15 @@ +--- +title: "useSignupId" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>SignupIdMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/signup-id.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup-id.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupIdentifiers.mdx new file mode 100644 index 000000000..54cfbb81f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupIdentifiers.mdx @@ -0,0 +1,15 @@ +--- +title: "useSignupIdentifiers" +description: "Returns a list of enabled identifiers (email, phone, or username), each with its `required` status, based on the current screen's signup identifiers." +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>Identifier[] | []</span>}> +</ParamField> + +--- + +**File:** [src/hooks/utility/signup-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/signup-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupPassword.mdx new file mode 100644 index 000000000..22f6a8183 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupPassword.mdx @@ -0,0 +1,15 @@ +--- +title: "useSignupPassword" +description: "" +--- + +## Parameters + +## Returns + +<ParamField path="response" type={<span>SignupPasswordMembers</span>}> +</ParamField> + +--- + +**File:** [src/screens/signup-password.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup-password.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useUsernameValidation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useUsernameValidation.mdx new file mode 100644 index 000000000..72bde79ac --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useUsernameValidation.mdx @@ -0,0 +1,25 @@ +--- +title: "useUsernameValidation" +description: "React hook for validating a username against the current Auth0 username policy. This hook checks the provided username against all configured validation rules and returns a structured result describing whether it passes. Optionally, it can send validation errors to the global error manager so that UI components observing the `username` field can automatically display or react to these errors." +--- + +## Parameters + +<ParamField path="username" type={<span>string</span>} required> +</ParamField> + +<ParamField path="options" type="object"> + <Expandable title="properties"> + <ParamField path="includeInErrors" type={<span>boolean</span>}> + </ParamField> + </Expandable> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>UsernameValidationResult</span>}> +</ParamField> + +--- + +**File:** [src/hooks/utility/validate-username.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/validate-username.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/verify.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/verify.mdx new file mode 100644 index 000000000..82369522f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/verify.mdx @@ -0,0 +1,18 @@ +--- +title: "verify" +description: "" +--- + +## Parameters + +<ParamField path="options" type={<span>VerifySecurityKeyOptions</span>}> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>void</span>}> +</ParamField> + +--- + +**File:** [src/screens/mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/withError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/withError.mdx new file mode 100644 index 000000000..e9b5b7c7a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/withError.mdx @@ -0,0 +1,18 @@ +--- +title: "withError" +description: "" +--- + +## Parameters + +<ParamField path="actionOrPromise" type={<span>(() => T | Promise<T>) | Promise<T></span>} required> +</ParamField> + +## Returns + +<ParamField path="response" type={<span>T | Promise<T></span>}> +</ParamField> + +--- + +**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useAuth0Themes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useAuth0Themes.mdx new file mode 100644 index 000000000..96dd0a327 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useAuth0Themes.mdx @@ -0,0 +1,55 @@ +--- +title: "useAuth0Themes" +--- + +React hook to get the current theme options with flattened configuration from branding context. + +## Returns + +FlattenedTheme object containing colors, fonts, borders, pageBackground, and widget configurations, or null if no branding is available + +## Example + +```tsx +import React from 'react'; +import { useAuth0Themes } from '@auth0/auth0-acul-react'; + +const ThemedComponent: React.FC = () => { + const theme = useAuth0Themes(); + + if (!theme) { + return <div>No theme available</div>; + } + + return ( + <div + style={{ + backgroundColor: theme.colors.primary_button, + color: theme.colors.primary_button_label, + borderRadius: theme.borders.button_border_radius, + }} + > + <h1 + style={{ + fontWeight: theme.fonts.title.bold ? 'bold' : 'normal', + fontSize: `${theme.fonts.title.size}%`, + }} + > + Styled with Auth0 Theme + </h1> + <button + style={{ + backgroundColor: theme.colors.primary_button, + borderRadius: theme.borders.button_border_radius, + }} + > + Primary Button + </button> + <p>Body text color: {theme.colors.body_text}</p> + </div> + ); +}; + +--- + +**File:** [src/hooks/common/auth0-themes.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/auth0-themes.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useCurrentScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useCurrentScreen.mdx new file mode 100644 index 000000000..b6ba0e2dd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useCurrentScreen.mdx @@ -0,0 +1,82 @@ +--- +title: "useCurrentScreen" +--- + +React hook that gets the current screen context and state. + +This hook provides access to client configuration, organization details, screen identification, +tenant settings, transaction state, and authorization parameters for building custom authentication UI. + +## Return Value + +Returns `CurrentScreenOptions` object with the following properties, or `null` if unavailable: + +- **`client`** - Application identifier and metadata +- **`organization`** - Organization ID and metadata (for Auth0 Organizations) +- **`prompt`** - Current prompt name (e.g., "login", "consent", "mfa") +- **`screen`** - Current screen name (e.g., "login-id", "login-password", "mfa-otp-challenge") +- **`tenant`** - Tenant configuration including enabled locales +- **`transaction`** - Transaction state, errors array, and current locale +- **`untrustedData`** - Authorization parameters from the client (validate before use) + +## Key Points + +- Use `screen.name` for conditional rendering of authentication screens +- Always use optional chaining (`?.`) as nested properties can be `null` +- Check `transaction.errors` for displaying validation errors +- Access `organization.metadata` for organization-specific branding + +## Returns + +{CurrentScreenOptions | null} Current screen context data, or `null` if not available + +## Example + +Basic screen routing +```tsx +import { useCurrentScreen } from '@auth0/auth0-acul-react'; + +const AuthFlow = () => { + const screenOptions = useCurrentScreen(); + const screen = screenOptions?.screen?.name || "login-id"; + + switch (screen) { + case "login-id": + return <LoginIdScreen />; + case "login-password": + return <LoginPasswordScreen />; + case "mfa-otp-challenge": + return <MfaOtpChallengeScreen />; + default: + return null; + } +}; +``` + +## Example + +Accessing multiple properties +```tsx +import { useCurrentScreen } from '@auth0/auth0-acul-react'; + +const CustomAuthScreen = () => { + const screenOptions = useCurrentScreen(); + const organizationId = screenOptions?.organization?.id; + const errors = screenOptions?.transaction?.errors || []; + const locale = screenOptions?.transaction?.locale || 'en'; + + return ( + <div> + {organizationId && <p>Organization: {organizationId}</p>} + {errors.map((error, i) => ( + <p key={i} className="error">{error.message}</p> + ))} + <p>Language: {locale}</p> + </div> + ); +}; +``` + +--- + +**File:** [src/hooks/common/current-screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/current-screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useErrors.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useErrors.mdx new file mode 100644 index 000000000..893693d99 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useErrors.mdx @@ -0,0 +1,70 @@ +--- +title: "useErrors" +--- + +React hook for reading and managing errors in ACUL (Advanced Customization of Universal Login). +With all validation and server-side errors. It groups errors into three kinds: +- `server` — errors returned by Auth0 or your own backend. +- `client` — errors from client-side validation (e.g., invalid form input). +- `developer` — errors caused by incorrect integration or SDK misuse. + +## Supported Screens + +- The `useErrors` hook is available on every ACUL screen. + +## Parameters + +options.includeDevErrors - When `true`, developer errors are included in + the returned list. Defaults to `false`. + +## Returns + +An object of type \{@link UseErrorsResult\}, containing: +- `errors` — the full error list of type \{@link ErrorsResult\}, with helpers: + - `errors.byKind(kind, filter?)` — filter by error kind and optionally by field. + - `errors.byField(field, filter?)` — filter by field and optionally by kind. +- `hasError` — `true` if any error is currently present. +- `dismiss(id)` — remove a specific error by its ID. +- `dismissAll()` — clear all tracked errors. + +Typical usage is inside a form or screen component where you need to +reactively display errors and provide ways to dismiss them: + +## Example + +```tsx +import { useErrors } from "@auth0/auth0-acul-react"; + +export function SignupForm() { + const { errors, hasError, dismiss, dismissAll } = useErrors(); + + return ( + <div> + {hasError && ( + <div className="mb-4"> + {errors.byKind("server").map(err => ( + <div key={err.id} className="text-red-600"> + {err.message} + <button onClick={() => dismiss(err.id)}>Dismiss</button> + </div> + ))} + </div> + )} + + <button onClick={dismissAll}>Clear All Errors</button> + </div> + ); +} +``` + +In addition to rendering messages, you can filter by field or kind: +```ts +console.log(errors.byKind('client')); // all client errors +console.log(errors.byKind('client', { field: 'username' })); // client errors for field 'username' +console.log(errors.byField('username')); // all errors for field 'username' +console.log(errors.byField('username', { kind: 'server' })); // server errors for field 'username' +``` + +--- + +**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useLoginIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useLoginIdentifiers.mdx new file mode 100644 index 000000000..7d60fa9f6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useLoginIdentifiers.mdx @@ -0,0 +1,35 @@ +--- +title: "useLoginIdentifiers" +--- + +Returns a list of active identifier types (such as `'email'`, `'phone'`, or `'username'`) +currently in use in the authentication flow or login process. + +## Supported Screens + +- `login` +- `login-id` +- `reset-password-request` + +## Returns + +An array of \{@link IdentifierType\} representing active identifiers. + +## Example + +This example shows how to use the hook in a functional component on "login" screen. +```tsx +import { useLoginIdentifiers } from '@auth0/auth0-acul-react/login'; + +const loginIdentifiers = useLoginIdentifiers(); +const hasEmail = loginIdentifiers.includes('email'); +const hasPhone = loginIdentifiers.includes('phone'); +const hasUsername = loginIdentifiers.includes('username'); + +// loginIdentifiers could be: +// ['email', 'username'] +``` + +--- + +**File:** [src/hooks/utility/login-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/login-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useMfaPolling.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useMfaPolling.mdx new file mode 100644 index 000000000..4586d8a97 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useMfaPolling.mdx @@ -0,0 +1,75 @@ +--- +title: "useMfaPolling" +--- + +React hook to manage MFA push polling (e.g., waiting for a push notification approval) +on an Auth0 Advanced Customization of Universal Login (ACUL) screen. + +This hook sets up and controls a long-running polling loop that repeatedly checks +the MFA push challenge endpoint until one of the following occurs: + +- The challenge is **approved or denied** by the user, triggering `options.onCompleted`. +- An **error** occurs (network error, non-200/429 response), triggering `options.onError`. +- The **component unmounts** or `stopPolling()` is called, which cancels polling. + +### Key Features +- `isRunning` is **reactive** — it updates automatically if the polling loop + stops internally or is canceled. +- Uses a **stable single polling instance** (`useRef`) to prevent + duplicate network calls and unintended restarts during React re-renders. +- **Automatic cleanup** on unmount: no orphan timers or leaked XHR requests. + +## Parameters + +options - \{@link MfaPollingOptions\} specifying the polling interval, + success callback (`onCompleted`), and optional error handler (`onError`). + +## Supported Screens + +- `mfa-push-challenge-push` +- `reset-password-mfa-push-challenge-push` +- `mfa-push-enrollment-qr` + +## Returns + +object \{@link MfaPollingResult\} containing: +- `isRunning` — `true` while polling is active. +- `startPolling()` — starts or resumes polling. +- `stopPolling()` — stops polling immediately. + +## Example + +```tsx +import { useMfaPolling } from '@auth0/auth0-acul-react/mfa-push-challenge-push'; + +export function MfaPushStatus() { + const { isRunning, startPolling, stopPolling } = useMfaPolling({ + intervalMs: 5000, + onCompleted: () => console.log('Push approved!/denied'), + onError: (error) => console.error('Polling error:', error) + }); + + return ( + <div> + <button onClick={startPolling} disabled={isRunning}> + {isRunning ? 'Waiting for approval…' : 'Start MFA Polling'} + </button> + {isRunning && <button onClick={stopPolling}>Cancel</button>} + </div> + ); +} +``` + +## Remarks + +- The `onError` callback receives an \{@link ULError\} object + with `status` and `responseText` describing the server response. +- Internal rate-limit responses (`429`) are automatically handled: + polling waits for the reset window before retrying. +- Calling `startPolling()` repeatedly while running is safe and idempotent. + +## Public + +--- + +**File:** [src/hooks/utility/polling-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/usePasswordValidation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/usePasswordValidation.mdx new file mode 100644 index 000000000..27619b265 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/usePasswordValidation.mdx @@ -0,0 +1,47 @@ +--- +title: "usePasswordValidation" +--- + +This React hook validates a password against the current Auth0 password policy +and returns a structured result describing whether the password satisfies each rule. + +Optionally, it can send the validation results to the global error manager so that +form error components can update automatically. + +## Supported Screens + +- `signup` +- `signup-password` +- `reset-password` + +## Parameters + +password +- The password to validate. + +## Parameters + +options.includeInErrors +- If `true`, validation errors are stored in the global error manager under the `password` field. Defaults to `false`. + +## Returns + +A \{@link PasswordValidationResult\} object containing: +- `isValid` — `true` if the password satisfies all configured rules. +- `results` — an array of per-rule results with `code`, `label`, `status`, and `isValid`. + +## Example + +This example shows how to use the hook in a functional component on "signup" screen. +```tsx + import { usePasswordValidation } from '@auth0/auth0-acul-react/signup'; + const { isValid, results} = usePasswordValidation(password, { includeInErrors: true }); + + if (!isValid) { + console.log(results); + } +``` + +--- + +**File:** [src/hooks/utility/validate-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/validate-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useResend.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useResend.mdx new file mode 100644 index 000000000..d1f7a0b12 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useResend.mdx @@ -0,0 +1,64 @@ +--- +title: "useResend" +--- + +This React hook manages "resend" actions (e.g., resending a verification code) on ACUL screens. + +This hook: +- Tracks the remaining cooldown time. +- Tells you whether the resend button should be disabled. +- Provides a `startResend` function to trigger a resend immediately. + +## Supported Screens + +- `email-identifier-challenge` +- `email-otp-challenge` +- `login-email-verification` +- `login-passwordless-email-code` +- `login-passwordless-sms-otp` +- `mfa-email-challenge` +- `mfa-sms-challenge` +- `mfa-voice-challenge` +- `phone-identifier-challenge` +- `reset-password-mfa-email-challenge` +- `reset-password-mfa-sms-challenge` +- `reset-password-mfa-voice-challenge` + +## Parameters + +options - Optional configuration such as `timeoutSeconds` and `onTimeout`. + +## Returns + +An object with: +- `remaining` — seconds left until the next resend is permitted. +- `disabled` — `true` if resending is currently blocked. +- `startResend` — call to initiate a resend immediately (if allowed). + +## Example + +```tsx +import { useResend } from '@auth0/auth0-acul-react/mfa-sms-challenge'; + +export function ResendButton() { + const { remaining, disabled, startResend } = useResend({ + timeoutSeconds: 30, + onTimeout: () => console.log('You can resend again'), + }); + + return ( + <button onClick={startResend} disabled={disabled}> + {disabled ? `Resend in ${remaining}s` : 'Resend Code'} + </button> + ); +} +``` + +## Remarks + +- The underlying `ResendControl` has no explicit teardown method; the hook does not require manual cleanup. +- The hook re-initializes the resend manager if `timeoutSeconds` or `onTimeout` change. + +--- + +**File:** [src/hooks/utility/resend-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useSignupIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useSignupIdentifiers.mdx new file mode 100644 index 000000000..16c9972b6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useSignupIdentifiers.mdx @@ -0,0 +1,42 @@ +--- +title: "useSignupIdentifiers" +--- + +Returns a list of enabled identifiers (email, phone, or username), each with its `required` status, +based on the current screen's signup identifiers. + +## Supported Screens + +- `signup` +- `signup-id` + +## Returns + +An array of \{@link Identifier\} objects, where each contains a `type` (identifier type) +and a `required` flag indicating whether it is mandatory for signup. + +## Example + +```tsx +import { useSignupIdentifiers } from '@auth0/auth0-acul-react/signup'; + +const identifiers = useSignupIdentifiers(); +const emailIdentifier = identifiers.find(({ type }) => type === 'email'); +const phoneIdentifier = identifiers.find(({ type }) => type === 'phone'); +const usernameIdentifier = identifiers.find(({ type }) => type === 'username'); + +const emailRequired = emailIdentifier?.required ?? false; +const phoneRequired = phoneIdentifier?.required ?? false; +const usernameRequired = usernameIdentifier?.required ?? false; + +// Example output: +// [ +// { type: 'email', required: true }, +// { type: 'phone', required: false }, +// { type: 'username', required: true }, +// ] +``` + +--- + +**File:** [src/hooks/utility/signup-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/signup-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useUsernameValidation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useUsernameValidation.mdx new file mode 100644 index 000000000..d9bce787d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useUsernameValidation.mdx @@ -0,0 +1,69 @@ +--- +title: "useUsernameValidation" +--- + +React hook for validating a username against the current Auth0 username policy. + +This hook checks the provided username against all configured validation rules +and returns a structured result describing whether it passes. +Optionally, it can send validation errors to the global error manager so that +UI components observing the `username` field can automatically display or react +to these errors. + +## Supported Screens + +- `signup` +- `signup-id` + +## Parameters + +username - The username string to validate. + +## Parameters + +options.includeInErrors - When `true`, validation errors are stored in the + global error manager under the `username` field. Defaults to `false`. + +## Returns + +A \{@link UsernameValidationResult\} object with: +- `isValid` — `true` if the username satisfies all configured rules. +- `errors` — an array of per-rule validation errors with `code`, `message`, and `isValid`. + +## Example + +```tsx +import { useUsernameValidation } from "@auth0/auth0-acul-react/signup"; + +export function UsernameField() { + const { isValid, errors } = useUsernameValidation(username, { includeInErrors: true }); + + return ( + <div> + <input + value={username} + onChange={e => setUsername(e.target.value)} + aria-invalid={!isValid} + /> + + {!isValid && ( + <ul> + {errors.map(err => ( + <li key={err.code}>{err.message}</li> + ))} + </ul> + )} + </div> + ); +} +``` + +## Remarks + +- When `includeInErrors` is enabled, the hook automatically updates the errors to the error-store + which can be consumed by `useErrors` hook. +- The hook only recomputes when `username` or `options.includeInErrors` change. + +--- + +**File:** [src/hooks/utility/validate-username.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/validate-username.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem.mdx new file mode 100644 index 000000000..f0c99c29b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem.mdx @@ -0,0 +1,31 @@ +--- +title: "ErrorItem" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ErrorItem extends Auth0Error { + id: string; + label?: string; + kind?: ErrorKind; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="id" type={<span>string</span>} required> +</ParamField> + +<ParamField path="label" type={<span>string</span>}> +</ParamField> + +<ParamField path="kind" type={<span>ErrorKind</span>}> +</ParamField> + +--- + +**File:** [src/state/error-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/error-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorsResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorsResult.mdx new file mode 100644 index 000000000..1ae49581d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorsResult.mdx @@ -0,0 +1,27 @@ +--- +title: "ErrorsResult" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface ErrorsResult extends ReadonlyArray<ErrorItem> { + byKind(kind: ErrorKind, opts?: { field?: string }): ReadonlyArray<ErrorItem>; + byField(field: string, opts?: { kind?: ErrorKind }): ReadonlyArray<ErrorItem>; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="byKind" type={<span>ReadonlyArray<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>} required> +</ParamField> + +<ParamField path="byField" type={<span>ReadonlyArray<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>} required> +</ParamField> + +--- + +**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/MfaPollingResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/MfaPollingResult.mdx new file mode 100644 index 000000000..ac7db9b74 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/MfaPollingResult.mdx @@ -0,0 +1,55 @@ +--- +title: "MfaPollingResult" +description: "Result object returned by ." +--- + +<RequestExample> + +```typescript Interface lines +export interface MfaPollingResult { + /** + * Indicates whether the MFA push polling process is currently active. + * + * - `true` — Polling is running and awaiting completion. + * - `false` — Polling has stopped, either due to completion, + * manual cancellation, or component unmount. + */ + isRunning: boolean; + + /** + * Starts or resumes the polling process. + * + * - If polling is already active, this call has no effect. + * - If previously stopped, calling this restarts the polling loop. + */ + startPolling: () => void; + + /** + * Stops the polling process immediately. + * + * - Cancels any scheduled timers or in-flight requests. + * - Safe to call multiple times; subsequent calls have no effect. + */ + stopPolling: () => void; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="isRunning" type={<span>boolean</span>} required> + Indicates whether the MFA push polling process is currently active. - `true` — Polling is running and awaiting completion. - `false` — Polling has stopped, either due to completion, manual cancellation, or component unmount. +</ParamField> + +<ParamField path="startPolling" type={<span>() => void</span>} required> + Starts or resumes the polling process. - If polling is already active, this call has no effect. - If previously stopped, calling this restarts the polling loop. +</ParamField> + +<ParamField path="stopPolling" type={<span>() => void</span>} required> + Stops the polling process immediately. - Cancels any scheduled timers or in-flight requests. - Safe to call multiple times; subsequent calls have no effect. +</ParamField> + +--- + +**File:** [src/hooks/utility/polling-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorOptions.mdx new file mode 100644 index 000000000..6f629bf36 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "UseErrorOptions" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface UseErrorOptions { + includeDevErrors?: boolean; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="includeDevErrors" type={<span>boolean</span>}> +</ParamField> + +--- + +**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorsResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorsResult.mdx new file mode 100644 index 000000000..8b70f098b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorsResult.mdx @@ -0,0 +1,35 @@ +--- +title: "UseErrorsResult" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +export interface UseErrorsResult { + errors: ErrorsResult; + hasError: boolean; + dismiss: (id: string) => void; + dismissAll: () => void; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorsResult">ErrorsResult</a></span>} required> +</ParamField> + +<ParamField path="hasError" type={<span>boolean</span>} required> +</ParamField> + +<ParamField path="dismiss" type={<span>(id: string) => void</span>} required> +</ParamField> + +<ParamField path="dismissAll" type={<span>() => void</span>} required> +</ParamField> + +--- + +**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendOptions.mdx new file mode 100644 index 000000000..b6400964b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendOptions.mdx @@ -0,0 +1,37 @@ +--- +title: "UseResendOptions" +description: "Optional configuration for ." +--- + +<RequestExample> + +```typescript Interface lines +export interface UseResendOptions { + /** + * Countdown duration (in seconds) before another resend is allowed. + * Defaults to `10`. + */ + timeoutSeconds?: number; + /** + * Callback fired when the countdown finishes and the resend + * action becomes available again. + */ + onTimeout?: () => void; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="timeoutSeconds" type={<span>number</span>}> + Countdown duration (in seconds) before another resend is allowed. Defaults to `10`. +</ParamField> + +<ParamField path="onTimeout" type={<span>() => void</span>}> + Callback fired when the countdown finishes and the resend action becomes available again. +</ParamField> + +--- + +**File:** [src/hooks/utility/resend-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendReturn.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendReturn.mdx new file mode 100644 index 000000000..aa8c10fa7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendReturn.mdx @@ -0,0 +1,37 @@ +--- +title: "UseResendReturn" +description: "Return type for ." +--- + +<RequestExample> + +```typescript Interface lines +export interface UseResendReturn { + /** Seconds remaining until the next resend attempt is allowed. */ + remaining: number; + /** Whether the resend action is currently disabled. */ + disabled: boolean; + /** Start a resend attempt immediately, if allowed. */ + startResend: () => void; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="remaining" type={<span>number</span>} required> + Seconds remaining until the next resend attempt is allowed. +</ParamField> + +<ParamField path="disabled" type={<span>boolean</span>} required> + Whether the resend action is currently disabled. +</ParamField> + +<ParamField path="startResend" type={<span>() => void</span>} required> + Start a resend attempt immediately, if allowed. +</ParamField> + +--- + +**File:** [src/hooks/utility/resend-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithLoginIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithLoginIdentifiers.mdx new file mode 100644 index 000000000..e8a9584a9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithLoginIdentifiers.mdx @@ -0,0 +1,23 @@ +--- +title: "WithLoginIdentifiers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +interface WithLoginIdentifiers { + getLoginIdentifiers: () => IdentifierType[]; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="getLoginIdentifiers" type={<span>() => IdentifierType[]</span>} required> +</ParamField> + +--- + +**File:** [src/hooks/utility/login-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/login-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithResendManager.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithResendManager.mdx new file mode 100644 index 000000000..8b9f2dce4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithResendManager.mdx @@ -0,0 +1,23 @@ +--- +title: "WithResendManager" +description: "Screens that support resend operations expose a `resendManager` method." +--- + +<RequestExample> + +```typescript Interface lines +interface WithResendManager { + resendManager(options?: StartResendOptions): ResendControl; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="resendManager" type={<span>ResendControl</span>} required> +</ParamField> + +--- + +**File:** [src/hooks/utility/resend-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithSignupIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithSignupIdentifiers.mdx new file mode 100644 index 000000000..775e48aa9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithSignupIdentifiers.mdx @@ -0,0 +1,23 @@ +--- +title: "WithSignupIdentifiers" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +interface WithSignupIdentifiers { + getSignupIdentifiers: () => Identifier[]; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="getSignupIdentifiers" type={<span>() => Identifier[]</span>} required> +</ParamField> + +--- + +**File:** [src/hooks/utility/signup-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/signup-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidatePassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidatePassword.mdx new file mode 100644 index 000000000..758fa5455 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidatePassword.mdx @@ -0,0 +1,23 @@ +--- +title: "WithValidatePassword" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +interface WithValidatePassword { + validatePassword: (password: string) => PasswordValidationResult; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="validatePassword" type={<span>(password: string) => PasswordValidationResult</span>} required> +</ParamField> + +--- + +**File:** [src/hooks/utility/validate-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/validate-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidateUsername.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidateUsername.mdx new file mode 100644 index 000000000..c00456606 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidateUsername.mdx @@ -0,0 +1,23 @@ +--- +title: "WithValidateUsername" +description: "" +--- + +<RequestExample> + +```typescript Interface lines +interface WithValidateUsername { + validateUsername: (username: string) => UsernameValidationResult; +} +``` + +</RequestExample> + +## Properties + +<ParamField path="validateUsername" type={<span>(username: string) => UsernameValidationResult</span>} required> +</ParamField> + +--- + +**File:** [src/hooks/utility/validate-username.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/validate-username.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/navigation.json b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/navigation.json new file mode 100644 index 000000000..4258540a2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/navigation.json @@ -0,0 +1,367 @@ +{ + "group": "@auth0/auth0-acul-react", + "pages": [ + { + "group": "Classes", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ErrorStore", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ContextHooks" + ] + }, + { + "group": "Interfaces", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorsResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorsResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithLoginIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/MfaPollingResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendReturn", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithResendManager", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithSignupIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidatePassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidateUsername", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem" + ] + }, + { + "group": "Types", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ErrorKind", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Bucket", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Listener", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ScreenConstructor" + ] + }, + { + "group": "Functions", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/classifyKind", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toErrorObject", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/filterByField", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/withError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/listsEqual", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/registerScreen", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getScreen", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/clearScreen", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/acceptInvitation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAcceptInvitation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/accept", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/deny", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useConsent", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/accept", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/deny", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCustomizedConsent", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationAllowed", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationDenied", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirm", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/cancel", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeConfirmation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailOTPChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailVerificationResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useInterstitialCaptcha", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginEmailVerification", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/passkeyLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitOTP", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendOTP", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutAborted", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutComplete", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirmLogout", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogout", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaBeginEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectCountryCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaCountryCodes", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/detectCapabilities", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaDetectBrowserCapabilities", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickEmail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaEmail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailList", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEnrollResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toggleView", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickPhone", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendPushNotification", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enterCodeManually", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickAuthenticator", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaPushDevice", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushList", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickAuthenticator", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushWelcome", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallengeNewCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickSms", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getACall", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneNumber", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backAction", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsList", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickPhone", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToSms", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneCountryCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithNewNickname", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnChangeKeyNickname", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnEnrollmentSuccess", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAgain", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/noThanks", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnNotAvailableError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/verify", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPasskeyCredential", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/snoozeEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/refuseEnrollmentOnThisDevice", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/verify", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportWebAuthnError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/showError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectOrganization", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/skipOrganizationSelection", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationPicker", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithOrganizationName", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationSelection", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/abortPasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollmentLocal", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/abortPasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToVoice", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToText", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePhoneEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useRedeemTicket", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendEmail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordEmail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendPushNotification", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enterCodeManually", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaRecoveryCodeChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getACall", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToSms", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithPasskey", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSecurityKey", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/showError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resetPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backToLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordSuccess", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resetPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignup" + ] + }, + { + "group": "Screens", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/accept-invitation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/consent", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/customized-consent", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-allowed", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-denied", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-confirmation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-identifier-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-otp-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-verification-result", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/interstitial-captcha", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-email-verification", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-id", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-password", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-email-code", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-sms-otp", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-aborted", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-complete", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-begin-enroll-options", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-country-codes", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-detect-browser-capabilities", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-list", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-enroll-result", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-login-options", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-code", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-qr", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-challenge-push", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-enrollment-qr", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-list", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-welcome", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge-new-code", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-list", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-change-key-nickname", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-enrollment-success", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-error", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-not-available-error", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-picker", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-selection", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment-local", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-enrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/redeem-ticket", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-email", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-error", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-email-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-otp-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-phone-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-push-challenge-push", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-recovery-code-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-sms-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-voice-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-platform-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-roaming-challenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-request", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-success", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-id", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-password", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup" + ] + } + ] +} \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/accept-invitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/accept-invitation.mdx new file mode 100644 index 000000000..71d57087f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/accept-invitation.mdx @@ -0,0 +1,152 @@ +--- +title: "Accept Invitation" +description: "The Accept Invitation screen module provides access to the Accept Invitation flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useAcceptInvitation" type="AcceptInvitationMembers"> + Provides access to the Accept Invitation context and functionality. +</ParamField> + +<ParamField body="acceptInvitation" type="Function"> + Accepts the invitation to the organization. + + **Parameter:** Optional custom options to include with the request. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/accept-invitation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/accept-invitation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/consent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/consent.mdx new file mode 100644 index 000000000..b809fb514 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/consent.mdx @@ -0,0 +1,154 @@ +--- +title: "Consent" +description: "The Consent screen module provides access to the Consent flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useConsent" type="ConsentMembers"> + Provides access to the Consent context and functionality. +</ParamField> + +<ParamField body="accept" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="deny" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/consent.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/consent.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/customized-consent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/customized-consent.mdx new file mode 100644 index 000000000..464805f5d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/customized-consent.mdx @@ -0,0 +1,154 @@ +--- +title: "Customized Consent" +description: "The Customized Consent screen module provides access to the Customized Consent flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useCustomizedConsent" type="CustomizedConsentMembers"> + Provides access to the Customized Consent context and functionality. +</ParamField> + +<ParamField body="accept" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="deny" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/customized-consent.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/customized-consent.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-allowed.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-allowed.mdx new file mode 100644 index 000000000..125f2e2a5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-allowed.mdx @@ -0,0 +1,146 @@ +--- +title: "Device Code Activation Allowed" +description: "The Device Code Activation Allowed screen module provides access to the Device Code Activation Allowed flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useDeviceCodeActivationAllowed" type="DeviceCodeActivationAllowedMembers"> + Provides access to the Device Code Activation Allowed context and functionality. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/device-code-activation-allowed.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-denied.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-denied.mdx new file mode 100644 index 000000000..27d9b6549 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-denied.mdx @@ -0,0 +1,146 @@ +--- +title: "Device Code Activation Denied" +description: "The Device Code Activation Denied screen module provides access to the Device Code Activation Denied flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useDeviceCodeActivationDenied" type="DeviceCodeActivationDeniedMembers"> + Provides access to the Device Code Activation Denied context and functionality. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/device-code-activation-denied.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation.mdx new file mode 100644 index 000000000..4c9e33a9c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation.mdx @@ -0,0 +1,150 @@ +--- +title: "Device Code Activation" +description: "The Device Code Activation screen module provides access to the Device Code Activation flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useDeviceCodeActivation" type="DeviceCodeActivationMembers"> + Provides access to the Device Code Activation context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/device-code-activation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-activation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-confirmation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-confirmation.mdx new file mode 100644 index 000000000..4bf355757 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-confirmation.mdx @@ -0,0 +1,158 @@ +--- +title: "Device Code Confirmation" +description: "The Device Code Confirmation screen module provides access to the Device Code Confirmation flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useDeviceCodeConfirmation" type="DeviceCodeConfirmationMembers"> + Provides access to the Device Code Confirmation context and functionality. +</ParamField> + +<ParamField body="confirm" type="Function"> + Interface describing the data available on the Device Code Confirmation screen. / export interface ScreenMembersOnDeviceCodeConfirmation extends ScreenMembers { data: { textCode: string; } | null; } Interface describing the members of the Device Code Confirmation screen. / export interface DeviceCodeConfirmationMembers extends BaseMembers { screen: ScreenMembersOnDeviceCodeConfirmation; Confirms the device code. + + **Parameter:** Optional custom options to include with the request. +</ParamField> + +<ParamField body="cancel" type="Function"> + Interface describing the data available on the Device Code Confirmation screen. / export interface ScreenMembersOnDeviceCodeConfirmation extends ScreenMembers { data: { textCode: string; } | null; } Interface describing the members of the Device Code Confirmation screen. / export interface DeviceCodeConfirmationMembers extends BaseMembers { screen: ScreenMembersOnDeviceCodeConfirmation; Confirms the device code. + + **Parameter:** Optional custom options to include with the request. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/device-code-confirmation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-identifier-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-identifier-challenge.mdx new file mode 100644 index 000000000..f2323b860 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-identifier-challenge.mdx @@ -0,0 +1,158 @@ +--- +title: "Email Identifier Challenge" +description: "The Email Identifier Challenge screen module provides access to the Email Identifier Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useEmailIdentifierChallenge" type="EmailIdentifierChallengeMembers"> + Provides access to the Email Identifier Challenge context and functionality. +</ParamField> + +<ParamField body="submitEmailChallenge" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="resendCode" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="returnToPrevious" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/email-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-otp-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-otp-challenge.mdx new file mode 100644 index 000000000..ff59be098 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-otp-challenge.mdx @@ -0,0 +1,158 @@ +--- +title: "Email Otp Challenge" +description: "The Email Otp Challenge screen module provides access to the Email Otp Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useEmailOTPChallenge" type="EmailOTPChallengeMembers"> + Provides access to the Email Otp Challenge context and functionality. +</ParamField> + +<ParamField body="submitCode" type="Function"> + Represents the members of the Email OTP Challenge screen. Extends the base ScreenMembers interface. / export interface ScreenMembersOnEmailOTPChallenge extends ScreenMembers { // Add any specific members for this screen here } export interface OtpCodeOptions extends CustomOptions { The OTP code that the user enters to submit. / code: string; } // test data********* Represents the Email OTP Challenge screen interface. / export interface EmailOTPChallengeMembers extends BaseMembers { screen: ScreenMembersOnEmailOTPChallenge; Submits the OTP code entered by the user. + + **Parameter:** Optional parameters to include in the submission. +</ParamField> + +<ParamField body="resendCode" type="Function"> + Represents the members of the Email OTP Challenge screen. Extends the base ScreenMembers interface. / export interface ScreenMembersOnEmailOTPChallenge extends ScreenMembers { // Add any specific members for this screen here } export interface OtpCodeOptions extends CustomOptions { The OTP code that the user enters to submit. / code: string; } // test data********* Represents the Email OTP Challenge screen interface. / export interface EmailOTPChallengeMembers extends BaseMembers { screen: ScreenMembersOnEmailOTPChallenge; Submits the OTP code entered by the user. + + **Parameter:** Optional parameters to include in the submission. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/email-otp-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-verification-result.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-verification-result.mdx new file mode 100644 index 000000000..f4445b8a9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-verification-result.mdx @@ -0,0 +1,146 @@ +--- +title: "Email Verification Result" +description: "The Email Verification Result screen module provides access to the Email Verification Result flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useEmailVerificationResult" type="EmailVerificationResultMembers"> + Provides access to the Email Verification Result context and functionality. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/email-verification-result.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/email-verification-result.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/interstitial-captcha.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/interstitial-captcha.mdx new file mode 100644 index 000000000..00ba16e32 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/interstitial-captcha.mdx @@ -0,0 +1,146 @@ +--- +title: "Interstitial Captcha" +description: "The Interstitial Captcha screen module provides access to the Interstitial Captcha flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useInterstitialCaptcha" type="InterstitialCaptchaMembers"> + Provides access to the Interstitial Captcha context and functionality. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/interstitial-captcha.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-email-verification.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-email-verification.mdx new file mode 100644 index 000000000..64c5d72a6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-email-verification.mdx @@ -0,0 +1,154 @@ +--- +title: "Login Email Verification" +description: "The Login Email Verification screen module provides access to the Login Email Verification flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useLoginEmailVerification" type="LoginEmailVerificationMembers"> + Provides access to the Login Email Verification context and functionality. +</ParamField> + +<ParamField body="continueWithCode" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="resendCode" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/login-email-verification.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-email-verification.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-id.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-id.mdx new file mode 100644 index 000000000..be69e771a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-id.mdx @@ -0,0 +1,162 @@ +--- +title: "Login Id" +description: "The Login Id screen module provides access to the Login Id flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useLoginId" type="LoginIdMembers"> + Provides access to the Login Id context and functionality. +</ParamField> + +<ParamField body="login" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="federatedLogin" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="passkeyLogin" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="pickCountryCode" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/login-id.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-id.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-password.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-password.mdx new file mode 100644 index 000000000..dede15ba0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-password.mdx @@ -0,0 +1,154 @@ +--- +title: "Login Password" +description: "The Login Password screen module provides access to the Login Password flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useLoginPassword" type="LoginPasswordMembers"> + Provides access to the Login Password context and functionality. +</ParamField> + +<ParamField body="login" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="federatedLogin" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/login-password.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-password.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-email-code.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-email-code.mdx new file mode 100644 index 000000000..582a980a0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-email-code.mdx @@ -0,0 +1,154 @@ +--- +title: "Login Passwordless Email Code" +description: "The Login Passwordless Email Code screen module provides access to the Login Passwordless Email Code flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useLoginPasswordlessEmailCode" type="LoginPasswordlessEmailCodeMembers"> + Provides access to the Login Passwordless Email Code context and functionality. +</ParamField> + +<ParamField body="submitCode" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="resendCode" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/login-passwordless-email-code.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-sms-otp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-sms-otp.mdx new file mode 100644 index 000000000..7fa6f1995 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-sms-otp.mdx @@ -0,0 +1,154 @@ +--- +title: "Login Passwordless Sms Otp" +description: "The Login Passwordless Sms Otp screen module provides access to the Login Passwordless Sms Otp flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useLoginPasswordlessSmsOtp" type="LoginPasswordlessSmsOtpMembers"> + Provides access to the Login Passwordless Sms Otp context and functionality. +</ParamField> + +<ParamField body="submitOTP" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="resendOTP" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/login-passwordless-sms-otp.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login.mdx new file mode 100644 index 000000000..00662d6cf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login.mdx @@ -0,0 +1,164 @@ +--- +title: "Login" +description: "The Login screen module provides access to the Login flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useLogin" type="LoginMembers"> + Provides access to the Login context and functionality. +</ParamField> + +<ParamField body="login" type="Function"> + Extended screen context interface for the login screen / export interface ScreenContextOnLogin extends ScreenContext { links: { signup: string; reset_password: string; }; } Extended screen members interface for the login screen / export interface ScreenMembersOnLogin extends ScreenMembers { signupLink: string | null; resetPasswordLink: string | null; data: { username?: string; } | null; } Extended transaction context interface for the login screen / export interface TransactionContextOnLogin extends TransactionContext { connection: DBConnection; } Extended transaction members interface for the login screen / export interface TransactionMembersOnLogin extends TransactionMembers { isSignupEnabled: boolean; isForgotPasswordEnabled: boolean; isPasskeyEnabled: boolean; passwordPolicy: PasswordPolicy | null; allowedIdentifiers: IdentifierType[] | null; } Login screen interface extending base context / export interface Login extends BaseContext { screen: ScreenContextOnLogin; transaction: TransactionContextOnLogin; } Options for performing login operations / export interface LoginOptions { /** The username/email to login with */ username: string; /** The password for authentication */ password: string; /** Optional captcha value if required */ captcha?: string; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for performing social login operations / export interface FederatedLoginOptions { /** The social connection name to use */ connection: string; /** Any additional custom options */ [key: string]: string | number | boolean; } Login screen members interface extending base members / export interface LoginMembers extends BaseMembers { screen: ScreenMembersOnLogin; transaction: TransactionMembersOnLogin; Performs login with username/password + + **Parameter:** The login options +</ParamField> + +<ParamField body="federatedLogin" type="Function"> + Extended screen context interface for the login screen / export interface ScreenContextOnLogin extends ScreenContext { links: { signup: string; reset_password: string; }; } Extended screen members interface for the login screen / export interface ScreenMembersOnLogin extends ScreenMembers { signupLink: string | null; resetPasswordLink: string | null; data: { username?: string; } | null; } Extended transaction context interface for the login screen / export interface TransactionContextOnLogin extends TransactionContext { connection: DBConnection; } Extended transaction members interface for the login screen / export interface TransactionMembersOnLogin extends TransactionMembers { isSignupEnabled: boolean; isForgotPasswordEnabled: boolean; isPasskeyEnabled: boolean; passwordPolicy: PasswordPolicy | null; allowedIdentifiers: IdentifierType[] | null; } Login screen interface extending base context / export interface Login extends BaseContext { screen: ScreenContextOnLogin; transaction: TransactionContextOnLogin; } Options for performing login operations / export interface LoginOptions { /** The username/email to login with */ username: string; /** The password for authentication */ password: string; /** Optional captcha value if required */ captcha?: string; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for performing social login operations / export interface FederatedLoginOptions { /** The social connection name to use */ connection: string; /** Any additional custom options */ [key: string]: string | number | boolean; } Login screen members interface extending base members / export interface LoginMembers extends BaseMembers { screen: ScreenMembersOnLogin; transaction: TransactionMembersOnLogin; Performs login with username/password + + **Parameter:** The login options +</ParamField> + +<ParamField body="pickCountryCode" type="Function"> + Extended screen context interface for the login screen / export interface ScreenContextOnLogin extends ScreenContext { links: { signup: string; reset_password: string; }; } Extended screen members interface for the login screen / export interface ScreenMembersOnLogin extends ScreenMembers { signupLink: string | null; resetPasswordLink: string | null; data: { username?: string; } | null; } Extended transaction context interface for the login screen / export interface TransactionContextOnLogin extends TransactionContext { connection: DBConnection; } Extended transaction members interface for the login screen / export interface TransactionMembersOnLogin extends TransactionMembers { isSignupEnabled: boolean; isForgotPasswordEnabled: boolean; isPasskeyEnabled: boolean; passwordPolicy: PasswordPolicy | null; allowedIdentifiers: IdentifierType[] | null; } Login screen interface extending base context / export interface Login extends BaseContext { screen: ScreenContextOnLogin; transaction: TransactionContextOnLogin; } Options for performing login operations / export interface LoginOptions { /** The username/email to login with */ username: string; /** The password for authentication */ password: string; /** Optional captcha value if required */ captcha?: string; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for performing social login operations / export interface FederatedLoginOptions { /** The social connection name to use */ connection: string; /** Any additional custom options */ [key: string]: string | number | boolean; } Login screen members interface extending base members / export interface LoginMembers extends BaseMembers { screen: ScreenMembersOnLogin; transaction: TransactionMembersOnLogin; Performs login with username/password + + **Parameter:** The login options +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/login.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-aborted.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-aborted.mdx new file mode 100644 index 000000000..adeddba2f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-aborted.mdx @@ -0,0 +1,146 @@ +--- +title: "Logout Aborted" +description: "The Logout Aborted screen module provides access to the Logout Aborted flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useLogoutAborted" type="LogoutAbortedMembers"> + Provides access to the Logout Aborted context and functionality. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/logout-aborted.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/logout-aborted.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-complete.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-complete.mdx new file mode 100644 index 000000000..106f2551f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-complete.mdx @@ -0,0 +1,146 @@ +--- +title: "Logout Complete" +description: "The Logout Complete screen module provides access to the Logout Complete flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useLogoutComplete" type="LogoutCompleteMembers"> + Provides access to the Logout Complete context and functionality. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/logout-complete.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/logout-complete.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout.mdx new file mode 100644 index 000000000..816b4bf99 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout.mdx @@ -0,0 +1,152 @@ +--- +title: "Logout" +description: "The Logout screen module provides access to the Logout flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useLogout" type="LogoutMembers"> + Provides access to the Logout context and functionality. +</ParamField> + +<ParamField body="confirmLogout" type="Function"> + Options for confirming logout / export interface ConfirmLogoutOptions extends CustomOptions { /** The authentication transaction state */ action: 'accept' | 'deny'; } Interface defining the available methods and properties for the logout screen / export interface LogoutMembers extends BaseMembers { Confirms the logout action (accept or deny) + + **Parameter:** The options containing the action to perform +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/logout.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/logout.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-begin-enroll-options.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-begin-enroll-options.mdx new file mode 100644 index 000000000..36a112132 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-begin-enroll-options.mdx @@ -0,0 +1,152 @@ +--- +title: "Mfa Begin Enroll Options" +description: "The Mfa Begin Enroll Options screen module provides access to the Mfa Begin Enroll Options flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaBeginEnrollOptions" type="MfaBeginEnrollOptionsMembers"> + Provides access to the Mfa Begin Enroll Options context and functionality. +</ParamField> + +<ParamField body="enroll" type="Function"> + Options for continuing with factor enrollment / export interface MfaEnrollOptions { /** The action indicating which factor to enroll */ action: MfaEnrollFactorType; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } MFA Begin Enroll Options screen members interface / export interface MfaBeginEnrollOptionsMembers extends BaseMembers { Continues the enrollment process with the selected factor + + **Parameter:** The enrollment options including the selected factor +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-begin-enroll-options.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-country-codes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-country-codes.mdx new file mode 100644 index 000000000..09203d4b8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-country-codes.mdx @@ -0,0 +1,158 @@ +--- +title: "Mfa Country Codes" +description: "The Mfa Country Codes screen module provides access to the Mfa Country Codes flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaCountryCodes" type="MfaCountryCodesMembers"> + Provides access to the Mfa Country Codes context and functionality. +</ParamField> + +<ParamField body="selectCountryCode" type="Function"> + Interface for screen data specific to mfa-country-codes screen / export interface ScreenMembersOnMfaCountryCodes extends ScreenMembers { data: { /** List of available phone prefixes */ phone_prefixes: PhonePrefix[]; } | null; } Options for selecting a country code / export interface SelectCountryCodeOptions { /** The country code (e.g. 'US', 'GB') */ country_code: string; /** The phone prefix (e.g. '+1', '+44') */ phone_prefix: string; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-country-codes screen / export interface MfaCountryCodesMembers extends BaseMembers { screen: ScreenMembersOnMfaCountryCodes; Selects a country code from the available options + + **Parameter:** The options containing the country code selection action +</ParamField> + +<ParamField body="goBack" type="Function"> + Interface for screen data specific to mfa-country-codes screen / export interface ScreenMembersOnMfaCountryCodes extends ScreenMembers { data: { /** List of available phone prefixes */ phone_prefixes: PhonePrefix[]; } | null; } Options for selecting a country code / export interface SelectCountryCodeOptions { /** The country code (e.g. 'US', 'GB') */ country_code: string; /** The phone prefix (e.g. '+1', '+44') */ phone_prefix: string; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-country-codes screen / export interface MfaCountryCodesMembers extends BaseMembers { screen: ScreenMembersOnMfaCountryCodes; Selects a country code from the available options + + **Parameter:** The options containing the country code selection action +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-country-codes.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-detect-browser-capabilities.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-detect-browser-capabilities.mdx new file mode 100644 index 000000000..f4cc464be --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-detect-browser-capabilities.mdx @@ -0,0 +1,152 @@ +--- +title: "Mfa Detect Browser Capabilities" +description: "The Mfa Detect Browser Capabilities screen module provides access to the Mfa Detect Browser Capabilities flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaDetectBrowserCapabilities" type="MfaDetectBrowserCapabilitiesMembers"> + Provides access to the Mfa Detect Browser Capabilities context and functionality. +</ParamField> + +<ParamField body="detectCapabilities" type="Function"> + Interface defining the available methods and properties for the mfa-detect-browser-capabilities screen / export interface MfaDetectBrowserCapabilitiesMembers extends BaseMembers { Picks an authenticator based on browser capabilities + + **Parameter:** The options containing browser capability flags +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-detect-browser-capabilities.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-challenge.mdx new file mode 100644 index 000000000..27fc922a8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-challenge.mdx @@ -0,0 +1,168 @@ +--- +title: "Mfa Email Challenge" +description: "The Mfa Email Challenge screen module provides access to the Mfa Email Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaEmailChallenge" type="MfaEmailChallengeMembers"> + Provides access to the Mfa Email Challenge context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="resendCode" type="Function"> + Interface for the screen data specific to mfa-email-challenge screen / export interface ScreenMembersOnMfaEmailChallenge extends ScreenMembers { data: { email: string; showRememberDevice?: boolean; } | null; } Interface for untrusted data specific to mfa-email-challenge screen / export interface UntrustedDataMembersOnMfaEmailChallenge extends UntrustedDataMembers { submittedFormData: { rememberDevice: boolean; } | null; } Options for continuing with the email challenge / export interface ContinueOptions { /** The code entered by the user */ code: string; /** Indicates whether to remember the device */ rememberDevice?: boolean; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for resending the email code / export interface ResendCodeOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for trying another method / export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-email-challenge screen / export interface MfaEmailChallengeMembers extends BaseMembers { screen: ScreenMembersOnMfaEmailChallenge; untrustedData: UntrustedDataMembersOnMfaEmailChallenge; Continues with the email challenge using the provided code + + **Parameter:** The options containing the code and rememberDevice flag +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Interface for the screen data specific to mfa-email-challenge screen / export interface ScreenMembersOnMfaEmailChallenge extends ScreenMembers { data: { email: string; showRememberDevice?: boolean; } | null; } Interface for untrusted data specific to mfa-email-challenge screen / export interface UntrustedDataMembersOnMfaEmailChallenge extends UntrustedDataMembers { submittedFormData: { rememberDevice: boolean; } | null; } Options for continuing with the email challenge / export interface ContinueOptions { /** The code entered by the user */ code: string; /** Indicates whether to remember the device */ rememberDevice?: boolean; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for resending the email code / export interface ResendCodeOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for trying another method / export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-email-challenge screen / export interface MfaEmailChallengeMembers extends BaseMembers { screen: ScreenMembersOnMfaEmailChallenge; untrustedData: UntrustedDataMembersOnMfaEmailChallenge; Continues with the email challenge using the provided code + + **Parameter:** The options containing the code and rememberDevice flag +</ParamField> + +<ParamField body="pickEmail" type="Function"> + Interface for the screen data specific to mfa-email-challenge screen / export interface ScreenMembersOnMfaEmailChallenge extends ScreenMembers { data: { email: string; showRememberDevice?: boolean; } | null; } Interface for untrusted data specific to mfa-email-challenge screen / export interface UntrustedDataMembersOnMfaEmailChallenge extends UntrustedDataMembers { submittedFormData: { rememberDevice: boolean; } | null; } Options for continuing with the email challenge / export interface ContinueOptions { /** The code entered by the user */ code: string; /** Indicates whether to remember the device */ rememberDevice?: boolean; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for resending the email code / export interface ResendCodeOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for trying another method / export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-email-challenge screen / export interface MfaEmailChallengeMembers extends BaseMembers { screen: ScreenMembersOnMfaEmailChallenge; untrustedData: UntrustedDataMembersOnMfaEmailChallenge; Continues with the email challenge using the provided code + + **Parameter:** The options containing the code and rememberDevice flag +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-email-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-list.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-list.mdx new file mode 100644 index 000000000..02f20cdca --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-list.mdx @@ -0,0 +1,158 @@ +--- +title: "Mfa Email List" +description: "The Mfa Email List screen module provides access to the Mfa Email List flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaEmailList" type="MfaEmailListMembers"> + Provides access to the Mfa Email List context and functionality. +</ParamField> + +<ParamField body="selectMfaEmail" type="Function"> + Interface for the screen data specific to mfa-email-list screen / export interface ScreenMembersOnMfaEmailList extends ScreenMembers { data: { /** List of enrolled email addresses */ enrolled_emails: string[]; } | null; } Options for selecting an email address / export interface SelectMfaEmailOptions { + + **Parameter:** The options containing the selection action +</ParamField> + +<ParamField body="goBack" type="Function"> + Interface for the screen data specific to mfa-email-list screen / export interface ScreenMembersOnMfaEmailList extends ScreenMembers { data: { /** List of enrolled email addresses */ enrolled_emails: string[]; } | null; } Options for selecting an email address / export interface SelectMfaEmailOptions { + + **Parameter:** The options containing the selection action +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-email-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-email-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-enroll-result.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-enroll-result.mdx new file mode 100644 index 000000000..515fff262 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-enroll-result.mdx @@ -0,0 +1,146 @@ +--- +title: "Mfa Enroll Result" +description: "The Mfa Enroll Result screen module provides access to the Mfa Enroll Result flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaEnrollResult" type="MfaEnrollResultMembers"> + Provides access to the Mfa Enroll Result context and functionality. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-enroll-result.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-login-options.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-login-options.mdx new file mode 100644 index 000000000..a8c5abd80 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-login-options.mdx @@ -0,0 +1,158 @@ +--- +title: "Mfa Login Options" +description: "The Mfa Login Options screen module provides access to the Mfa Login Options flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaLoginOptions" type="MfaLoginOptionsMembers"> + Provides access to the Mfa Login Options context and functionality. +</ParamField> + +<ParamField body="enroll" type="Function"> + Interface for the screen data specific to mfa-login-options screen / export interface ScreenMembersOnMfaLoginOptions extends ScreenMembers { data: { /** List of enrolled MFA factors for the user */ enrolled_factors: string[]; } | null; } Options for continuing with a selected MFA factor / export interface LoginEnrollOptions { /** The action indicating which factor to use for login */ action: MfaLoginFactorType; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-login-options screen / export interface MfaLoginOptionsMembers extends BaseMembers { screen: ScreenMembersOnMfaLoginOptions; Continues the login process with the selected MFA factor + + **Parameter:** The options containing the selected factor +</ParamField> + +<ParamField body="returnToPrevious" type="Function"> + Interface for the screen data specific to mfa-login-options screen / export interface ScreenMembersOnMfaLoginOptions extends ScreenMembers { data: { /** List of enrolled MFA factors for the user */ enrolled_factors: string[]; } | null; } Options for continuing with a selected MFA factor / export interface LoginEnrollOptions { /** The action indicating which factor to use for login */ action: MfaLoginFactorType; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-login-options screen / export interface MfaLoginOptionsMembers extends BaseMembers { screen: ScreenMembersOnMfaLoginOptions; Continues the login process with the selected MFA factor + + **Parameter:** The options containing the selected factor +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-login-options.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-login-options.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-challenge.mdx new file mode 100644 index 000000000..cc3f9ebfc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-challenge.mdx @@ -0,0 +1,156 @@ +--- +title: "Mfa Otp Challenge" +description: "The Mfa Otp Challenge screen module provides access to the Mfa Otp Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaOtpChallenge" type="MfaOtpChallengeMembers"> + Provides access to the Mfa Otp Challenge context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Interface for the screen data specific to mfa-otp-challenge screen / export interface ScreenMembersOnMfaOtpChallenge extends ScreenMembers { data: { showRememberDevice?: boolean; } | null; } Interface for untrusted data specific to mfa-otp-challenge screen / export interface UntrustedDataMembersOnMfaOtpChallenge extends UntrustedDataMembers { submittedFormData: { rememberDevice: boolean; } | null; } Options for continuing with the OTP challenge / export interface ContinueOptions { /** The code entered by the user */ code: string; /** Indicates whether to remember the browser */ rememberDevice?: boolean; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for trying another method / export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-otp-challenge screen / export interface MfaOtpChallengeMembers extends BaseMembers { screen: ScreenMembersOnMfaOtpChallenge; untrustedData: UntrustedDataMembersOnMfaOtpChallenge; Continues with the OTP challenge using the provided code + + **Parameter:** The options containing the code and rememberDevice flag +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-otp-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-code.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-code.mdx new file mode 100644 index 000000000..20bfcc2d9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-code.mdx @@ -0,0 +1,156 @@ +--- +title: "Mfa Otp Enrollment Code" +description: "The Mfa Otp Enrollment Code screen module provides access to the Mfa Otp Enrollment Code flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaOtpEnrollmentCode" type="MfaOtpEnrollmentCodeMembers"> + Provides access to the Mfa Otp Enrollment Code context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Options for continuing with the MFA OTP enrollment code. / export interface ContinueOptions { The OTP code entered by the user. / code: string; Any additional custom options. / [key: string]: string | number | boolean | undefined; } Options for trying another MFA method. / export interface TryAnotherMethodOptions { Any additional custom options. / [key: string]: string | number | boolean | undefined; } Interface for the screen data specific to the mfa-otp-enrollment-code screen. / export interface ScreenMembersOnMfaOtpEnrollmentCode extends ScreenMembers { data: { The text code to display to the user. / text_code: string; } | null; } Interface defining the available methods and properties for the mfa-otp-enrollment-code screen. / export interface MfaOtpEnrollmentCodeMembers extends BaseMembers { The screen properties for the mfa-otp-enrollment-code screen. / screen: ScreenMembersOnMfaOtpEnrollmentCode; Continues the MFA OTP enrollment process by submitting the OTP code. + + **Parameter:** The options containing the OTP code. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-otp-enrollment-code.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-qr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-qr.mdx new file mode 100644 index 000000000..a88ac6a76 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-qr.mdx @@ -0,0 +1,162 @@ +--- +title: "Mfa Otp Enrollment Qr" +description: "The Mfa Otp Enrollment Qr screen module provides access to the Mfa Otp Enrollment Qr flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaOtpEnrollmentQr" type="MfaOtpEnrollmentQrMembers"> + Provides access to the Mfa Otp Enrollment Qr context and functionality. +</ParamField> + +<ParamField body="toggleView" type="Function"> + Interface for the screen data specific to mfa-otp-enrollment-qr screen / export interface ScreenMembersOnMfaOtpEnrollmentQr extends ScreenMembers { data: { qr_code: string; } | null; } Interface for the payload of the continue method + + **Parameter:** Optional custom options to include with the request +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Interface for the screen data specific to mfa-otp-enrollment-qr screen / export interface ScreenMembersOnMfaOtpEnrollmentQr extends ScreenMembers { data: { qr_code: string; } | null; } Interface for the payload of the continue method + + **Parameter:** Optional custom options to include with the request +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-otp-enrollment-qr.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-challenge.mdx new file mode 100644 index 000000000..ea2fdb497 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-challenge.mdx @@ -0,0 +1,158 @@ +--- +title: "Mfa Phone Challenge" +description: "The Mfa Phone Challenge screen module provides access to the Mfa Phone Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaPhoneChallenge" type="MfaPhoneChallengeMembers"> + Provides access to the Mfa Phone Challenge context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="pickPhone" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-phone-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-enrollment.mdx new file mode 100644 index 000000000..ceb292615 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-enrollment.mdx @@ -0,0 +1,164 @@ +--- +title: "Mfa Phone Enrollment" +description: "The Mfa Phone Enrollment screen module provides access to the Mfa Phone Enrollment flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaPhoneEnrollment" type="MfaPhoneEnrollmentMembers"> + Provides access to the Mfa Phone Enrollment context and functionality. +</ParamField> + +<ParamField body="pickCountryCode" type="Function"> + Options for continuing with the MFA phone enrollment. Extends `CustomOptions` to allow passing custom options alongside phone and type. / export interface ContinueOptions extends CustomOptions { phone: string; type: 'sms' | 'voice'; } export interface MfaPhoneEnrollmentMembers extends BaseMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; Selects the country code for the phone number. + + **Parameter:** Optional custom options to include with the request. +</ParamField> + +<ParamField body="continueEnrollment" type="Function"> + Options for continuing with the MFA phone enrollment. Extends `CustomOptions` to allow passing custom options alongside phone and type. / export interface ContinueOptions extends CustomOptions { phone: string; type: 'sms' | 'voice'; } export interface MfaPhoneEnrollmentMembers extends BaseMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; Selects the country code for the phone number. + + **Parameter:** Optional custom options to include with the request. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Options for continuing with the MFA phone enrollment. Extends `CustomOptions` to allow passing custom options alongside phone and type. / export interface ContinueOptions extends CustomOptions { phone: string; type: 'sms' | 'voice'; } export interface MfaPhoneEnrollmentMembers extends BaseMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; Selects the country code for the phone number. + + **Parameter:** Optional custom options to include with the request. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-phone-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-challenge-push.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-challenge-push.mdx new file mode 100644 index 000000000..9ab8d250e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-challenge-push.mdx @@ -0,0 +1,168 @@ +--- +title: "Mfa Push Challenge Push" +description: "The Mfa Push Challenge Push screen module provides access to the Mfa Push Challenge Push flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaPushChallengePush" type="MfaPushChallengePushMembers"> + Provides access to the Mfa Push Challenge Push context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="resendPushNotification" type="Function"> + Interface for the screen data specific to mfa-push-challenge-push screen / export interface ScreenMembersOnMfaPushChallengePush extends ScreenMembers { data: { /** The name of the device receiving the push notification */ deviceName: string; /** Whether to show the remember device option */ showRememberDevice?: boolean; } | null; } Interface for untrusted data specific to mfa-push-challenge-push screen / export interface UntrustedDataMembersOnMfaPushChallengePush extends UntrustedDataMembers { submittedFormData: { rememberDevice: boolean; } | null; } export interface WithRememberOptions extends CustomOptions { rememberDevice?: boolean; } Interface defining the available methods and properties for the mfa-push-challenge-push screen / export interface MfaPushChallengePushMembers extends BaseMembers { screen: ScreenMembersOnMfaPushChallengePush; untrustedData: UntrustedDataMembersOnMfaPushChallengePush; Continues with the push notification challenge + + **Parameter:** Optional custom options to include with the request +</ParamField> + +<ParamField body="enterCodeManually" type="Function"> + Interface for the screen data specific to mfa-push-challenge-push screen / export interface ScreenMembersOnMfaPushChallengePush extends ScreenMembers { data: { /** The name of the device receiving the push notification */ deviceName: string; /** Whether to show the remember device option */ showRememberDevice?: boolean; } | null; } Interface for untrusted data specific to mfa-push-challenge-push screen / export interface UntrustedDataMembersOnMfaPushChallengePush extends UntrustedDataMembers { submittedFormData: { rememberDevice: boolean; } | null; } export interface WithRememberOptions extends CustomOptions { rememberDevice?: boolean; } Interface defining the available methods and properties for the mfa-push-challenge-push screen / export interface MfaPushChallengePushMembers extends BaseMembers { screen: ScreenMembersOnMfaPushChallengePush; untrustedData: UntrustedDataMembersOnMfaPushChallengePush; Continues with the push notification challenge + + **Parameter:** Optional custom options to include with the request +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Interface for the screen data specific to mfa-push-challenge-push screen / export interface ScreenMembersOnMfaPushChallengePush extends ScreenMembers { data: { /** The name of the device receiving the push notification */ deviceName: string; /** Whether to show the remember device option */ showRememberDevice?: boolean; } | null; } Interface for untrusted data specific to mfa-push-challenge-push screen / export interface UntrustedDataMembersOnMfaPushChallengePush extends UntrustedDataMembers { submittedFormData: { rememberDevice: boolean; } | null; } export interface WithRememberOptions extends CustomOptions { rememberDevice?: boolean; } Interface defining the available methods and properties for the mfa-push-challenge-push screen / export interface MfaPushChallengePushMembers extends BaseMembers { screen: ScreenMembersOnMfaPushChallengePush; untrustedData: UntrustedDataMembersOnMfaPushChallengePush; Continues with the push notification challenge + + **Parameter:** Optional custom options to include with the request +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-push-challenge-push.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-enrollment-qr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-enrollment-qr.mdx new file mode 100644 index 000000000..45cd9121f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-enrollment-qr.mdx @@ -0,0 +1,152 @@ +--- +title: "Mfa Push Enrollment Qr" +description: "The Mfa Push Enrollment Qr screen module provides access to the Mfa Push Enrollment Qr flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaPushEnrollmentQr" type="MfaPushEnrollmentQrMembers"> + Provides access to the Mfa Push Enrollment Qr context and functionality. +</ParamField> + +<ParamField body="pickAuthenticator" type="Function"> + Interface for the screen data specific to mfa-push-enrollment-qr screen / export interface ScreenMembersOnMfaPushEnrollmentQr extends ScreenMembers { data: { qrCode: string; qrUri: string; showCodeCopy: boolean; } | null; } Interface defining the available methods and properties for the mfa-push-enrollment-qr screen / export interface MfaPushEnrollmentQrMembers extends BaseMembers { screen: ScreenMembersOnMfaPushEnrollmentQr; Navigates to the authenticator selection screen. + + **Parameter:** Optional custom options to include with the request +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-push-enrollment-qr.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-list.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-list.mdx new file mode 100644 index 000000000..48a0747d2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-list.mdx @@ -0,0 +1,158 @@ +--- +title: "Mfa Push List" +description: "The Mfa Push List screen module provides access to the Mfa Push List flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaPushList" type="MfaPushListMembers"> + Provides access to the Mfa Push List context and functionality. +</ParamField> + +<ParamField body="selectMfaPushDevice" type="Function"> + Options for selecting an MFA push device. / export interface SelectMfaPushDeviceOptions { The index of the device to select from the list of enrolled devices. The index is 0-based. / deviceIndex: number; [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-push-list screen / export interface MfaPushListMembers extends BaseMembers { Selects a registered device from the list to initiate MFA push. + + **Parameter:** The options containing the device index. +</ParamField> + +<ParamField body="goBack" type="Function"> + Options for selecting an MFA push device. / export interface SelectMfaPushDeviceOptions { The index of the device to select from the list of enrolled devices. The index is 0-based. / deviceIndex: number; [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-push-list screen / export interface MfaPushListMembers extends BaseMembers { Selects a registered device from the list to initiate MFA push. + + **Parameter:** The options containing the device index. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-push-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-welcome.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-welcome.mdx new file mode 100644 index 000000000..7b4c62a61 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-welcome.mdx @@ -0,0 +1,154 @@ +--- +title: "Mfa Push Welcome" +description: "The Mfa Push Welcome screen module provides access to the Mfa Push Welcome flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaPushWelcome" type="MfaPushWelcomeMembers"> + Provides access to the Mfa Push Welcome context and functionality. +</ParamField> + +<ParamField body="enroll" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="pickAuthenticator" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-push-welcome.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge-new-code.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge-new-code.mdx new file mode 100644 index 000000000..d4f81e7d6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge-new-code.mdx @@ -0,0 +1,150 @@ +--- +title: "Mfa Recovery Code Challenge New Code" +description: "The Mfa Recovery Code Challenge New Code screen module provides access to the Mfa Recovery Code Challenge New Code flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaRecoveryCodeChallengeNewCode" type="MfaRecoveryCodeChallengeNewCodeMembers"> + Provides access to the Mfa Recovery Code Challenge New Code context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-recovery-code-challenge-new-code.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge.mdx new file mode 100644 index 000000000..ba0f6655c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge.mdx @@ -0,0 +1,156 @@ +--- +title: "Mfa Recovery Code Challenge" +description: "The Mfa Recovery Code Challenge screen module provides access to the Mfa Recovery Code Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaRecoveryCodeChallenge" type="MfaRecoveryCodeChallengeMembers"> + Provides access to the Mfa Recovery Code Challenge context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Options for continuing with the MFA Recovery Code Challenge. / export interface ContinueOptions extends CustomOptions { code: string; } Interface describing the members of the Mfa Recovery Code Challenge screen. / export interface MfaRecoveryCodeChallengeMembers extends BaseMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; Continues with the provided recovery code. + + **Parameter:** - The continue options containing the recovery code and optional custom options. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-recovery-code-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-enrollment.mdx new file mode 100644 index 000000000..a5e3525dc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-enrollment.mdx @@ -0,0 +1,150 @@ +--- +title: "Mfa Recovery Code Enrollment" +description: "The Mfa Recovery Code Enrollment screen module provides access to the Mfa Recovery Code Enrollment flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaRecoveryCodeEnrollment" type="MfaRecoveryCodeEnrollmentMembers"> + Provides access to the Mfa Recovery Code Enrollment context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-recovery-code-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-challenge.mdx new file mode 100644 index 000000000..338fda045 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-challenge.mdx @@ -0,0 +1,166 @@ +--- +title: "Mfa Sms Challenge" +description: "The Mfa Sms Challenge screen module provides access to the Mfa Sms Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaSmsChallenge" type="MfaSmsChallengeMembers"> + Provides access to the Mfa Sms Challenge context and functionality. +</ParamField> + +<ParamField body="continueMfaSmsChallenge" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="pickSms" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="resendCode" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="getACall" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-sms-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-enrollment.mdx new file mode 100644 index 000000000..b7944c131 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-enrollment.mdx @@ -0,0 +1,158 @@ +--- +title: "Mfa Sms Enrollment" +description: "The Mfa Sms Enrollment screen module provides access to the Mfa Sms Enrollment flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaSmsEnrollment" type="MfaSmsEnrollmentMembers"> + Provides access to the Mfa Sms Enrollment context and functionality. +</ParamField> + +<ParamField body="pickCountryCode" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="continueEnrollment" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-sms-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-list.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-list.mdx new file mode 100644 index 000000000..81e981328 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-list.mdx @@ -0,0 +1,154 @@ +--- +title: "Mfa Sms List" +description: "The Mfa Sms List screen module provides access to the Mfa Sms List flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaSmsList" type="MfaSmsListMembers"> + Provides access to the Mfa Sms List context and functionality. +</ParamField> + +<ParamField body="selectPhoneNumber" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="backAction" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-sms-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-challenge.mdx new file mode 100644 index 000000000..297b64a92 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-challenge.mdx @@ -0,0 +1,174 @@ +--- +title: "Mfa Voice Challenge" +description: "The Mfa Voice Challenge screen module provides access to the Mfa Voice Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaVoiceChallenge" type="MfaVoiceChallengeMembers"> + Provides access to the Mfa Voice Challenge context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="pickPhone" type="Function"> + Options for submitting the voice challenge code. / export interface MfaVoiceChallengeContinueOptions { The verification code received via voice call. / code: string; Optional flag to remember the device for 30 days, skipping future MFA challenges. / rememberDevice?: boolean; Additional custom options to pass with the request. / [key: string]: string | number | boolean | undefined; } Extended screen members interface for the MFA Voice Challenge screen. / export interface ScreenMembersOnMfaVoiceChallenge extends ScreenMembers { Additional screen data specific to MFA voice challenge. / data: { The phone number where the voice code was sent. / phoneNumber?: string; Whether to show the remember device option. / showRememberDevice?: boolean; Whether to show the link to switch to SMS verification. / showLinkSms?: boolean; } | null; } Interface defining all members and operations available on the MFA Voice Challenge screen. / export interface MfaVoiceChallengeMembers extends BaseMembers { Screen-specific properties and data. / screen: ScreenMembersOnMfaVoiceChallenge; untrustedData: UntrustedDataMembersOnMfaVoiceChallenge; Submits the voice verification code to validate the MFA challenge. + + **Parameter:** - Object containing the verification code and optional parameters +</ParamField> + +<ParamField body="switchToSms" type="Function"> + Options for submitting the voice challenge code. / export interface MfaVoiceChallengeContinueOptions { The verification code received via voice call. / code: string; Optional flag to remember the device for 30 days, skipping future MFA challenges. / rememberDevice?: boolean; Additional custom options to pass with the request. / [key: string]: string | number | boolean | undefined; } Extended screen members interface for the MFA Voice Challenge screen. / export interface ScreenMembersOnMfaVoiceChallenge extends ScreenMembers { Additional screen data specific to MFA voice challenge. / data: { The phone number where the voice code was sent. / phoneNumber?: string; Whether to show the remember device option. / showRememberDevice?: boolean; Whether to show the link to switch to SMS verification. / showLinkSms?: boolean; } | null; } Interface defining all members and operations available on the MFA Voice Challenge screen. / export interface MfaVoiceChallengeMembers extends BaseMembers { Screen-specific properties and data. / screen: ScreenMembersOnMfaVoiceChallenge; untrustedData: UntrustedDataMembersOnMfaVoiceChallenge; Submits the voice verification code to validate the MFA challenge. + + **Parameter:** - Object containing the verification code and optional parameters +</ParamField> + +<ParamField body="resendCode" type="Function"> + Options for submitting the voice challenge code. / export interface MfaVoiceChallengeContinueOptions { The verification code received via voice call. / code: string; Optional flag to remember the device for 30 days, skipping future MFA challenges. / rememberDevice?: boolean; Additional custom options to pass with the request. / [key: string]: string | number | boolean | undefined; } Extended screen members interface for the MFA Voice Challenge screen. / export interface ScreenMembersOnMfaVoiceChallenge extends ScreenMembers { Additional screen data specific to MFA voice challenge. / data: { The phone number where the voice code was sent. / phoneNumber?: string; Whether to show the remember device option. / showRememberDevice?: boolean; Whether to show the link to switch to SMS verification. / showLinkSms?: boolean; } | null; } Interface defining all members and operations available on the MFA Voice Challenge screen. / export interface MfaVoiceChallengeMembers extends BaseMembers { Screen-specific properties and data. / screen: ScreenMembersOnMfaVoiceChallenge; untrustedData: UntrustedDataMembersOnMfaVoiceChallenge; Submits the voice verification code to validate the MFA challenge. + + **Parameter:** - Object containing the verification code and optional parameters +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Options for submitting the voice challenge code. / export interface MfaVoiceChallengeContinueOptions { The verification code received via voice call. / code: string; Optional flag to remember the device for 30 days, skipping future MFA challenges. / rememberDevice?: boolean; Additional custom options to pass with the request. / [key: string]: string | number | boolean | undefined; } Extended screen members interface for the MFA Voice Challenge screen. / export interface ScreenMembersOnMfaVoiceChallenge extends ScreenMembers { Additional screen data specific to MFA voice challenge. / data: { The phone number where the voice code was sent. / phoneNumber?: string; Whether to show the remember device option. / showRememberDevice?: boolean; Whether to show the link to switch to SMS verification. / showLinkSms?: boolean; } | null; } Interface defining all members and operations available on the MFA Voice Challenge screen. / export interface MfaVoiceChallengeMembers extends BaseMembers { Screen-specific properties and data. / screen: ScreenMembersOnMfaVoiceChallenge; untrustedData: UntrustedDataMembersOnMfaVoiceChallenge; Submits the voice verification code to validate the MFA challenge. + + **Parameter:** - Object containing the verification code and optional parameters +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-enrollment.mdx new file mode 100644 index 000000000..445ed4a2e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-enrollment.mdx @@ -0,0 +1,162 @@ +--- +title: "Mfa Voice Enrollment" +description: "The Mfa Voice Enrollment screen module provides access to the Mfa Voice Enrollment flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaVoiceEnrollment" type="MfaVoiceEnrollmentMembers"> + Provides access to the Mfa Voice Enrollment context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Payload for continuing the MFA Voice Enrollment flow. / export interface ContinueOptions extends CustomOptions { phone: string; } Interface describing the members of the Mfa Voice Enrollment screen. / export interface MfaVoiceEnrollmentMembers extends BaseMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; Continues with the voice enrollment process. + + **Parameter:** - The phone number and optional custom options. +</ParamField> + +<ParamField body="selectPhoneCountryCode" type="Function"> + Payload for continuing the MFA Voice Enrollment flow. / export interface ContinueOptions extends CustomOptions { phone: string; } Interface describing the members of the Mfa Voice Enrollment screen. / export interface MfaVoiceEnrollmentMembers extends BaseMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; Continues with the voice enrollment process. + + **Parameter:** - The phone number and optional custom options. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-voice-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-change-key-nickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-change-key-nickname.mdx new file mode 100644 index 000000000..2c1f0feda --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-change-key-nickname.mdx @@ -0,0 +1,150 @@ +--- +title: "Mfa Webauthn Change Key Nickname" +description: "The Mfa Webauthn Change Key Nickname screen module provides access to the Mfa Webauthn Change Key Nickname flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaWebAuthnChangeKeyNickname" type="MfaWebAuthnChangeKeyNicknameMembers"> + Provides access to the Mfa Webauthn Change Key Nickname context and functionality. +</ParamField> + +<ParamField body="continueWithNewNickname" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-webauthn-change-key-nickname.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-enrollment-success.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-enrollment-success.mdx new file mode 100644 index 000000000..34eef7402 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-enrollment-success.mdx @@ -0,0 +1,150 @@ +--- +title: "Mfa Webauthn Enrollment Success" +description: "The Mfa Webauthn Enrollment Success screen module provides access to the Mfa Webauthn Enrollment Success flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaWebAuthnEnrollmentSuccess" type="MfaWebAuthnEnrollmentSuccessMembers"> + Provides access to the Mfa Webauthn Enrollment Success context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-webauthn-enrollment-success.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-error.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-error.mdx new file mode 100644 index 000000000..f2559e4ef --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-error.mdx @@ -0,0 +1,158 @@ +--- +title: "Mfa Webauthn Error" +description: "The Mfa Webauthn Error screen module provides access to the Mfa Webauthn Error flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaWebAuthnError" type="MfaWebAuthnErrorMembers"> + Provides access to the Mfa Webauthn Error context and functionality. +</ParamField> + +<ParamField body="tryAgain" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="noThanks" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-webauthn-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-not-available-error.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-not-available-error.mdx new file mode 100644 index 000000000..c6b3343aa --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-not-available-error.mdx @@ -0,0 +1,150 @@ +--- +title: "Mfa Webauthn Not Available Error" +description: "The Mfa Webauthn Not Available Error screen module provides access to the Mfa Webauthn Not Available Error flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaWebAuthnNotAvailableError" type="MfaWebAuthnNotAvailableErrorMembers"> + Provides access to the Mfa Webauthn Not Available Error context and functionality. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-webauthn-not-available-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-challenge.mdx new file mode 100644 index 000000000..e19d6d373 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-challenge.mdx @@ -0,0 +1,158 @@ +--- +title: "Mfa Webauthn Platform Challenge" +description: "The Mfa Webauthn Platform Challenge screen module provides access to the Mfa Webauthn Platform Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaWebAuthnPlatformChallenge" type="MfaWebAuthnPlatformChallengeMembers"> + Provides access to the Mfa Webauthn Platform Challenge context and functionality. +</ParamField> + +<ParamField body="verify" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="reportBrowserError" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-webauthn-platform-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-enrollment.mdx new file mode 100644 index 000000000..fb19b295c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-enrollment.mdx @@ -0,0 +1,162 @@ +--- +title: "Mfa Webauthn Platform Enrollment" +description: "The Mfa Webauthn Platform Enrollment screen module provides access to the Mfa Webauthn Platform Enrollment flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaWebAuthnPlatformEnrollment" type="MfaWebAuthnPlatformEnrollmentMembers"> + Provides access to the Mfa Webauthn Platform Enrollment context and functionality. +</ParamField> + +<ParamField body="submitPasskeyCredential" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="reportBrowserError" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="snoozeEnrollment" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="refuseEnrollmentOnThisDevice" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-webauthn-platform-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-challenge.mdx new file mode 100644 index 000000000..8e667210b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-challenge.mdx @@ -0,0 +1,158 @@ +--- +title: "Mfa Webauthn Roaming Challenge" +description: "The Mfa Webauthn Roaming Challenge screen module provides access to the Mfa Webauthn Roaming Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaWebAuthnRoamingChallenge" type="MfaWebAuthnRoamingChallengeMembers"> + Provides access to the Mfa Webauthn Roaming Challenge context and functionality. +</ParamField> + +<ParamField body="verify" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="reportWebAuthnError" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-enrollment.mdx new file mode 100644 index 000000000..9ad21a4ca --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-enrollment.mdx @@ -0,0 +1,164 @@ +--- +title: "Mfa Webauthn Roaming Enrollment" +description: "The Mfa Webauthn Roaming Enrollment screen module provides access to the Mfa Webauthn Roaming Enrollment flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useMfaWebAuthnRoamingEnrollment" type="MfaWebAuthnRoamingEnrollmentMembers"> + Provides access to the Mfa Webauthn Roaming Enrollment context and functionality. +</ParamField> + +<ParamField body="enroll" type="Function"> + Interface for screen data specific to mfa-webauthn-roaming-enrollment screen. / export interface ScreenMembersOnMfaWebAuthnRoamingEnrollment extends ScreenMembers { webauthnType: string | null; publicKey: PasskeyCreate['public_key'] | null; } Options for submitting a WebAuthn browser error. / export interface ShowErrorOptions { The details of the WebAuthn error. / error: WebAuthnErrorDetails; Any additional custom options. / [key: string]: string | number | boolean | undefined | WebAuthnErrorDetails; } Options for trying another MFA method. / export interface TryAnotherMethodOptions { Any additional custom options. / [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-webauthn-roaming-enrollment screen. / export interface MfaWebAuthnRoamingEnrollmentMembers extends BaseMembers { screen: ScreenMembersOnMfaWebAuthnRoamingEnrollment; Initiates the WebAuthn credential creation and submits the result to the server. This corresponds to the user interacting with the FIDO Security Keys prompt. + + **Parameter:** Optional custom options to include with the request. +</ParamField> + +<ParamField body="showError" type="Function"> + Interface for screen data specific to mfa-webauthn-roaming-enrollment screen. / export interface ScreenMembersOnMfaWebAuthnRoamingEnrollment extends ScreenMembers { webauthnType: string | null; publicKey: PasskeyCreate['public_key'] | null; } Options for submitting a WebAuthn browser error. / export interface ShowErrorOptions { The details of the WebAuthn error. / error: WebAuthnErrorDetails; Any additional custom options. / [key: string]: string | number | boolean | undefined | WebAuthnErrorDetails; } Options for trying another MFA method. / export interface TryAnotherMethodOptions { Any additional custom options. / [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-webauthn-roaming-enrollment screen. / export interface MfaWebAuthnRoamingEnrollmentMembers extends BaseMembers { screen: ScreenMembersOnMfaWebAuthnRoamingEnrollment; Initiates the WebAuthn credential creation and submits the result to the server. This corresponds to the user interacting with the FIDO Security Keys prompt. + + **Parameter:** Optional custom options to include with the request. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Interface for screen data specific to mfa-webauthn-roaming-enrollment screen. / export interface ScreenMembersOnMfaWebAuthnRoamingEnrollment extends ScreenMembers { webauthnType: string | null; publicKey: PasskeyCreate['public_key'] | null; } Options for submitting a WebAuthn browser error. / export interface ShowErrorOptions { The details of the WebAuthn error. / error: WebAuthnErrorDetails; Any additional custom options. / [key: string]: string | number | boolean | undefined | WebAuthnErrorDetails; } Options for trying another MFA method. / export interface TryAnotherMethodOptions { Any additional custom options. / [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-webauthn-roaming-enrollment screen. / export interface MfaWebAuthnRoamingEnrollmentMembers extends BaseMembers { screen: ScreenMembersOnMfaWebAuthnRoamingEnrollment; Initiates the WebAuthn credential creation and submits the result to the server. This corresponds to the user interacting with the FIDO Security Keys prompt. + + **Parameter:** Optional custom options to include with the request. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/mfa-webauthn-roaming-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-picker.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-picker.mdx new file mode 100644 index 000000000..2b55aa3fb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-picker.mdx @@ -0,0 +1,158 @@ +--- +title: "Organization Picker" +description: "The Organization Picker screen module provides access to the Organization Picker flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useOrganizationPicker" type="OrganizationPickerMembers"> + Provides access to the Organization Picker context and functionality. +</ParamField> + +<ParamField body="selectOrganization" type="Function"> + Interface defining the available methods and properties for the organization-picker screen / export interface OrganizationPickerMembers extends BaseMembers { Selects an organization for the user. + + **Parameter:** The options containing the organization ID. +</ParamField> + +<ParamField body="skipOrganizationSelection" type="Function"> + Interface defining the available methods and properties for the organization-picker screen / export interface OrganizationPickerMembers extends BaseMembers { Selects an organization for the user. + + **Parameter:** The options containing the organization ID. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/organization-picker.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/organization-picker.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-selection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-selection.mdx new file mode 100644 index 000000000..016583803 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-selection.mdx @@ -0,0 +1,152 @@ +--- +title: "Organization Selection" +description: "The Organization Selection screen module provides access to the Organization Selection flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useOrganizationSelection" type="OrganizationSelectionMembers"> + Provides access to the Organization Selection context and functionality. +</ParamField> + +<ParamField body="continueWithOrganizationName" type="Function"> + Options for continuing with the selected organization name. / export interface ContinueWithOrganizationNameOptions { The organization name. / organizationName: string; Any additional custom options. / [key: string]: string | number | boolean | undefined; } Interface for the screen data specific to organization-selection screen. / export interface ScreenMembersOnOrganizationSelection extends ScreenMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; User: UserMembers; } Interface defining the available methods and properties for the organization-selection screen. / export interface OrganizationSelectionMembers extends BaseMembers { The screen properties. / screen: ScreenMembersOnOrganizationSelection; Continues with the selected organization name. + + **Parameter:** The options containing the organization name. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/organization-selection.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/organization-selection.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment-local.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment-local.mdx new file mode 100644 index 000000000..0a5ef39a7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment-local.mdx @@ -0,0 +1,154 @@ +--- +title: "Passkey Enrollment Local" +description: "The Passkey Enrollment Local screen module provides access to the Passkey Enrollment Local flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="usePasskeyEnrollmentLocal" type="PasskeyEnrollmentLocalMembers"> + Provides access to the Passkey Enrollment Local context and functionality. +</ParamField> + +<ParamField body="continuePasskeyEnrollment" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="abortPasskeyEnrollment" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/passkey-enrollment-local.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment.mdx new file mode 100644 index 000000000..0d75aed7f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment.mdx @@ -0,0 +1,154 @@ +--- +title: "Passkey Enrollment" +description: "The Passkey Enrollment screen module provides access to the Passkey Enrollment flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="usePasskeyEnrollment" type="PasskeyEnrollmentMembers"> + Provides access to the Passkey Enrollment context and functionality. +</ParamField> + +<ParamField body="continuePasskeyEnrollment" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="abortPasskeyEnrollment" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/passkey-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-challenge.mdx new file mode 100644 index 000000000..5c8a050b2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-challenge.mdx @@ -0,0 +1,166 @@ +--- +title: "Phone Identifier Challenge" +description: "The Phone Identifier Challenge screen module provides access to the Phone Identifier Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="usePhoneIdentifierChallenge" type="PhoneIdentifierChallengeMembers"> + Provides access to the Phone Identifier Challenge context and functionality. +</ParamField> + +<ParamField body="submitPhoneChallenge" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="resendCode" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="returnToPrevious" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="switchToVoice" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="switchToText" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/phone-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-enrollment.mdx new file mode 100644 index 000000000..fab846ccc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-enrollment.mdx @@ -0,0 +1,154 @@ +--- +title: "Phone Identifier Enrollment" +description: "The Phone Identifier Enrollment screen module provides access to the Phone Identifier Enrollment flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="usePhoneIdentifierEnrollment" type="PhoneIdentifierEnrollmentMembers"> + Provides access to the Phone Identifier Enrollment context and functionality. +</ParamField> + +<ParamField body="continuePhoneEnrollment" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="returnToPrevious" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/phone-identifier-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/redeem-ticket.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/redeem-ticket.mdx new file mode 100644 index 000000000..d056b52e6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/redeem-ticket.mdx @@ -0,0 +1,150 @@ +--- +title: "Redeem Ticket" +description: "The Redeem Ticket screen module provides access to the Redeem Ticket flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useRedeemTicket" type="RedeemTicketMembers"> + Provides access to the Redeem Ticket context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/redeem-ticket.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/redeem-ticket.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-email.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-email.mdx new file mode 100644 index 000000000..249ac29ff --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-email.mdx @@ -0,0 +1,150 @@ +--- +title: "Reset Password Email" +description: "The Reset Password Email screen module provides access to the Reset Password Email flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useResetPasswordEmail" type="ResetPasswordEmailMembers"> + Provides access to the Reset Password Email context and functionality. +</ParamField> + +<ParamField body="resendEmail" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/reset-password-email.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-email.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-error.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-error.mdx new file mode 100644 index 000000000..4bd145cdd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-error.mdx @@ -0,0 +1,146 @@ +--- +title: "Reset Password Error" +description: "The Reset Password Error screen module provides access to the Reset Password Error flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useResetPasswordError" type="ResetPasswordErrorMembers"> + Provides access to the Reset Password Error context and functionality. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/reset-password-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-email-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-email-challenge.mdx new file mode 100644 index 000000000..4e55b011b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-email-challenge.mdx @@ -0,0 +1,162 @@ +--- +title: "Reset Password Mfa Email Challenge" +description: "The Reset Password Mfa Email Challenge screen module provides access to the Reset Password Mfa Email Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useResetPasswordMfaEmailChallenge" type="ResetPasswordMfaEmailChallengeMembers"> + Provides access to the Reset Password Mfa Email Challenge context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="resendCode" type="Function"> + Interface for the screen data specific to reset-password-mfa-email-challenge screen / export interface ScreenMembersOnResetPasswordMfaEmailChallenge extends ScreenMembers { data: { email: string; } | null; } Options for continuing with the email challenge. / export interface ContinueOptions { /** The code entered by the user. */ code: string; /** Indicates whether to remember the device. */ rememberDevice?: boolean; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for resending the email code. / export interface ResendCodeOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for trying another method. / export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the reset-password-mfa-email-challenge screen / export interface ResetPasswordMfaEmailChallengeMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaEmailChallenge; Continues with the email challenge using the provided code. + + **Parameter:** The options containing the code and rememberDevice flag. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Interface for the screen data specific to reset-password-mfa-email-challenge screen / export interface ScreenMembersOnResetPasswordMfaEmailChallenge extends ScreenMembers { data: { email: string; } | null; } Options for continuing with the email challenge. / export interface ContinueOptions { /** The code entered by the user. */ code: string; /** Indicates whether to remember the device. */ rememberDevice?: boolean; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for resending the email code. / export interface ResendCodeOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for trying another method. / export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the reset-password-mfa-email-challenge screen / export interface ResetPasswordMfaEmailChallengeMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaEmailChallenge; Continues with the email challenge using the provided code. + + **Parameter:** The options containing the code and rememberDevice flag. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/reset-password-mfa-email-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-otp-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-otp-challenge.mdx new file mode 100644 index 000000000..60982e380 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-otp-challenge.mdx @@ -0,0 +1,156 @@ +--- +title: "Reset Password Mfa Otp Challenge" +description: "The Reset Password Mfa Otp Challenge screen module provides access to the Reset Password Mfa Otp Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useResetPasswordMfaOtpChallenge" type="ResetPasswordMfaOtpChallengeMembers"> + Provides access to the Reset Password Mfa Otp Challenge context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Options for continuing with the OTP challenge. / export interface ContinueOptions { /** The code entered by the user. */ code: string; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for trying another method. / export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the reset-password-mfa-otp-challenge screen / export interface ResetPasswordMfaOtpChallengeMembers extends BaseMembers { Continues with the OTP challenge using the provided code. + + **Parameter:** The options containing the code. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/reset-password-mfa-otp-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-phone-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-phone-challenge.mdx new file mode 100644 index 000000000..700ca21d9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-phone-challenge.mdx @@ -0,0 +1,154 @@ +--- +title: "Reset Password Mfa Phone Challenge" +description: "The Reset Password Mfa Phone Challenge screen module provides access to the Reset Password Mfa Phone Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useResetPasswordMfaPhoneChallenge" type="ResetPasswordMfaPhoneChallengeMembers"> + Provides access to the Reset Password Mfa Phone Challenge context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/reset-password-mfa-phone-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-push-challenge-push.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-push-challenge-push.mdx new file mode 100644 index 000000000..94f0eaab0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-push-challenge-push.mdx @@ -0,0 +1,168 @@ +--- +title: "Reset Password Mfa Push Challenge Push" +description: "The Reset Password Mfa Push Challenge Push screen module provides access to the Reset Password Mfa Push Challenge Push flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useResetPasswordMfaPushChallengePush" type="ResetPasswordMfaPushChallengePushMembers"> + Provides access to the Reset Password Mfa Push Challenge Push context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="resendPushNotification" type="Function"> + Interface for the screen data specific to reset-password-mfa-push-challenge-push screen / export interface ScreenMembersOnResetPasswordMfaPushChallengePush extends ScreenMembers { data: { deviceName: string; rememberDevice?: boolean; } | null; } Interface defining the available methods and properties for the reset-password-mfa-push-challenge-push screen / export interface ResetPasswordMfaPushChallengePushMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaPushChallengePush; Continues with the push notification challenge + + **Parameter:** Optional custom options to include with the request +</ParamField> + +<ParamField body="enterCodeManually" type="Function"> + Interface for the screen data specific to reset-password-mfa-push-challenge-push screen / export interface ScreenMembersOnResetPasswordMfaPushChallengePush extends ScreenMembers { data: { deviceName: string; rememberDevice?: boolean; } | null; } Interface defining the available methods and properties for the reset-password-mfa-push-challenge-push screen / export interface ResetPasswordMfaPushChallengePushMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaPushChallengePush; Continues with the push notification challenge + + **Parameter:** Optional custom options to include with the request +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Interface for the screen data specific to reset-password-mfa-push-challenge-push screen / export interface ScreenMembersOnResetPasswordMfaPushChallengePush extends ScreenMembers { data: { deviceName: string; rememberDevice?: boolean; } | null; } Interface defining the available methods and properties for the reset-password-mfa-push-challenge-push screen / export interface ResetPasswordMfaPushChallengePushMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaPushChallengePush; Continues with the push notification challenge + + **Parameter:** Optional custom options to include with the request +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/reset-password-mfa-push-challenge-push.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-recovery-code-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-recovery-code-challenge.mdx new file mode 100644 index 000000000..d6d95a48d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-recovery-code-challenge.mdx @@ -0,0 +1,154 @@ +--- +title: "Reset Password Mfa Recovery Code Challenge" +description: "The Reset Password Mfa Recovery Code Challenge screen module provides access to the Reset Password Mfa Recovery Code Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useResetPasswordMfaRecoveryCodeChallenge" type="ResetPasswordMfaRecoveryCodeChallengeMembers"> + Provides access to the Reset Password Mfa Recovery Code Challenge context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Interface describing the members of the Mfa Recovery Code Challenge screen. / export interface ResetPasswordMfaRecoveryCodeChallengeMembers extends BaseMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; Continues with the provided recovery code. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/reset-password-mfa-recovery-code-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-sms-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-sms-challenge.mdx new file mode 100644 index 000000000..f0a62610c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-sms-challenge.mdx @@ -0,0 +1,162 @@ +--- +title: "Reset Password Mfa Sms Challenge" +description: "The Reset Password Mfa Sms Challenge screen module provides access to the Reset Password Mfa Sms Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useResetPasswordMfaSmsChallenge" type="ResetPasswordMfaSmsChallengeMembers"> + Provides access to the Reset Password Mfa Sms Challenge context and functionality. +</ParamField> + +<ParamField body="continueMfaSmsChallenge" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="resendCode" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="getACall" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/reset-password-mfa-sms-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-voice-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-voice-challenge.mdx new file mode 100644 index 000000000..c143db252 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-voice-challenge.mdx @@ -0,0 +1,168 @@ +--- +title: "Reset Password Mfa Voice Challenge" +description: "The Reset Password Mfa Voice Challenge screen module provides access to the Reset Password Mfa Voice Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useResetPasswordMfaVoiceChallenge" type="ResetPasswordMfaVoiceChallengeMembers"> + Provides access to the Reset Password Mfa Voice Challenge context and functionality. +</ParamField> + +<ParamField body="continueMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="switchToSms" type="Function"> + Interface for the screen data specific to reset-password-mfa-voice-challenge screen. / export interface ScreenMembersOnResetPasswordMfaVoiceChallenge extends ScreenMembers { data: { The phone number to send the voice call to. / phoneNumber: string; Whether to show the link to switch to SMS verification. / showLinkSms?: boolean; } | null; } Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers. / export interface ContinueOptions extends CustomOptions { The OTP code entered by the user. / code: string; } Interface defining the available methods and properties for the reset-password-mfa-voice-challenge screen. / export interface ResetPasswordMfaVoiceChallengeMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaVoiceChallenge; Continues with the voice challenge using the provided code. + + **Parameter:** - The options containing the code. +</ParamField> + +<ParamField body="resendCode" type="Function"> + Interface for the screen data specific to reset-password-mfa-voice-challenge screen. / export interface ScreenMembersOnResetPasswordMfaVoiceChallenge extends ScreenMembers { data: { The phone number to send the voice call to. / phoneNumber: string; Whether to show the link to switch to SMS verification. / showLinkSms?: boolean; } | null; } Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers. / export interface ContinueOptions extends CustomOptions { The OTP code entered by the user. / code: string; } Interface defining the available methods and properties for the reset-password-mfa-voice-challenge screen. / export interface ResetPasswordMfaVoiceChallengeMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaVoiceChallenge; Continues with the voice challenge using the provided code. + + **Parameter:** - The options containing the code. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Interface for the screen data specific to reset-password-mfa-voice-challenge screen. / export interface ScreenMembersOnResetPasswordMfaVoiceChallenge extends ScreenMembers { data: { The phone number to send the voice call to. / phoneNumber: string; Whether to show the link to switch to SMS verification. / showLinkSms?: boolean; } | null; } Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers. / export interface ContinueOptions extends CustomOptions { The OTP code entered by the user. / code: string; } Interface defining the available methods and properties for the reset-password-mfa-voice-challenge screen. / export interface ResetPasswordMfaVoiceChallengeMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaVoiceChallenge; Continues with the voice challenge using the provided code. + + **Parameter:** - The options containing the code. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/reset-password-mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-platform-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-platform-challenge.mdx new file mode 100644 index 000000000..11dc2303b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-platform-challenge.mdx @@ -0,0 +1,158 @@ +--- +title: "Reset Password Mfa Webauthn Platform Challenge" +description: "The Reset Password Mfa Webauthn Platform Challenge screen module provides access to the Reset Password Mfa Webauthn Platform Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useResetPasswordMfaWebAuthnPlatformChallenge" type="ResetPasswordMfaWebAuthnPlatformChallengeMembers"> + Provides access to the Reset Password Mfa Webauthn Platform Challenge context and functionality. +</ParamField> + +<ParamField body="continueWithPasskey" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="reportBrowserError" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/reset-password-mfa-webauthn-platform-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-roaming-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-roaming-challenge.mdx new file mode 100644 index 000000000..61f7477e7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-roaming-challenge.mdx @@ -0,0 +1,154 @@ +--- +title: "Reset Password Mfa Webauthn Roaming Challenge" +description: "The Reset Password Mfa Webauthn Roaming Challenge screen module provides access to the Reset Password Mfa Webauthn Roaming Challenge flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useResetPasswordMfaWebAuthnRoamingChallenge" type="ResetPasswordMfaWebAuthnRoamingChallengeMembers"> + Provides access to the Reset Password Mfa Webauthn Roaming Challenge context and functionality. +</ParamField> + +<ParamField body="showError" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="tryAnotherMethod" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-request.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-request.mdx new file mode 100644 index 000000000..6c7b1d50e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-request.mdx @@ -0,0 +1,154 @@ +--- +title: "Reset Password Request" +description: "The Reset Password Request screen module provides access to the Reset Password Request flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useResetPasswordRequest" type="ResetPasswordRequestMembers"> + Provides access to the Reset Password Request context and functionality. +</ParamField> + +<ParamField body="resetPassword" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="backToLogin" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/reset-password-request.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-request.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-success.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-success.mdx new file mode 100644 index 000000000..d02568ecb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-success.mdx @@ -0,0 +1,146 @@ +--- +title: "Reset Password Success" +description: "The Reset Password Success screen module provides access to the Reset Password Success flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useResetPasswordSuccess" type="ResetPasswordSuccessMembers"> + Provides access to the Reset Password Success context and functionality. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/reset-password-success.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-success.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password.mdx new file mode 100644 index 000000000..a7295bdd9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password.mdx @@ -0,0 +1,150 @@ +--- +title: "Reset Password" +description: "The Reset Password screen module provides access to the Reset Password flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useResetPassword" type="ResetPasswordMembers"> + Provides access to the Reset Password context and functionality. +</ParamField> + +<ParamField body="resetPassword" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/reset-password.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-id.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-id.mdx new file mode 100644 index 000000000..d847905d6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-id.mdx @@ -0,0 +1,158 @@ +--- +title: "Signup Id" +description: "The Signup Id screen module provides access to the Signup Id flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useSignupId" type="SignupIdMembers"> + Provides access to the Signup Id context and functionality. +</ParamField> + +<ParamField body="signup" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="federatedSignup" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="pickCountryCode" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/signup-id.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup-id.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-password.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-password.mdx new file mode 100644 index 000000000..f876b5019 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-password.mdx @@ -0,0 +1,154 @@ +--- +title: "Signup Password" +description: "The Signup Password screen module provides access to the Signup Password flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useSignupPassword" type="SignupPasswordMembers"> + Provides access to the Signup Password context and functionality. +</ParamField> + +<ParamField body="signup" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="federatedSignup" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/signup-password.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup-password.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup.mdx new file mode 100644 index 000000000..f53372f6b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup.mdx @@ -0,0 +1,158 @@ +--- +title: "Signup" +description: "The Signup screen module provides access to the Signup flow." +--- + +## Variables + +<ParamField body="useUser" type="User"> + Hook to access user information and profile data. + + Returns User object containing profile information, attributes, and user-specific data + + ```jsx example + import { useUser } from '@auth0/auth0-acul-react/login-id'; + function UserProfile() { + const user = useUser(); + } + ``` +</ParamField> + +<ParamField body="useTenant" type="Tenant"> + Hook to access tenant configuration and settings. + + Returns Tenant object containing domain, region, and tenant-specific configuration + + ```jsx example + import { useTenant } from '@auth0/auth0-acul-react/login-id'; + function TenantInfo() { + const tenant = useTenant(); + } + ``` +</ParamField> + +<ParamField body="useBranding" type="Branding"> + Hook to access branding and theme configuration. + + Returns Branding object containing colors, logos, fonts, and visual customization settings + + ```jsx example + import { useBranding } from '@auth0/auth0-acul-react/login-id'; + function CustomTheme() { + const branding = useBranding(); + } + ``` +</ParamField> + +<ParamField body="useClient" type="Client"> + Hook to access Auth0 application (client) configuration. + + Returns Client object containing application settings, callbacks, and client-specific data + + ```jsx example + import { useClient } from '@auth0/auth0-acul-react/login-id'; + function AppInfo() { + const client = useClient(); + } + ``` +</ParamField> + +<ParamField body="useOrganization" type="Organization"> + Hook to access organization context and settings. + + Returns Organization object containing org-specific data, metadata, and configuration + + ```jsx example + import { useOrganization } from '@auth0/auth0-acul-react/login-id'; + function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } + } + ``` +</ParamField> + +<ParamField body="usePrompt" type="Prompt"> + Hook to access prompt configuration and flow settings. + + Returns Prompt object containing flow configuration, screen settings, and prompt-specific data + + ```jsx example + import { usePrompt } from '@auth0/auth0-acul-react/login-id'; + function FlowInfo() { + const prompt = usePrompt(); + } + ``` +</ParamField> + +<ParamField body="useScreen" type="Screen"> + Hook to access current screen information and metadata. + + Returns Screen object containing current screen name, configuration, and screen-specific data + + ```jsx example + import { useScreen } from '@auth0/auth0-acul-react/login-id'; + function ScreenDebug() { + const screen = useScreen(); + } + ``` +</ParamField> + +<ParamField body="useTransaction" type="Transaction"> + Hook to access transaction state and authentication flow data. + + Returns Transaction object containing flow state, session data, and transaction-specific information + + ```jsx example + import { useTransaction } from '@auth0/auth0-acul-react/login-id'; + function TransactionInfo() { + const transaction = useTransaction(); + } + ``` +</ParamField> + +<ParamField body="useUntrustedData" type="UntrustedData"> + Hook to access untrusted data from URL parameters and form submissions. + + Returns Object containing untrusted user input that should be validated before use + + ```jsx example + import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; + function PrefilledForm() { + const untrustedData = useUntrustedData(); + } + ``` +</ParamField> + +## Functions + +<ParamField body="useSignup" type="SignupMembers"> + Provides access to the Signup context and functionality. +</ParamField> + +<ParamField body="signup" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="federatedSignup" type="Function"> + Function exported from this screen module. +</ParamField> + +<ParamField body="pickCountryCode" type="Function"> + Function exported from this screen module. +</ParamField> + +## References + +- useCurrentScreen → Hooks.useCurrentScreen +- useErrors → Hooks.useErrors +- useAuth0Themes → Hooks.useAuth0Themes +- UseErrorOptions → Hooks.UseErrorOptions +- UseErrorsResult → Hooks.UseErrorsResult +- ErrorsResult → Hooks.ErrorsResult +- ErrorKind → Hooks.ErrorKind + +--- + +**File:** [src/screens/signup.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Bucket.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Bucket.mdx new file mode 100644 index 000000000..63ba105cf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Bucket.mdx @@ -0,0 +1,18 @@ +--- +title: "Bucket" +description: "" +--- + +## Type Definition + +```typescript +type Bucket = { + server: ReadonlyArray<ErrorItem>; + client: ReadonlyArray<ErrorItem>; + developer: ReadonlyArray<ErrorItem>; +}; +``` + +--- + +**File:** [src/state/error-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/error-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ErrorKind.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ErrorKind.mdx new file mode 100644 index 000000000..8a06a84c4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ErrorKind.mdx @@ -0,0 +1,14 @@ +--- +title: "ErrorKind" +description: "" +--- + +## Type Definition + +```typescript +type ErrorKind = 'server' | 'client' | 'developer'; +``` + +--- + +**File:** [src/state/error-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/error-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Listener.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Listener.mdx new file mode 100644 index 000000000..1cf89ca41 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Listener.mdx @@ -0,0 +1,14 @@ +--- +title: "Listener" +description: "" +--- + +## Type Definition + +```typescript +type Listener = () => void; +``` + +--- + +**File:** [src/state/error-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/error-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ScreenConstructor.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ScreenConstructor.mdx new file mode 100644 index 000000000..3c69cec9a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ScreenConstructor.mdx @@ -0,0 +1,14 @@ +--- +title: "ScreenConstructor" +description: "" +--- + +## Type Definition + +```typescript +type ScreenConstructor = { new (): T; screenIdentifier: string }; +``` + +--- + +**File:** [src/state/instance-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/instance-store.ts) From a983522779cd4e14046cd4099e68e89ee4842aa5 Mon Sep 17 00:00:00 2001 From: gabrielraeder <gabrielraeder@outlook.com.br> Date: Thu, 13 Nov 2025 12:59:22 -0300 Subject: [PATCH 2/7] react sdk pages --- main/docs.json | 627 +++++++++------ .../Hooks}/useAuth0Themes.mdx | 12 +- .../Hooks}/useCurrentScreen.mdx | 18 +- .../Hooks}/useErrors.mdx | 29 +- .../Hooks}/useLoginIdentifiers.mdx | 21 +- .../Hooks}/useMfaPolling.mdx | 34 +- .../Hooks}/usePasswordValidation.mdx | 41 +- .../Hooks}/useResend.mdx | 38 +- .../Hooks}/useSignupIdentifiers.mdx | 22 +- .../Hooks}/useUsernameValidation.mdx | 36 +- .../Screens/accept-invitation/index.mdx | 261 +++++++ .../API-Reference/Screens/consent/index.mdx | 277 +++++++ .../Screens/customized-consent/index.mdx | 277 +++++++ .../device-code-activation-allowed/index.mdx | 245 ++++++ .../device-code-activation-denied/index.mdx | 245 ++++++ .../Screens/device-code-activation/index.mdx | 261 +++++++ .../device-code-confirmation/index.mdx | 277 +++++++ .../email-identifier-challenge/index.mdx | 295 +++++++ .../Screens/email-otp-challenge/index.mdx | 279 +++++++ .../email-verification-result/index.mdx | 245 ++++++ .../Screens/interstitial-captcha/index.mdx | 245 ++++++ .../login-email-verification/index.mdx | 279 +++++++ .../API-Reference/Screens/login-id/index.mdx | 311 ++++++++ .../Screens/login-password/index.mdx | 277 +++++++ .../login-passwordless-email-code/index.mdx | 279 +++++++ .../login-passwordless-sms-otp/index.mdx | 279 +++++++ .../API-Reference/Screens/login/index.mdx | 295 +++++++ .../Screens/logout-aborted/index.mdx | 245 ++++++ .../Screens/logout-complete/index.mdx | 245 ++++++ .../API-Reference/Screens/logout/index.mdx | 261 +++++++ .../mfa-begin-enroll-options/index.mdx | 261 +++++++ .../Screens/mfa-country-codes/index.mdx | 277 +++++++ .../mfa-detect-browser-capabilities/index.mdx | 261 +++++++ .../Screens/mfa-email-challenge/index.mdx | 311 ++++++++ .../Screens/mfa-email-list/index.mdx | 277 +++++++ .../Screens/mfa-enroll-result/index.mdx | 245 ++++++ .../Screens/mfa-login-options/index.mdx | 277 +++++++ .../Screens/mfa-otp-challenge/index.mdx | 277 +++++++ .../Screens/mfa-otp-enrollment-code/index.mdx | 277 +++++++ .../Screens/mfa-otp-enrollment-qr/index.mdx | 293 +++++++ .../Screens/mfa-phone-challenge/index.mdx | 293 +++++++ .../Screens/mfa-phone-enrollment/index.mdx | 293 +++++++ .../Screens/mfa-push-challenge-push/index.mdx | 311 ++++++++ .../Screens/mfa-push-enrollment-qr/index.mdx | 263 +++++++ .../Screens/mfa-push-list/index.mdx | 277 +++++++ .../Screens/mfa-push-welcome/index.mdx | 277 +++++++ .../index.mdx | 261 +++++++ .../mfa-recovery-code-challenge/index.mdx | 277 +++++++ .../mfa-recovery-code-enrollment/index.mdx | 261 +++++++ .../Screens/mfa-sms-challenge/index.mdx | 327 ++++++++ .../Screens/mfa-sms-enrollment/index.mdx | 299 ++++++++ .../Screens/mfa-sms-list/index.mdx | 277 +++++++ .../Screens/mfa-voice-challenge/index.mdx | 327 ++++++++ .../Screens/mfa-voice-enrollment/index.mdx | 293 +++++++ .../index.mdx | 261 +++++++ .../mfa-webauthn-enrollment-success/index.mdx | 261 +++++++ .../Screens/mfa-webauthn-error/index.mdx | 309 ++++++++ .../index.mdx | 261 +++++++ .../mfa-webauthn-platform-challenge/index.mdx | 293 +++++++ .../index.mdx | 309 ++++++++ .../mfa-webauthn-roaming-challenge/index.mdx | 293 +++++++ .../mfa-webauthn-roaming-enrollment/index.mdx | 293 +++++++ .../Screens/organization-picker/index.mdx | 283 +++++++ .../Screens/organization-selection/index.mdx | 261 +++++++ .../passkey-enrollment-local/index.mdx | 277 +++++++ .../Screens/passkey-enrollment/index.mdx | 277 +++++++ .../phone-identifier-challenge/index.mdx | 327 ++++++++ .../phone-identifier-enrollment/index.mdx | 277 +++++++ .../Screens/redeem-ticket/index.mdx | 261 +++++++ .../Screens/reset-password-email/index.mdx | 261 +++++++ .../Screens/reset-password-error/index.mdx | 245 ++++++ .../index.mdx | 295 +++++++ .../index.mdx | 277 +++++++ .../index.mdx | 277 +++++++ .../index.mdx | 311 ++++++++ .../index.mdx | 281 +++++++ .../index.mdx | 311 ++++++++ .../index.mdx | 311 ++++++++ .../index.mdx | 293 +++++++ .../index.mdx | 293 +++++++ .../Screens/reset-password-request/index.mdx | 279 +++++++ .../Screens/reset-password-success/index.mdx | 245 ++++++ .../Screens/reset-password/index.mdx | 263 +++++++ .../API-Reference/Screens/signup-id/index.mdx | 297 +++++++ .../Screens/signup-password/index.mdx | 279 +++++++ .../API-Reference/Screens/signup/index.mdx | 299 ++++++++ .../Types/classes/ContextHooks.mdx | 241 ++++++ .../react-sdk/API-Reference/Types/index.mdx | 360 +++++++++ .../interfaces/AbortEnrollmentOptions.mdx | 17 + .../interfaces/AcceptInvitationMembers.mdx | 131 ++++ .../Types/interfaces/AllowCredential.mdx | 27 + .../Types/interfaces/AuthorizationDetail.mdx | 17 + .../Types/interfaces/BaseMembers.mdx | 148 ++++ .../Types/interfaces/Branding.mdx | 28 + .../Types/interfaces/BrandingMembers.mdx | 20 + .../Types/interfaces/BrandingSettings.mdx | 42 + .../Types/interfaces/BrandingThemes.mdx | 37 + .../Types/interfaces/CaptchaContext.mdx | 27 + .../Types/interfaces/ClientMembers.mdx | 41 + .../Types/interfaces/ConfirmLogoutOptions.mdx | 25 + .../Types/interfaces/Connection.mdx | 31 + .../Types/interfaces/ConsentMembers.mdx | 209 +++++ .../Types/interfaces/ContinueOTPOptions.mdx | 32 + .../Types/interfaces/ContinueOptions.mdx | 32 + .../interfaces/ContinuePayloadOptions.mdx | 32 + .../ContinueWithCodeOptionPayload.mdx | 39 + .../ContinueWithOrganizationNameOptions.mdx | 23 + .../Types/interfaces/CredentialResponse.mdx | 27 + .../Types/interfaces/CurrentScreenOptions.mdx | 57 ++ .../Types/interfaces/CustomOptions.mdx | 41 + .../interfaces/CustomizedConsentMembers.mdx | 211 +++++ .../DeviceCodeActivationAllowedMembers.mdx | 111 +++ .../DeviceCodeActivationContinueOptions.mdx | 27 + .../DeviceCodeActivationDeniedMembers.mdx | 111 +++ .../DeviceCodeActivationMembers.mdx | 137 ++++ .../DeviceCodeConfirmationMembers.mdx | 154 ++++ .../interfaces/EmailChallengeOptions.mdx | 24 + .../EmailIdentifierChallengeMembers.mdx | 178 +++++ .../interfaces/EmailOTPChallengeMembers.mdx | 175 +++++ .../EmailVerificationResultMembers.mdx | 113 +++ .../Types/interfaces/EnrolledDevice.mdx | 20 + .../Types/interfaces/EnrolledEmail.mdx | 20 + .../Types/interfaces/EnrolledPhoneNumber.mdx | 20 + .../Types/interfaces/EnterpriseConnection.mdx | 62 ++ .../API-Reference/Types/interfaces/Error.mdx | 38 + .../Types/interfaces/ErrorItem.mdx | 75 ++ .../Types/interfaces/ErrorsResult.mdx | 61 ++ .../interfaces/FederatedLoginOptions.mdx | 17 + .../FederatedLoginPasswordOptions.mdx | 17 + .../FederatedLoginPayloadOptions.mdx | 23 + .../interfaces/FederatedSignupOptions.mdx | 17 + .../FederatedSignupPasswordPayloadOptions.mdx | 17 + .../FederatedSignupPayloadOptions.mdx | 17 + .../Types/interfaces/FlattenedTheme.mdx | 41 + .../Types/interfaces/Identifier.mdx | 40 + .../interfaces/InterstitialCaptchaMembers.mdx | 126 +++ .../LoginEmailVerificationMembers.mdx | 268 +++++++ .../Types/interfaces/LoginEnrollOptions.mdx | 23 + .../Types/interfaces/LoginIdMembers.mdx | 189 +++++ .../Types/interfaces/LoginMembers.mdx | 192 +++++ .../Types/interfaces/LoginOptions.mdx | 24 + .../Types/interfaces/LoginPasswordMembers.mdx | 144 ++++ .../Types/interfaces/LoginPasswordOptions.mdx | 31 + .../LoginPasswordlessEmailCodeMembers.mdx | 161 ++++ .../LoginPasswordlessSmsOtpMembers.mdx | 165 ++++ .../Types/interfaces/LoginPayloadOptions.mdx | 41 + .../Types/interfaces/LogoutAbortedMembers.mdx | 111 +++ .../interfaces/LogoutCompleteMembers.mdx | 111 +++ .../Types/interfaces/LogoutMembers.mdx | 133 ++++ .../MfaBeginEnrollOptionsMembers.mdx | 133 ++++ .../interfaces/MfaCountryCodesMembers.mdx | 154 ++++ .../MfaDetectBrowserCapabilitiesMembers.mdx | 140 ++++ .../interfaces/MfaEmailChallengeMembers.mdx | 217 ++++++ .../Types/interfaces/MfaEmailListMembers.mdx | 154 ++++ .../Types/interfaces/MfaEnrollOptions.mdx | 23 + .../interfaces/MfaEnrollResultMembers.mdx | 113 +++ .../interfaces/MfaLoginOptionsMembers.mdx | 170 +++++ .../interfaces/MfaOtpChallengeMembers.mdx | 154 ++++ .../interfaces/MfaOtpContinueOptions.mdx | 23 + .../MfaOtpEnrollmentCodeMembers.mdx | 156 ++++ .../MfaOtpEnrollmentQrContinueOptions.mdx | 23 + .../interfaces/MfaOtpEnrollmentQrMembers.mdx | 175 +++++ .../MfaOtpTryAnotherMethodOptions.mdx | 13 + .../MfaPhoneChallengeContinueOptions.mdx | 35 + .../interfaces/MfaPhoneChallengeMembers.mdx | 231 ++++++ ...PhoneChallengePickAuthenticatorOptions.mdx | 17 + .../MfaPhoneChallengePickPhoneOptions.mdx | 18 + .../MfaPhoneEnrollmentContinueOptions.mdx | 32 + .../interfaces/MfaPhoneEnrollmentMembers.mdx | 173 +++++ .../Types/interfaces/MfaPollingResult.mdx | 53 ++ .../MfaPushChallengePushMembers.mdx | 219 ++++++ .../interfaces/MfaPushEnrollmentQrMembers.mdx | 150 ++++ .../Types/interfaces/MfaPushListMembers.mdx | 154 ++++ .../interfaces/MfaPushPollingControl.mdx | 87 +++ .../interfaces/MfaPushWelcomeMembers.mdx | 144 ++++ ...faRecoveryCodeChallengeContinueOptions.mdx | 23 + .../MfaRecoveryCodeChallengeMembers.mdx | 158 ++++ ...eryCodeChallengeNewCodeContinueOptions.mdx | 15 + ...MfaRecoveryCodeChallengeNewCodeMembers.mdx | 161 ++++ ...aRecoveryCodeEnrollmentContinueOptions.mdx | 21 + .../MfaRecoveryCodeEnrollmentMembers.mdx | 138 ++++ .../interfaces/MfaSmsChallengeMembers.mdx | 216 ++++++ .../interfaces/MfaSmsChallengeOptions.mdx | 24 + .../interfaces/MfaSmsEnrollmentMembers.mdx | 167 ++++ .../interfaces/MfaSmsEnrollmentOptions.mdx | 24 + .../Types/interfaces/MfaSmsListMembers.mdx | 159 ++++ .../Types/interfaces/MfaSmsListOptions.mdx | 26 + .../MfaVoiceChallengeContinueOptions.mdx | 32 + .../interfaces/MfaVoiceChallengeMembers.mdx | 288 +++++++ .../MfaVoiceEnrollmentContinueOptions.mdx | 23 + .../interfaces/MfaVoiceEnrollmentMembers.mdx | 181 +++++ ...bAuthnChangeKeyNicknameContinueOptions.mdx | 27 + .../MfaWebAuthnChangeKeyNicknameMembers.mdx | 178 +++++ .../MfaWebAuthnEnrollmentSuccessMembers.mdx | 158 ++++ .../interfaces/MfaWebAuthnErrorMembers.mdx | 254 ++++++ .../MfaWebAuthnNotAvailableErrorMembers.mdx | 154 ++++ .../MfaWebAuthnPlatformChallengeMembers.mdx | 256 +++++++ ...thnPlatformChallengeReportErrorOptions.mdx | 17 + ...atformChallengeTryAnotherMethodOptions.mdx | 15 + .../MfaWebAuthnPlatformEnrollmentMembers.mdx | 275 +++++++ .../MfaWebAuthnRoamingChallengeMembers.mdx | 249 ++++++ ...uthnRoamingChallengeReportErrorOptions.mdx | 17 + ...oamingChallengeTryAnotherMethodOptions.mdx | 15 + .../MfaWebAuthnRoamingEnrollmentMembers.mdx | 226 ++++++ ...amingEnrollmentTryAnotherMethodOptions.mdx | 13 + .../Types/interfaces/OrganizationMembers.mdx | 48 ++ .../interfaces/OrganizationPickerMembers.mdx | 160 ++++ .../OrganizationSelectionMembers.mdx | 135 ++++ .../Types/interfaces/Organizations.mdx | 34 + .../Types/interfaces/OtpCodeOptions.mdx | 23 + .../Types/interfaces/PasskeyCreate.mdx | 65 ++ .../interfaces/PasskeyCreateResponse.mdx | 41 + .../PasskeyEnrollmentLocalMembers.mdx | 144 ++++ .../interfaces/PasskeyEnrollmentMembers.mdx | 144 ++++ .../interfaces/PasswordComplexityRule.mdx | 60 ++ .../Types/interfaces/PasswordPolicy.mdx | 34 + .../interfaces/PasswordValidationResult.mdx | 30 + .../interfaces/PhoneChallengeOptions.mdx | 24 + .../interfaces/PhoneEnrollmentOptions.mdx | 17 + .../PhoneIdentifierChallengeMembers.mdx | 212 +++++ .../PhoneIdentifierEnrollmentMembers.mdx | 144 ++++ .../Types/interfaces/PhonePrefix.mdx | 33 + .../Types/interfaces/PromptMembers.mdx | 13 + .../Types/interfaces/RedeemTicketMembers.mdx | 148 ++++ .../interfaces/ReportBrowserErrorOptions.mdx | 23 + .../Types/interfaces/ResendCodeOptions.mdx | 13 + .../interfaces/ResendCodeOptionsPayload.mdx | 18 + .../interfaces/ResendCodePayloadOptions.mdx | 13 + .../Types/interfaces/ResendControl.mdx | 19 + .../interfaces/ResetPasswordEmailMembers.mdx | 127 +++ .../interfaces/ResetPasswordEmailOptions.mdx | 9 + .../interfaces/ResetPasswordErrorMembers.mdx | 109 +++ .../Types/interfaces/ResetPasswordMembers.mdx | 144 ++++ .../ResetPasswordMfaEmailChallengeMembers.mdx | 196 +++++ ...PasswordMfaOtpChallengeContinueOptions.mdx | 23 + .../ResetPasswordMfaOtpChallengeMembers.mdx | 154 ++++ ...MfaOtpChallengeTryAnotherMethodOptions.mdx | 13 + ...sswordMfaPhoneChallengeContinueOptions.mdx | 27 + .../ResetPasswordMfaPhoneChallengeMembers.mdx | 207 +++++ ...aPhoneChallengeTryAnotherMethodOptions.mdx | 28 + ...setPasswordMfaPushChallengePushMembers.mdx | 217 ++++++ ...asswordMfaRecoveryCodeChallengeMembers.mdx | 160 ++++ .../ResetPasswordMfaSmsChallengeMembers.mdx | 199 +++++ .../ResetPasswordMfaSmsChallengeOptions.mdx | 17 + ...sswordMfaVoiceChallengeContinueOptions.mdx | 25 + .../ResetPasswordMfaVoiceChallengeMembers.mdx | 232 ++++++ ...bAuthnPlatformChallengeContinueOptions.mdx | 27 + ...ordMfaWebAuthnPlatformChallengeMembers.mdx | 253 ++++++ ...thnPlatformChallengeReportErrorOptions.mdx | 18 + ...atformChallengeTryAnotherMethodOptions.mdx | 15 + ...wordMfaWebAuthnRoamingChallengeMembers.mdx | 214 ++++++ ...bAuthnRoamingChallengeShowErrorOptions.mdx | 28 + ...oamingChallengeTryAnotherMethodOptions.mdx | 26 + ...nRoamingChallengeUseSecurityKeyOptions.mdx | 27 + .../Types/interfaces/ResetPasswordOptions.mdx | 24 + .../ResetPasswordRequestMembers.mdx | 155 ++++ .../ResetPasswordRequestOptions.mdx | 24 + .../ResetPasswordSuccessMembers.mdx | 109 +++ .../API-Reference/Types/interfaces/Scope.mdx | 20 + .../Types/interfaces/ScreenMembers.mdx | 128 ++++ .../ScreenMembersOnAcceptInvitation.mdx | 109 +++ .../interfaces/ScreenMembersOnConsent.mdx | 127 +++ .../ScreenMembersOnCustomizedConsent.mdx | 137 ++++ .../ScreenMembersOnDeviceCodeConfirmation.mdx | 111 +++ ...creenMembersOnEmailIdentifierChallenge.mdx | 109 +++ .../ScreenMembersOnEmailOTPChallenge.mdx | 112 +++ ...ScreenMembersOnEmailVerificationResult.mdx | 138 ++++ .../Types/interfaces/ScreenMembersOnLogin.mdx | 125 +++ .../interfaces/ScreenMembersOnLoginId.mdx | 130 ++++ .../ScreenMembersOnLoginPassword.mdx | 130 ++++ ...eenMembersOnLoginPasswordlessEmailCode.mdx | 130 ++++ ...ScreenMembersOnLoginPasswordlessSmsOtp.mdx | 138 ++++ .../ScreenMembersOnMfaCountryCodes.mdx | 123 +++ .../ScreenMembersOnMfaEmailChallenge.mdx | 111 +++ .../ScreenMembersOnMfaEmailList.mdx | 123 +++ .../ScreenMembersOnMfaEnrollResult.mdx | 127 +++ .../ScreenMembersOnMfaLoginOptions.mdx | 123 +++ .../ScreenMembersOnMfaOtpChallenge.mdx | 111 +++ .../ScreenMembersOnMfaOtpEnrollmentCode.mdx | 123 +++ .../ScreenMembersOnMfaOtpEnrollmentQr.mdx | 111 +++ .../ScreenMembersOnMfaPhoneChallenge.mdx | 123 +++ .../ScreenMembersOnMfaPushChallengePush.mdx | 129 ++++ .../ScreenMembersOnMfaPushEnrollmentQr.mdx | 111 +++ .../ScreenMembersOnMfaPushWelcome.mdx | 132 ++++ ...mbersOnMfaRecoveryCodeChallengeNewCode.mdx | 124 +++ ...reenMembersOnMfaRecoveryCodeEnrollment.mdx | 123 +++ .../ScreenMembersOnMfaSmsChallenge.mdx | 135 ++++ .../ScreenMembersOnMfaSmsEnrollment.mdx | 109 +++ .../ScreenMembersOnMfaVoiceChallenge.mdx | 137 ++++ ...nMembersOnMfaWebAuthnChangeKeyNickname.mdx | 136 ++++ ...nMembersOnMfaWebAuthnEnrollmentSuccess.mdx | 144 ++++ .../ScreenMembersOnMfaWebAuthnError.mdx | 129 ++++ ...nMembersOnMfaWebAuthnPlatformChallenge.mdx | 132 ++++ ...MembersOnMfaWebAuthnPlatformEnrollment.mdx | 118 +++ ...enMembersOnMfaWebAuthnRoamingChallenge.mdx | 134 ++++ ...nMembersOnMfaWebAuthnRoamingEnrollment.mdx | 125 +++ .../ScreenMembersOnOrganizationSelection.mdx | 153 ++++ .../ScreenMembersOnPasskeyEnrollment.mdx | 130 ++++ .../ScreenMembersOnPasskeyEnrollmentLocal.mdx | 116 +++ ...creenMembersOnPhoneIdentifierChallenge.mdx | 109 +++ ...reenMembersOnPhoneIdentifierEnrollment.mdx | 116 +++ .../ScreenMembersOnResetPassword.mdx | 109 +++ .../ScreenMembersOnResetPasswordEmail.mdx | 109 +++ .../ScreenMembersOnResetPasswordError.mdx | 109 +++ ...embersOnResetPasswordMfaEmailChallenge.mdx | 111 +++ ...embersOnResetPasswordMfaPhoneChallenge.mdx | 123 +++ ...ersOnResetPasswordMfaPushChallengePush.mdx | 111 +++ ...nMembersOnResetPasswordMfaSmsChallenge.mdx | 125 +++ ...embersOnResetPasswordMfaVoiceChallenge.mdx | 129 ++++ ...etPasswordMfaWebAuthnPlatformChallenge.mdx | 135 ++++ ...setPasswordMfaWebAuthnRoamingChallenge.mdx | 134 ++++ .../ScreenMembersOnResetPasswordRequest.mdx | 109 +++ .../ScreenMembersOnResetPasswordSuccess.mdx | 109 +++ .../interfaces/ScreenMembersOnSignup.mdx | 116 +++ .../interfaces/ScreenMembersOnSignupId.mdx | 116 +++ .../ScreenMembersOnSignupPassword.mdx | 123 +++ .../interfaces/SelectCountryCodeOptions.mdx | 32 + .../interfaces/SelectMfaEmailOptions.mdx | 25 + .../interfaces/SelectMfaPushDeviceOptions.mdx | 22 + .../interfaces/SelectOrganizationOptions.mdx | 20 + .../Types/interfaces/ShowErrorOptions.mdx | 23 + .../Types/interfaces/SignupIdMembers.mdx | 189 +++++ .../Types/interfaces/SignupMembers.mdx | 231 ++++++ .../Types/interfaces/SignupOptions.mdx | 38 + .../interfaces/SignupPasswordMembers.mdx | 161 ++++ .../interfaces/SignupPasswordOptions.mdx | 45 ++ .../Types/interfaces/SignupPayloadOptions.mdx | 45 ++ .../Types/interfaces/StartResendOptions.mdx | 33 + .../Types/interfaces/SubmitCaptchaOptions.mdx | 17 + .../Types/interfaces/SubmitCodeOptions.mdx | 24 + .../Types/interfaces/SubmitOTPOptions.mdx | 31 + .../SubmitPasskeyCredentialOptions.mdx | 15 + .../Types/interfaces/TenantMembers.mdx | 34 + .../Types/interfaces/TransactionMembers.mdx | 82 ++ .../interfaces/TransactionMembersOnLogin.mdx | 146 ++++ .../TransactionMembersOnLoginId.mdx | 151 ++++ .../TransactionMembersOnLoginPassword.mdx | 164 ++++ ...ionMembersOnLoginPasswordlessEmailCode.mdx | 116 +++ ...actionMembersOnLoginPasswordlessSmsOtp.mdx | 116 +++ .../TransactionMembersOnResetPassword.mdx | 116 +++ ...ansactionMembersOnResetPasswordRequest.mdx | 130 ++++ .../interfaces/TransactionMembersOnSignup.mdx | 144 ++++ .../TransactionMembersOnSignupId.mdx | 137 ++++ .../TransactionMembersOnSignupPassword.mdx | 137 ++++ ...TryAnotherMethodMfaOtpChallengeOptions.mdx | 13 + .../interfaces/TryAnotherMethodOptions.mdx | 13 + .../TryAnotherMethodPayloadOptions.mdx | 13 + .../Types/interfaces/UntrustedDataMembers.mdx | 28 + ...ntrustedDataMembersOnMfaEmailChallenge.mdx | 34 + .../UntrustedDataMembersOnMfaOtpChallenge.mdx | 34 + ...ustedDataMembersOnMfaPushChallengePush.mdx | 34 + .../UntrustedDataMembersOnMfaSmsChallenge.mdx | 34 + ...ntrustedDataMembersOnMfaVoiceChallenge.mdx | 34 + .../Types/interfaces/UseErrorOptions.mdx | 13 + .../Types/interfaces/UseErrorsResult.mdx | 48 ++ .../Types/interfaces/UseResendOptions.mdx | 32 + .../Types/interfaces/UseResendReturn.mdx | 39 + .../Types/interfaces/UserMembers.mdx | 90 +++ .../Types/interfaces/UsernamePolicy.mdx | 42 + .../interfaces/UsernameValidationError.mdx | 41 + .../interfaces/UsernameValidationResult.mdx | 29 + .../VerifyPlatformAuthenticatorOptions.mdx | 26 + .../interfaces/VerifySecurityKeyOptions.mdx | 26 + .../WebAuthnEnrollSuccessContinueOptions.mdx | 15 + .../Types/interfaces/WebAuthnErrorDetails.mdx | 32 + .../Types/interfaces/WithRememberOptions.mdx | 21 + .../type-aliases/AuthenticatorTransport.mdx | 7 + .../Types/type-aliases/ErrorKind.mdx | 7 + .../Types/type-aliases/IdentifierType.mdx | 9 + .../type-aliases/MfaEnrollFactorType.mdx | 9 + .../Types/type-aliases/MfaLoginFactorType.mdx | 9 + .../Types/type-aliases/MfaPollingOptions.mdx | 76 ++ .../type-aliases/OnStatusChangeCallback.mdx | 27 + .../type-aliases/ScreenIdentifierType.mdx | 22 + .../Types/type-aliases/WebAuthnType.mdx | 7 + .../react-sdk/API-Reference/index.mdx | 9 + .../reference/react-sdk/README.md | 50 -- .../react-sdk/classes/ContextHooks.mdx | 46 -- .../react-sdk/classes/ErrorStore.mdx | 95 --- .../functions/abortPasskeyEnrollment.mdx | 18 - .../reference/react-sdk/functions/accept.mdx | 18 - .../react-sdk/functions/acceptInvitation.mdx | 18 - .../react-sdk/functions/backAction.mdx | 18 - .../react-sdk/functions/backToLogin.mdx | 18 - .../reference/react-sdk/functions/cancel.mdx | 18 - .../react-sdk/functions/classifyKind.mdx | 18 - .../react-sdk/functions/clearScreen.mdx | 15 - .../reference/react-sdk/functions/confirm.mdx | 18 - .../react-sdk/functions/confirmLogout.mdx | 18 - .../functions/continueEnrollment.mdx | 24 - .../react-sdk/functions/continueMethod.mdx | 18 - .../functions/continueMfaSmsChallenge.mdx | 18 - .../functions/continuePasskeyEnrollment.mdx | 18 - .../functions/continuePhoneEnrollment.mdx | 18 - .../react-sdk/functions/continueWithCode.mdx | 18 - .../functions/continueWithNewNickname.mdx | 18 - .../continueWithOrganizationName.mdx | 18 - .../functions/continueWithPasskey.mdx | 18 - .../reference/react-sdk/functions/deny.mdx | 18 - .../functions/detectCapabilities.mdx | 18 - .../reference/react-sdk/functions/enroll.mdx | 18 - .../react-sdk/functions/enterCodeManually.mdx | 18 - .../react-sdk/functions/federatedLogin.mdx | 18 - .../react-sdk/functions/federatedSignup.mdx | 18 - .../react-sdk/functions/filterByField.mdx | 21 - .../react-sdk/functions/getACall.mdx | 18 - .../react-sdk/functions/getScreen.mdx | 15 - .../reference/react-sdk/functions/goBack.mdx | 18 - .../react-sdk/functions/listsEqual.mdx | 21 - .../reference/react-sdk/functions/login.mdx | 18 - .../react-sdk/functions/noThanks.mdx | 18 - .../react-sdk/functions/passkeyLogin.mdx | 18 - .../react-sdk/functions/pickAuthenticator.mdx | 18 - .../react-sdk/functions/pickCountryCode.mdx | 18 - .../react-sdk/functions/pickEmail.mdx | 18 - .../react-sdk/functions/pickPhone.mdx | 18 - .../reference/react-sdk/functions/pickSms.mdx | 18 - .../refuseEnrollmentOnThisDevice.mdx | 18 - .../react-sdk/functions/registerScreen.mdx | 18 - .../functions/reportBrowserError.mdx | 18 - .../functions/reportWebAuthnError.mdx | 18 - .../react-sdk/functions/resendCode.mdx | 18 - .../react-sdk/functions/resendEmail.mdx | 18 - .../react-sdk/functions/resendOTP.mdx | 18 - .../functions/resendPushNotification.mdx | 18 - .../react-sdk/functions/resetPassword.mdx | 18 - .../react-sdk/functions/returnToPrevious.mdx | 18 - .../react-sdk/functions/selectCountryCode.mdx | 18 - .../react-sdk/functions/selectMfaEmail.mdx | 18 - .../functions/selectMfaPushDevice.mdx | 18 - .../functions/selectOrganization.mdx | 24 - .../functions/selectPhoneCountryCode.mdx | 18 - .../react-sdk/functions/selectPhoneNumber.mdx | 18 - .../react-sdk/functions/showError.mdx | 18 - .../reference/react-sdk/functions/signup.mdx | 18 - .../functions/skipOrganizationSelection.mdx | 18 - .../react-sdk/functions/snoozeEnrollment.mdx | 18 - .../react-sdk/functions/submitCode.mdx | 18 - .../functions/submitEmailChallenge.mdx | 18 - .../react-sdk/functions/submitOTP.mdx | 18 - .../functions/submitPasskeyCredential.mdx | 18 - .../functions/submitPhoneChallenge.mdx | 18 - .../react-sdk/functions/switchToSms.mdx | 18 - .../react-sdk/functions/switchToText.mdx | 18 - .../react-sdk/functions/switchToVoice.mdx | 18 - .../react-sdk/functions/toErrorObject.mdx | 18 - .../react-sdk/functions/toggleView.mdx | 18 - .../react-sdk/functions/tryAgain.mdx | 18 - .../react-sdk/functions/tryAnotherMethod.mdx | 18 - .../functions/useAcceptInvitation.mdx | 15 - .../react-sdk/functions/useAuth0Themes.mdx | 15 - .../react-sdk/functions/useConsent.mdx | 15 - .../react-sdk/functions/useCurrentScreen.mdx | 15 - .../functions/useCustomizedConsent.mdx | 15 - .../functions/useDeviceCodeActivation.mdx | 15 - .../useDeviceCodeActivationAllowed.mdx | 15 - .../useDeviceCodeActivationDenied.mdx | 15 - .../functions/useDeviceCodeConfirmation.mdx | 15 - .../functions/useEmailIdentifierChallenge.mdx | 15 - .../functions/useEmailOTPChallenge.mdx | 15 - .../functions/useEmailVerificationResult.mdx | 15 - .../react-sdk/functions/useErrors.mdx | 18 - .../functions/useInterstitialCaptcha.mdx | 15 - .../react-sdk/functions/useLogin.mdx | 15 - .../functions/useLoginEmailVerification.mdx | 15 - .../react-sdk/functions/useLoginId.mdx | 15 - .../functions/useLoginIdentifiers.mdx | 15 - .../react-sdk/functions/useLoginPassword.mdx | 15 - .../useLoginPasswordlessEmailCode.mdx | 15 - .../functions/useLoginPasswordlessSmsOtp.mdx | 15 - .../react-sdk/functions/useLogout.mdx | 15 - .../react-sdk/functions/useLogoutAborted.mdx | 15 - .../react-sdk/functions/useLogoutComplete.mdx | 15 - .../functions/useMfaBeginEnrollOptions.mdx | 15 - .../functions/useMfaCountryCodes.mdx | 15 - .../useMfaDetectBrowserCapabilities.mdx | 15 - .../functions/useMfaEmailChallenge.mdx | 15 - .../react-sdk/functions/useMfaEmailList.mdx | 15 - .../functions/useMfaEnrollResult.mdx | 15 - .../functions/useMfaLoginOptions.mdx | 15 - .../functions/useMfaOtpChallenge.mdx | 15 - .../functions/useMfaOtpEnrollmentCode.mdx | 15 - .../functions/useMfaOtpEnrollmentQr.mdx | 15 - .../functions/useMfaPhoneChallenge.mdx | 15 - .../functions/useMfaPhoneEnrollment.mdx | 15 - .../react-sdk/functions/useMfaPolling.mdx | 18 - .../functions/useMfaPushChallengePush.mdx | 15 - .../functions/useMfaPushEnrollmentQr.mdx | 15 - .../react-sdk/functions/useMfaPushList.mdx | 15 - .../react-sdk/functions/useMfaPushWelcome.mdx | 15 - .../functions/useMfaRecoveryCodeChallenge.mdx | 15 - .../useMfaRecoveryCodeChallengeNewCode.mdx | 15 - .../useMfaRecoveryCodeEnrollment.mdx | 15 - .../functions/useMfaSmsChallenge.mdx | 15 - .../functions/useMfaSmsEnrollment.mdx | 15 - .../react-sdk/functions/useMfaSmsList.mdx | 15 - .../functions/useMfaVoiceChallenge.mdx | 15 - .../functions/useMfaVoiceEnrollment.mdx | 15 - .../useMfaWebAuthnChangeKeyNickname.mdx | 15 - .../useMfaWebAuthnEnrollmentSuccess.mdx | 15 - .../functions/useMfaWebAuthnError.mdx | 15 - .../useMfaWebAuthnNotAvailableError.mdx | 15 - .../useMfaWebAuthnPlatformChallenge.mdx | 15 - .../useMfaWebAuthnPlatformEnrollment.mdx | 15 - .../useMfaWebAuthnRoamingChallenge.mdx | 15 - .../useMfaWebAuthnRoamingEnrollment.mdx | 15 - .../functions/useOrganizationPicker.mdx | 15 - .../functions/useOrganizationSelection.mdx | 15 - .../functions/usePasskeyEnrollment.mdx | 15 - .../functions/usePasskeyEnrollmentLocal.mdx | 15 - .../react-sdk/functions/usePassword.mdx | 18 - .../functions/usePasswordValidation.mdx | 25 - .../functions/usePhoneIdentifierChallenge.mdx | 15 - .../usePhoneIdentifierEnrollment.mdx | 15 - .../react-sdk/functions/useRedeemTicket.mdx | 15 - .../react-sdk/functions/useResend.mdx | 18 - .../react-sdk/functions/useResetPassword.mdx | 15 - .../functions/useResetPasswordEmail.mdx | 15 - .../functions/useResetPasswordError.mdx | 15 - .../useResetPasswordMfaEmailChallenge.mdx | 15 - .../useResetPasswordMfaOtpChallenge.mdx | 15 - .../useResetPasswordMfaPhoneChallenge.mdx | 15 - .../useResetPasswordMfaPushChallengePush.mdx | 15 - ...eResetPasswordMfaRecoveryCodeChallenge.mdx | 15 - .../useResetPasswordMfaSmsChallenge.mdx | 15 - .../useResetPasswordMfaVoiceChallenge.mdx | 15 - ...etPasswordMfaWebAuthnPlatformChallenge.mdx | 15 - ...setPasswordMfaWebAuthnRoamingChallenge.mdx | 15 - .../functions/useResetPasswordRequest.mdx | 15 - .../functions/useResetPasswordSuccess.mdx | 15 - .../react-sdk/functions/useSecurityKey.mdx | 18 - .../react-sdk/functions/useSignup.mdx | 15 - .../react-sdk/functions/useSignupId.mdx | 15 - .../functions/useSignupIdentifiers.mdx | 15 - .../react-sdk/functions/useSignupPassword.mdx | 15 - .../functions/useUsernameValidation.mdx | 25 - .../reference/react-sdk/functions/verify.mdx | 18 - .../react-sdk/functions/withError.mdx | 18 - .../react-sdk/interfaces/ErrorItem.mdx | 31 - .../react-sdk/interfaces/ErrorsResult.mdx | 27 - .../react-sdk/interfaces/MfaPollingResult.mdx | 55 -- .../react-sdk/interfaces/UseErrorOptions.mdx | 23 - .../react-sdk/interfaces/UseErrorsResult.mdx | 35 - .../react-sdk/interfaces/UseResendOptions.mdx | 37 - .../react-sdk/interfaces/UseResendReturn.mdx | 37 - .../interfaces/WithLoginIdentifiers.mdx | 23 - .../interfaces/WithResendManager.mdx | 23 - .../interfaces/WithSignupIdentifiers.mdx | 23 - .../interfaces/WithValidatePassword.mdx | 23 - .../interfaces/WithValidateUsername.mdx | 23 - .../reference/react-sdk/navigation.json | 722 +++++++++--------- .../react-sdk/screens/accept-invitation.mdx | 152 ---- .../reference/react-sdk/screens/consent.mdx | 154 ---- .../react-sdk/screens/customized-consent.mdx | 154 ---- .../device-code-activation-allowed.mdx | 146 ---- .../screens/device-code-activation-denied.mdx | 146 ---- .../screens/device-code-activation.mdx | 150 ---- .../screens/device-code-confirmation.mdx | 158 ---- .../screens/email-identifier-challenge.mdx | 158 ---- .../react-sdk/screens/email-otp-challenge.mdx | 158 ---- .../screens/email-verification-result.mdx | 146 ---- .../screens/interstitial-captcha.mdx | 146 ---- .../screens/login-email-verification.mdx | 154 ---- .../reference/react-sdk/screens/login-id.mdx | 162 ---- .../react-sdk/screens/login-password.mdx | 154 ---- .../screens/login-passwordless-email-code.mdx | 154 ---- .../screens/login-passwordless-sms-otp.mdx | 154 ---- .../reference/react-sdk/screens/login.mdx | 164 ---- .../react-sdk/screens/logout-aborted.mdx | 146 ---- .../react-sdk/screens/logout-complete.mdx | 146 ---- .../reference/react-sdk/screens/logout.mdx | 152 ---- .../screens/mfa-begin-enroll-options.mdx | 152 ---- .../react-sdk/screens/mfa-country-codes.mdx | 158 ---- .../mfa-detect-browser-capabilities.mdx | 152 ---- .../react-sdk/screens/mfa-email-challenge.mdx | 168 ---- .../react-sdk/screens/mfa-email-list.mdx | 158 ---- .../react-sdk/screens/mfa-enroll-result.mdx | 146 ---- .../react-sdk/screens/mfa-login-options.mdx | 158 ---- .../react-sdk/screens/mfa-otp-challenge.mdx | 156 ---- .../screens/mfa-otp-enrollment-code.mdx | 156 ---- .../screens/mfa-otp-enrollment-qr.mdx | 162 ---- .../react-sdk/screens/mfa-phone-challenge.mdx | 158 ---- .../screens/mfa-phone-enrollment.mdx | 164 ---- .../screens/mfa-push-challenge-push.mdx | 168 ---- .../screens/mfa-push-enrollment-qr.mdx | 152 ---- .../react-sdk/screens/mfa-push-list.mdx | 158 ---- .../react-sdk/screens/mfa-push-welcome.mdx | 154 ---- .../mfa-recovery-code-challenge-new-code.mdx | 150 ---- .../screens/mfa-recovery-code-challenge.mdx | 156 ---- .../screens/mfa-recovery-code-enrollment.mdx | 150 ---- .../react-sdk/screens/mfa-sms-challenge.mdx | 166 ---- .../react-sdk/screens/mfa-sms-enrollment.mdx | 158 ---- .../react-sdk/screens/mfa-sms-list.mdx | 154 ---- .../react-sdk/screens/mfa-voice-challenge.mdx | 174 ----- .../screens/mfa-voice-enrollment.mdx | 162 ---- .../mfa-webauthn-change-key-nickname.mdx | 150 ---- .../mfa-webauthn-enrollment-success.mdx | 150 ---- .../react-sdk/screens/mfa-webauthn-error.mdx | 158 ---- .../mfa-webauthn-not-available-error.mdx | 150 ---- .../mfa-webauthn-platform-challenge.mdx | 158 ---- .../mfa-webauthn-platform-enrollment.mdx | 162 ---- .../mfa-webauthn-roaming-challenge.mdx | 158 ---- .../mfa-webauthn-roaming-enrollment.mdx | 164 ---- .../react-sdk/screens/organization-picker.mdx | 158 ---- .../screens/organization-selection.mdx | 152 ---- .../screens/passkey-enrollment-local.mdx | 154 ---- .../react-sdk/screens/passkey-enrollment.mdx | 154 ---- .../screens/phone-identifier-challenge.mdx | 166 ---- .../screens/phone-identifier-enrollment.mdx | 154 ---- .../react-sdk/screens/redeem-ticket.mdx | 150 ---- .../screens/reset-password-email.mdx | 150 ---- .../screens/reset-password-error.mdx | 146 ---- .../reset-password-mfa-email-challenge.mdx | 162 ---- .../reset-password-mfa-otp-challenge.mdx | 156 ---- .../reset-password-mfa-phone-challenge.mdx | 154 ---- ...reset-password-mfa-push-challenge-push.mdx | 168 ---- ...t-password-mfa-recovery-code-challenge.mdx | 154 ---- .../reset-password-mfa-sms-challenge.mdx | 162 ---- .../reset-password-mfa-voice-challenge.mdx | 168 ---- ...ssword-mfa-webauthn-platform-challenge.mdx | 158 ---- ...assword-mfa-webauthn-roaming-challenge.mdx | 154 ---- .../screens/reset-password-request.mdx | 154 ---- .../screens/reset-password-success.mdx | 146 ---- .../react-sdk/screens/reset-password.mdx | 150 ---- .../reference/react-sdk/screens/signup-id.mdx | 158 ---- .../react-sdk/screens/signup-password.mdx | 154 ---- .../reference/react-sdk/screens/signup.mdx | 158 ---- .../reference/react-sdk/types/Bucket.mdx | 18 - .../reference/react-sdk/types/ErrorKind.mdx | 14 - .../reference/react-sdk/types/Listener.mdx | 14 - .../react-sdk/types/ScreenConstructor.mdx | 14 - 631 files changed, 48458 insertions(+), 15793 deletions(-) rename main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/{hooks => API-Reference/Hooks}/useAuth0Themes.mdx (75%) rename main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/{hooks => API-Reference/Hooks}/useCurrentScreen.mdx (82%) rename main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/{hooks => API-Reference/Hooks}/useErrors.mdx (74%) rename main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/{hooks => API-Reference/Hooks}/useLoginIdentifiers.mdx (55%) rename main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/{hooks => API-Reference/Hooks}/useMfaPolling.mdx (74%) rename main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/{hooks => API-Reference/Hooks}/usePasswordValidation.mdx (52%) rename main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/{hooks => API-Reference/Hooks}/useResend.mdx (73%) rename main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/{hooks => API-Reference/Hooks}/useSignupIdentifiers.mdx (65%) rename main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/{hooks => API-Reference/Hooks}/useUsernameValidation.mdx (67%) create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AbortEnrollmentOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AuthorizationDetail.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOTPOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinuePayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithOrganizationNameOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CredentialResponse.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailChallengeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledDevice.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledEmail.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledPhoneNumber.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPasswordOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPasswordPayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneChallengeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodePayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectCountryCodeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaEmailOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaPushDeviceOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectOrganizationOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCaptchaOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitOTPOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodPayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/AuthenticatorTransport.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaEnrollFactorType.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaLoginFactorType.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/OnStatusChangeCallback.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ScreenIdentifierType.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/index.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/README.md delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ContextHooks.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ErrorStore.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/abortPasskeyEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/accept.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/acceptInvitation.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backAction.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backToLogin.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/cancel.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/classifyKind.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/clearScreen.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirm.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirmLogout.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMfaSmsChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePasskeyEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePhoneEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithNewNickname.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithOrganizationName.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithPasskey.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/deny.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/detectCapabilities.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enterCodeManually.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/filterByField.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getACall.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getScreen.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/listsEqual.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/noThanks.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/passkeyLogin.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickAuthenticator.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickEmail.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickPhone.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickSms.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/refuseEnrollmentOnThisDevice.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/registerScreen.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportWebAuthnError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendEmail.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendOTP.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendPushNotification.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resetPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectCountryCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaEmail.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaPushDevice.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectOrganization.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneCountryCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneNumber.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/showError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/skipOrganizationSelection.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/snoozeEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitEmailChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitOTP.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPasskeyCredential.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPhoneChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToSms.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToText.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToVoice.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toErrorObject.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toggleView.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAgain.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAcceptInvitation.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAuth0Themes.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useConsent.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCurrentScreen.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCustomizedConsent.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivation.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationAllowed.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationDenied.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeConfirmation.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailIdentifierChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailOTPChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailVerificationResult.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useErrors.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useInterstitialCaptcha.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogin.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginEmailVerification.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginId.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginIdentifiers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessEmailCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessSmsOtp.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogout.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutAborted.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutComplete.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaBeginEnrollOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaCountryCodes.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaDetectBrowserCapabilities.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailList.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEnrollResult.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaLoginOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentQr.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPolling.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushChallengePush.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushEnrollmentQr.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushList.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushWelcome.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallengeNewCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsList.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnChangeKeyNickname.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnEnrollmentSuccess.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnNotAvailableError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationPicker.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationSelection.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollmentLocal.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasswordValidation.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useRedeemTicket.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResend.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordEmail.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaEmailChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaOtpChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPhoneChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPushChallengePush.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaRecoveryCodeChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaSmsChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaVoiceChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnPlatformChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnRoamingChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordRequest.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordSuccess.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSecurityKey.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignup.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupId.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupIdentifiers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useUsernameValidation.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/verify.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/withError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorsResult.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/MfaPollingResult.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorsResult.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendReturn.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithLoginIdentifiers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithResendManager.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithSignupIdentifiers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidatePassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidateUsername.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/accept-invitation.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/consent.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/customized-consent.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-allowed.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-denied.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-confirmation.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-identifier-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-otp-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-verification-result.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/interstitial-captcha.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-email-verification.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-id.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-password.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-email-code.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-sms-otp.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-aborted.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-complete.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-begin-enroll-options.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-country-codes.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-detect-browser-capabilities.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-list.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-enroll-result.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-login-options.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-code.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-qr.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-enrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-challenge-push.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-enrollment-qr.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-list.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-welcome.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge-new-code.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-enrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-enrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-list.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-enrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-change-key-nickname.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-enrollment-success.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-error.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-not-available-error.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-enrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-enrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-picker.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-selection.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment-local.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-enrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/redeem-ticket.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-email.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-error.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-email-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-otp-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-phone-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-push-challenge-push.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-recovery-code-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-sms-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-voice-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-platform-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-roaming-challenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-request.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-success.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-id.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-password.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Bucket.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ErrorKind.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Listener.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ScreenConstructor.mdx diff --git a/main/docs.json b/main/docs.json index 71bb30360..0d96d16c1 100644 --- a/main/docs.json +++ b/main/docs.json @@ -1702,272 +1702,401 @@ "group": "@auth0/auth0-acul-react", "pages": [ { - "group": "Classes", + "group": "Hooks", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ErrorStore", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ContextHooks" + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useAuth0Themes", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useCurrentScreen", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useErrors", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useLoginIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useMfaPolling", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/usePasswordValidation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useResend", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useSignupIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useUsernameValidation" ] }, { - "group": "Interfaces", + "group": "Screens", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorsResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorsResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithLoginIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/MfaPollingResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendReturn", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithResendManager", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithSignupIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidatePassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidateUsername", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem" + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index" ] }, { - "group": "Types", + "group": "Classes", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ErrorKind", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Bucket", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Listener", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ScreenConstructor" + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks" ] }, { - "group": "Functions", + "group": "Interfaces", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/classifyKind", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toErrorObject", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/filterByField", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/withError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/listsEqual", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/registerScreen", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getScreen", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/clearScreen", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/acceptInvitation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAcceptInvitation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/accept", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/deny", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useConsent", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCustomizedConsent", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationAllowed", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationDenied", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirm", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/cancel", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeConfirmation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailOTPChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailVerificationResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useInterstitialCaptcha", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginEmailVerification", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/passkeyLogin", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginId", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessEmailCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitOTP", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendOTP", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessSmsOtp", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogin", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutAborted", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutComplete", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirmLogout", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogout", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaBeginEnrollOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectCountryCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaCountryCodes", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/detectCapabilities", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaDetectBrowserCapabilities", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickEmail", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaEmail", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailList", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEnrollResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaLoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toggleView", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickPhone", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendPushNotification", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enterCodeManually", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickAuthenticator", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaPushDevice", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushList", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushWelcome", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallengeNewCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickSms", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getACall", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneNumber", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backAction", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsList", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToSms", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneCountryCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithNewNickname", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnChangeKeyNickname", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnEnrollmentSuccess", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAgain", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/noThanks", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnNotAvailableError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/verify", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPasskeyCredential", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/snoozeEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/refuseEnrollmentOnThisDevice", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportWebAuthnError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/showError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectOrganization", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/skipOrganizationSelection", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationPicker", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithOrganizationName", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationSelection", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/abortPasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollmentLocal", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToVoice", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToText", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePhoneEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useRedeemTicket", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendEmail", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordEmail", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaRecoveryCodeChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithPasskey", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSecurityKey", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resetPassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backToLogin", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordRequest", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordSuccess", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupId", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignup" + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AbortEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AuthorizationDetail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOTPOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinuePayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithOrganizationNameOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CredentialResponse", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledDevice", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledEmail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledPhoneNumber", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPasswordPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodePayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectCountryCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaEmailOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaPushDeviceOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectOrganizationOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCaptchaOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitOTPOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodMfaOtpChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions" ] }, { - "group": "Screens", + "group": "Type Aliases", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/accept-invitation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/consent", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/customized-consent", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-allowed", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-denied", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-confirmation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-identifier-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-otp-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-verification-result", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/interstitial-captcha", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-email-verification", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-id", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-password", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-email-code", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-sms-otp", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-aborted", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-complete", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-begin-enroll-options", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-country-codes", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-detect-browser-capabilities", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-list", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-enroll-result", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-login-options", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-code", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-qr", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-challenge-push", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-enrollment-qr", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-list", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-welcome", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge-new-code", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-list", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-change-key-nickname", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-enrollment-success", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-error", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-not-available-error", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-picker", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-selection", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment-local", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/redeem-ticket", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-email", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-error", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-email-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-otp-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-phone-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-push-challenge-push", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-recovery-code-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-sms-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-voice-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-platform-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-roaming-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-request", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-success", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-id", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-password", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup" + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/AuthenticatorTransport", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaEnrollFactorType", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaLoginFactorType", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/OnStatusChangeCallback", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ScreenIdentifierType", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType" ] } ] diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useAuth0Themes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useAuth0Themes.mdx similarity index 75% rename from main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useAuth0Themes.mdx rename to main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useAuth0Themes.mdx index 96dd0a327..a69a630db 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useAuth0Themes.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useAuth0Themes.mdx @@ -2,10 +2,16 @@ title: "useAuth0Themes" --- +> **useAuth0Themes**(): [`FlattenedTheme`](../../Types/interfaces/FlattenedTheme) \| `null` + +Defined in: [packages/auth0-acul-react/src/hooks/common/auth0-themes.ts:50](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/auth0-themes.ts#L50) + React hook to get the current theme options with flattened configuration from branding context. ## Returns +[`FlattenedTheme`](../../Types/interfaces/FlattenedTheme) \| `null` + FlattenedTheme object containing colors, fonts, borders, pageBackground, and widget configurations, or null if no branding is available ## Example @@ -48,8 +54,4 @@ const ThemedComponent: React.FC = () => { <p>Body text color: {theme.colors.body_text}</p> </div> ); -}; - ---- - -**File:** [src/hooks/common/auth0-themes.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/auth0-themes.ts) +}; \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useCurrentScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useCurrentScreen.mdx similarity index 82% rename from main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useCurrentScreen.mdx rename to main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useCurrentScreen.mdx index b6ba0e2dd..87547ae7d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useCurrentScreen.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useCurrentScreen.mdx @@ -2,6 +2,10 @@ title: "useCurrentScreen" --- +> **useCurrentScreen**(): [`CurrentScreenOptions`](../../Types/interfaces/CurrentScreenOptions) \| `null` + +Defined in: [packages/auth0-acul-react/src/hooks/common/current-screen.ts:76](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/current-screen.ts#L76) + React hook that gets the current screen context and state. This hook provides access to client configuration, organization details, screen identification, @@ -28,9 +32,11 @@ Returns `CurrentScreenOptions` object with the following properties, or `null` i ## Returns -{CurrentScreenOptions | null} Current screen context data, or `null` if not available +[`CurrentScreenOptions`](../../Types/interfaces/CurrentScreenOptions) \| `null` -## Example +Current screen context data, or `null` if not available + +## Examples Basic screen routing ```tsx @@ -53,8 +59,6 @@ const AuthFlow = () => { }; ``` -## Example - Accessing multiple properties ```tsx import { useCurrentScreen } from '@auth0/auth0-acul-react'; @@ -75,8 +79,4 @@ const CustomAuthScreen = () => { </div> ); }; -``` - ---- - -**File:** [src/hooks/common/current-screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/current-screen.ts) +``` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useErrors.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useErrors.mdx similarity index 74% rename from main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useErrors.mdx rename to main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useErrors.mdx index 893693d99..433e3a70f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useErrors.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useErrors.mdx @@ -2,25 +2,28 @@ title: "useErrors" --- +> **useErrors**(`options`): [`UseErrorsResult`](../../Types/interfaces/UseErrorsResult) + +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:134](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L134) + React hook for reading and managing errors in ACUL (Advanced Customization of Universal Login). With all validation and server-side errors. It groups errors into three kinds: - `server` — errors returned by Auth0 or your own backend. - `client` — errors from client-side validation (e.g., invalid form input). - `developer` — errors caused by incorrect integration or SDK misuse. -## Supported Screens - -- The `useErrors` hook is available on every ACUL screen. - ## Parameters -options.includeDevErrors - When `true`, developer errors are included in - the returned list. Defaults to `false`. +### options + +[`UseErrorOptions`](../../Types/interfaces/UseErrorOptions) = `{}` ## Returns -An object of type \{@link UseErrorsResult\}, containing: -- `errors` — the full error list of type \{@link ErrorsResult\}, with helpers: +[`UseErrorsResult`](../../Types/interfaces/UseErrorsResult) + +An object of type [UseErrorsResult](../../Types/interfaces/UseErrorsResult), containing: +- `errors` — the full error list of type [ErrorsResult](../../Types/interfaces/ErrorsResult), with helpers: - `errors.byKind(kind, filter?)` — filter by error kind and optionally by field. - `errors.byField(field, filter?)` — filter by field and optionally by kind. - `hasError` — `true` if any error is currently present. @@ -30,6 +33,10 @@ An object of type \{@link UseErrorsResult\}, containing: Typical usage is inside a form or screen component where you need to reactively display errors and provide ways to dismiss them: +## Supported Screens + +- The `useErrors` hook is available on every ACUL screen. + ## Example ```tsx @@ -63,8 +70,4 @@ console.log(errors.byKind('client')); // all client errors console.log(errors.byKind('client', { field: 'username' })); // client errors for field 'username' console.log(errors.byField('username')); // all errors for field 'username' console.log(errors.byField('username', { kind: 'server' })); // server errors for field 'username' -``` - ---- - -**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) +``` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useLoginIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useLoginIdentifiers.mdx similarity index 55% rename from main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useLoginIdentifiers.mdx rename to main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useLoginIdentifiers.mdx index 7d60fa9f6..bf11b7143 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useLoginIdentifiers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useLoginIdentifiers.mdx @@ -2,22 +2,27 @@ title: "useLoginIdentifiers" --- +> **useLoginIdentifiers**(): [`IdentifierType`](../../Types/type-aliases/IdentifierType)[] + +Defined in: [packages/auth0-acul-react/src/hooks/utility/login-identifiers.ts:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/login-identifiers.ts#L34) + Returns a list of active identifier types (such as `'email'`, `'phone'`, or `'username'`) currently in use in the authentication flow or login process. +## Returns + +[`IdentifierType`](../../Types/type-aliases/IdentifierType)[] + +An array of [IdentifierType](../../Types/type-aliases/IdentifierType) representing active identifiers. + ## Supported Screens - `login` - `login-id` - `reset-password-request` -## Returns - -An array of \{@link IdentifierType\} representing active identifiers. - ## Example -This example shows how to use the hook in a functional component on "login" screen. ```tsx import { useLoginIdentifiers } from '@auth0/auth0-acul-react/login'; @@ -28,8 +33,4 @@ const hasUsername = loginIdentifiers.includes('username'); // loginIdentifiers could be: // ['email', 'username'] -``` - ---- - -**File:** [src/hooks/utility/login-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/login-identifiers.ts) +``` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useMfaPolling.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useMfaPolling.mdx similarity index 74% rename from main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useMfaPolling.mdx rename to main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useMfaPolling.mdx index 4586d8a97..32e4a246b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useMfaPolling.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useMfaPolling.mdx @@ -2,6 +2,10 @@ title: "useMfaPolling" --- +> **useMfaPolling**(`options?`): [`MfaPollingResult`](../../Types/interfaces/MfaPollingResult) + +Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:106](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L106) + React hook to manage MFA push polling (e.g., waiting for a push notification approval) on an Auth0 Advanced Customization of Universal Login (ACUL) screen. @@ -21,22 +25,28 @@ the MFA push challenge endpoint until one of the following occurs: ## Parameters -options - \{@link MfaPollingOptions\} specifying the polling interval, - success callback (`onCompleted`), and optional error handler (`onError`). +### options? -## Supported Screens +[`MfaPollingOptions`](../../Types/type-aliases/MfaPollingOptions) -- `mfa-push-challenge-push` -- `reset-password-mfa-push-challenge-push` -- `mfa-push-enrollment-qr` +[MfaPollingOptions](../../Types/type-aliases/MfaPollingOptions) specifying the polling interval, + success callback (`onCompleted`), and optional error handler (`onError`). ## Returns -object \{@link MfaPollingResult\} containing: +[`MfaPollingResult`](../../Types/interfaces/MfaPollingResult) + +object [MfaPollingResult](../../Types/interfaces/MfaPollingResult) containing: - `isRunning` — `true` while polling is active. - `startPolling()` — starts or resumes polling. - `stopPolling()` — stops polling immediately. +## Supported Screens + +- `mfa-push-challenge-push` +- `reset-password-mfa-push-challenge-push` +- `mfa-push-enrollment-qr` + ## Example ```tsx @@ -62,14 +72,8 @@ export function MfaPushStatus() { ## Remarks -- The `onError` callback receives an \{@link ULError\} object +- The `onError` callback receives an [ULError](../../Types/interfaces/Error) object with `status` and `responseText` describing the server response. - Internal rate-limit responses (`429`) are automatically handled: polling waits for the reset window before retrying. -- Calling `startPolling()` repeatedly while running is safe and idempotent. - -## Public - ---- - -**File:** [src/hooks/utility/polling-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts) +- Calling `startPolling()` repeatedly while running is safe and idempotent. \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/usePasswordValidation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/usePasswordValidation.mdx similarity index 52% rename from main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/usePasswordValidation.mdx rename to main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/usePasswordValidation.mdx index 27619b265..8445ee899 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/usePasswordValidation.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/usePasswordValidation.mdx @@ -2,37 +2,48 @@ title: "usePasswordValidation" --- +> **usePasswordValidation**(`password`, `options?`): [`PasswordValidationResult`](../../Types/interfaces/PasswordValidationResult) + +Defined in: [packages/auth0-acul-react/src/hooks/utility/validate-password.ts:43](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/validate-password.ts#L43) + This React hook validates a password against the current Auth0 password policy and returns a structured result describing whether the password satisfies each rule. Optionally, it can send the validation results to the global error manager so that form error components can update automatically. -## Supported Screens +## Parameters -- `signup` -- `signup-password` -- `reset-password` +### password -## Parameters +`string` -password -- The password to validate. +The password to validate. -## Parameters +### options? + +#### includeInErrors? + +`boolean` -options.includeInErrors -- If `true`, validation errors are stored in the global error manager under the `password` field. Defaults to `false`. +If `true`, validation errors are stored in the global error manager under the `password` field. Defaults to `false`. ## Returns -A \{@link PasswordValidationResult\} object containing: +[`PasswordValidationResult`](../../Types/interfaces/PasswordValidationResult) + +A [PasswordValidationResult](../../Types/interfaces/PasswordValidationResult) object containing: - `isValid` — `true` if the password satisfies all configured rules. - `results` — an array of per-rule results with `code`, `label`, `status`, and `isValid`. +## Supported Screens + +- `signup` +- `signup-password` +- `reset-password` + ## Example -This example shows how to use the hook in a functional component on "signup" screen. ```tsx import { usePasswordValidation } from '@auth0/auth0-acul-react/signup'; const { isValid, results} = usePasswordValidation(password, { includeInErrors: true }); @@ -40,8 +51,4 @@ This example shows how to use the hook in a functional component on "signup" scr if (!isValid) { console.log(results); } -``` - ---- - -**File:** [src/hooks/utility/validate-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/validate-password.ts) +``` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useResend.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useResend.mdx similarity index 73% rename from main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useResend.mdx rename to main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useResend.mdx index d1f7a0b12..416008ca0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useResend.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useResend.mdx @@ -2,6 +2,10 @@ title: "useResend" --- +> **useResend**(`options?`): [`UseResendReturn`](../../Types/interfaces/UseResendReturn) + +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:87](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L87) + This React hook manages "resend" actions (e.g., resending a verification code) on ACUL screens. This hook: @@ -9,6 +13,23 @@ This hook: - Tells you whether the resend button should be disabled. - Provides a `startResend` function to trigger a resend immediately. +## Parameters + +### options? + +[`UseResendOptions`](../../Types/interfaces/UseResendOptions) + +Optional configuration such as `timeoutSeconds` and `onTimeout`. + +## Returns + +[`UseResendReturn`](../../Types/interfaces/UseResendReturn) + +An object with: +- `remaining` — seconds left until the next resend is permitted. +- `disabled` — `true` if resending is currently blocked. +- `startResend` — call to initiate a resend immediately (if allowed). + ## Supported Screens - `email-identifier-challenge` @@ -24,17 +45,6 @@ This hook: - `reset-password-mfa-sms-challenge` - `reset-password-mfa-voice-challenge` -## Parameters - -options - Optional configuration such as `timeoutSeconds` and `onTimeout`. - -## Returns - -An object with: -- `remaining` — seconds left until the next resend is permitted. -- `disabled` — `true` if resending is currently blocked. -- `startResend` — call to initiate a resend immediately (if allowed). - ## Example ```tsx @@ -57,8 +67,4 @@ export function ResendButton() { ## Remarks - The underlying `ResendControl` has no explicit teardown method; the hook does not require manual cleanup. -- The hook re-initializes the resend manager if `timeoutSeconds` or `onTimeout` change. - ---- - -**File:** [src/hooks/utility/resend-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts) +- The hook re-initializes the resend manager if `timeoutSeconds` or `onTimeout` change. \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useSignupIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useSignupIdentifiers.mdx similarity index 65% rename from main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useSignupIdentifiers.mdx rename to main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useSignupIdentifiers.mdx index 16c9972b6..003924e1c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useSignupIdentifiers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useSignupIdentifiers.mdx @@ -2,19 +2,25 @@ title: "useSignupIdentifiers" --- +> **useSignupIdentifiers**(): \[\] \| [`Identifier`](../../Types/interfaces/Identifier)[] + +Defined in: [packages/auth0-acul-react/src/hooks/utility/signup-identifiers.ts:42](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/signup-identifiers.ts#L42) + Returns a list of enabled identifiers (email, phone, or username), each with its `required` status, based on the current screen's signup identifiers. +## Returns + +\[\] \| [`Identifier`](../../Types/interfaces/Identifier)[] + +An array of [Identifier](../../Types/interfaces/Identifier) objects, where each contains a `type` (identifier type) +and a `required` flag indicating whether it is mandatory for signup. + ## Supported Screens - `signup` - `signup-id` -## Returns - -An array of \{@link Identifier\} objects, where each contains a `type` (identifier type) -and a `required` flag indicating whether it is mandatory for signup. - ## Example ```tsx @@ -35,8 +41,4 @@ const usernameRequired = usernameIdentifier?.required ?? false; // { type: 'phone', required: false }, // { type: 'username', required: true }, // ] -``` - ---- - -**File:** [src/hooks/utility/signup-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/signup-identifiers.ts) +``` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useUsernameValidation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useUsernameValidation.mdx similarity index 67% rename from main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useUsernameValidation.mdx rename to main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useUsernameValidation.mdx index d9bce787d..a353e5d2a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/hooks/useUsernameValidation.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useUsernameValidation.mdx @@ -2,6 +2,10 @@ title: "useUsernameValidation" --- +> **useUsernameValidation**(`username`, `options?`): [`UsernameValidationResult`](../../Types/interfaces/UsernameValidationResult) + +Defined in: [packages/auth0-acul-react/src/hooks/utility/validate-username.ts:65](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/validate-username.ts#L65) + React hook for validating a username against the current Auth0 username policy. This hook checks the provided username against all configured validation rules @@ -10,26 +14,36 @@ Optionally, it can send validation errors to the global error manager so that UI components observing the `username` field can automatically display or react to these errors. -## Supported Screens +## Parameters -- `signup` -- `signup-id` +### username -## Parameters +`string` -username - The username string to validate. +The username string to validate. -## Parameters +### options? + +#### includeInErrors? + +`boolean` -options.includeInErrors - When `true`, validation errors are stored in the +When `true`, validation errors are stored in the global error manager under the `username` field. Defaults to `false`. ## Returns -A \{@link UsernameValidationResult\} object with: +[`UsernameValidationResult`](../../Types/interfaces/UsernameValidationResult) + +A [UsernameValidationResult](../../Types/interfaces/UsernameValidationResult) object with: - `isValid` — `true` if the username satisfies all configured rules. - `errors` — an array of per-rule validation errors with `code`, `message`, and `isValid`. +## Supported Screens + +- `signup` +- `signup-id` + ## Example ```tsx @@ -62,8 +76,4 @@ export function UsernameField() { - When `includeInErrors` is enabled, the hook automatically updates the errors to the error-store which can be consumed by `useErrors` hook. -- The hook only recomputes when `username` or `options.includeInErrors` change. - ---- - -**File:** [src/hooks/utility/validate-username.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/validate-username.ts) +- The hook only recomputes when `username` or `options.includeInErrors` change. \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index.mdx new file mode 100644 index 000000000..3d6ccdebf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index.mdx @@ -0,0 +1,261 @@ +--- +title: "accept-invitation" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnAcceptInvitation">ScreenMembersOnAcceptInvitation</a>}> +> **useScreen**: () => [`ScreenMembersOnAcceptInvitation`](../../../../Types/interfaces/ScreenMembersOnAcceptInvitation) + +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnAcceptInvitation`](../../../../Types/interfaces/ScreenMembersOnAcceptInvitation) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='acceptInvitation' type={<span>void | Promise<void></span>}> +> **acceptInvitation**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L34) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useAcceptInvitation' type={<a href="../../../../Types/interfaces/AcceptInvitationMembers">AcceptInvitationMembers</a>}> +> **useAcceptInvitation**(): [`AcceptInvitationMembers`](../../../../Types/interfaces/AcceptInvitationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L49) + +**Returns** + +[`AcceptInvitationMembers`](../../../../Types/interfaces/AcceptInvitationMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index.mdx new file mode 100644 index 000000000..def634479 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index.mdx @@ -0,0 +1,277 @@ +--- +title: "consent" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L21) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L22) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L23) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L24) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnConsent">ScreenMembersOnConsent</a>}> +> **useScreen**: () => [`ScreenMembersOnConsent`](../../../../Types/interfaces/ScreenMembersOnConsent) + +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L25) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnConsent`](../../../../Types/interfaces/ScreenMembersOnConsent) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L20) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L26) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L27) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L19) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='accept' type={<span>void | Promise<void></span>}> +> **accept**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L31) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='deny' type={<span>void | Promise<void></span>}> +> **deny**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L32) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useConsent' type={<a href="../../../../Types/interfaces/ConsentMembers">ConsentMembers</a>}> +> **useConsent**(): [`ConsentMembers`](../../../../Types/interfaces/ConsentMembers) + +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:46](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L46) + +**Returns** + +[`ConsentMembers`](../../../../Types/interfaces/ConsentMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index.mdx new file mode 100644 index 000000000..515798745 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index.mdx @@ -0,0 +1,277 @@ +--- +title: "customized-consent" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnCustomizedConsent">ScreenMembersOnCustomizedConsent</a>}> +> **useScreen**: () => [`ScreenMembersOnCustomizedConsent`](../../../../Types/interfaces/ScreenMembersOnCustomizedConsent) + +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnCustomizedConsent`](../../../../Types/interfaces/ScreenMembersOnCustomizedConsent) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='accept' type={<span>void | Promise<void></span>}> +> **accept**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L34) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='deny' type={<span>void | Promise<void></span>}> +> **deny**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L35) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useCustomizedConsent' type={<a href="../../../../Types/interfaces/CustomizedConsentMembers">CustomizedConsentMembers</a>}> +> **useCustomizedConsent**(): [`CustomizedConsentMembers`](../../../../Types/interfaces/CustomizedConsentMembers) + +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L49) + +**Returns** + +[`CustomizedConsentMembers`](../../../../Types/interfaces/CustomizedConsentMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index.mdx new file mode 100644 index 000000000..ae0b3a4f3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index.mdx @@ -0,0 +1,245 @@ +--- +title: "device-code-activation-allowed" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='useDeviceCodeActivationAllowed' type={<a href="../../../../Types/interfaces/DeviceCodeActivationAllowedMembers">DeviceCodeActivationAllowedMembers</a>}> +> **useDeviceCodeActivationAllowed**(): [`DeviceCodeActivationAllowedMembers`](../../../../Types/interfaces/DeviceCodeActivationAllowedMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L38) + +**Returns** + +[`DeviceCodeActivationAllowedMembers`](../../../../Types/interfaces/DeviceCodeActivationAllowedMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index.mdx new file mode 100644 index 000000000..ebdaa969f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index.mdx @@ -0,0 +1,245 @@ +--- +title: "device-code-activation-denied" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='useDeviceCodeActivationDenied' type={<a href="../../../../Types/interfaces/DeviceCodeActivationDeniedMembers">DeviceCodeActivationDeniedMembers</a>}> +> **useDeviceCodeActivationDenied**(): [`DeviceCodeActivationDeniedMembers`](../../../../Types/interfaces/DeviceCodeActivationDeniedMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L38) + +**Returns** + +[`DeviceCodeActivationDeniedMembers`](../../../../Types/interfaces/DeviceCodeActivationDeniedMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index.mdx new file mode 100644 index 000000000..a686d5974 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index.mdx @@ -0,0 +1,261 @@ +--- +title: "device-code-activation" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L34) + +**Parameters** + +**payload** + +[`DeviceCodeActivationContinueOptions`](../../../../Types/interfaces/DeviceCodeActivationContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useDeviceCodeActivation' type={<a href="../../../../Types/interfaces/DeviceCodeActivationMembers">DeviceCodeActivationMembers</a>}> +> **useDeviceCodeActivation**(): [`DeviceCodeActivationMembers`](../../../../Types/interfaces/DeviceCodeActivationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L48) + +**Returns** + +[`DeviceCodeActivationMembers`](../../../../Types/interfaces/DeviceCodeActivationMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index.mdx new file mode 100644 index 000000000..528abee6e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index.mdx @@ -0,0 +1,277 @@ +--- +title: "device-code-confirmation" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnDeviceCodeConfirmation">ScreenMembersOnDeviceCodeConfirmation</a>}> +> **useScreen**: () => [`ScreenMembersOnDeviceCodeConfirmation`](../../../../Types/interfaces/ScreenMembersOnDeviceCodeConfirmation) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnDeviceCodeConfirmation`](../../../../Types/interfaces/ScreenMembersOnDeviceCodeConfirmation) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='cancel' type={<span>void | Promise<void></span>}> +> **cancel**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L35) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='confirm' type={<span>void | Promise<void></span>}> +> **confirm**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L34) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useDeviceCodeConfirmation' type={<a href="../../../../Types/interfaces/DeviceCodeConfirmationMembers">DeviceCodeConfirmationMembers</a>}> +> **useDeviceCodeConfirmation**(): [`DeviceCodeConfirmationMembers`](../../../../Types/interfaces/DeviceCodeConfirmationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L49) + +**Returns** + +[`DeviceCodeConfirmationMembers`](../../../../Types/interfaces/DeviceCodeConfirmationMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index.mdx new file mode 100644 index 000000000..8621d424a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index.mdx @@ -0,0 +1,295 @@ +--- +title: "email-identifier-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnEmailIdentifierChallenge">ScreenMembersOnEmailIdentifierChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnEmailIdentifierChallenge`](../../../../Types/interfaces/ScreenMembersOnEmailIdentifierChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnEmailIdentifierChallenge`](../../../../Types/interfaces/ScreenMembersOnEmailIdentifierChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='resendCode' type={<span>void | Promise<void></span>}> +> **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='returnToPrevious' type={<span>void | Promise<void></span>}> +> **returnToPrevious**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='submitEmailChallenge' type={<span>void | Promise<void></span>}> +> **submitEmailChallenge**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`EmailChallengeOptions`](../../../../Types/interfaces/EmailChallengeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useEmailIdentifierChallenge' type={<a href="../../../../Types/interfaces/EmailIdentifierChallengeMembers">EmailIdentifierChallengeMembers</a>}> +> **useEmailIdentifierChallenge**(): [`EmailIdentifierChallengeMembers`](../../../../Types/interfaces/EmailIdentifierChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:56](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L56) + +**Returns** + +[`EmailIdentifierChallengeMembers`](../../../../Types/interfaces/EmailIdentifierChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index.mdx new file mode 100644 index 000000000..9517fd874 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index.mdx @@ -0,0 +1,279 @@ +--- +title: "email-otp-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnEmailOTPChallenge">ScreenMembersOnEmailOTPChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnEmailOTPChallenge`](../../../../Types/interfaces/ScreenMembersOnEmailOTPChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnEmailOTPChallenge`](../../../../Types/interfaces/ScreenMembersOnEmailOTPChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='resendCode' type={<span>void | Promise<void></span>}> +> **resendCode**(`options?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L36) + +**Parameters** + +**options?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='submitCode' type={<span>void | Promise<void></span>}> +> **submitCode**(`options`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L35) + +**Parameters** + +**options** + +[`OtpCodeOptions`](../../../../Types/interfaces/OtpCodeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useEmailOTPChallenge' type={<a href="../../../../Types/interfaces/EmailOTPChallengeMembers">EmailOTPChallengeMembers</a>}> +> **useEmailOTPChallenge**(): [`EmailOTPChallengeMembers`](../../../../Types/interfaces/EmailOTPChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L53) + +**Returns** + +[`EmailOTPChallengeMembers`](../../../../Types/interfaces/EmailOTPChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index.mdx new file mode 100644 index 000000000..e8136cfd1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index.mdx @@ -0,0 +1,245 @@ +--- +title: "email-verification-result" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnEmailVerificationResult">ScreenMembersOnEmailVerificationResult</a>}> +> **useScreen**: () => [`ScreenMembersOnEmailVerificationResult`](../../../../Types/interfaces/ScreenMembersOnEmailVerificationResult) + +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnEmailVerificationResult`](../../../../Types/interfaces/ScreenMembersOnEmailVerificationResult) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='useEmailVerificationResult' type={<a href="../../../../Types/interfaces/EmailVerificationResultMembers">EmailVerificationResultMembers</a>}> +> **useEmailVerificationResult**(): [`EmailVerificationResultMembers`](../../../../Types/interfaces/EmailVerificationResultMembers) + +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L38) + +**Returns** + +[`EmailVerificationResultMembers`](../../../../Types/interfaces/EmailVerificationResultMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index.mdx new file mode 100644 index 000000000..64fee2017 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index.mdx @@ -0,0 +1,245 @@ +--- +title: "interstitial-captcha" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='useInterstitialCaptcha' type={<a href="../../../../Types/interfaces/InterstitialCaptchaMembers">InterstitialCaptchaMembers</a>}> +> **useInterstitialCaptcha**(): [`InterstitialCaptchaMembers`](../../../../Types/interfaces/InterstitialCaptchaMembers) + +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L38) + +**Returns** + +[`InterstitialCaptchaMembers`](../../../../Types/interfaces/InterstitialCaptchaMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index.mdx new file mode 100644 index 000000000..c3e9a930d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index.mdx @@ -0,0 +1,279 @@ +--- +title: "login-email-verification" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueWithCode' type={<span>void | Promise<void></span>}> +> **continueWithCode**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L35) + +**Parameters** + +**payload** + +[`ContinueWithCodeOptionPayload`](../../../../Types/interfaces/ContinueWithCodeOptionPayload) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='resendCode' type={<span>void | Promise<void></span>}> +> **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L37) + +**Parameters** + +**payload?** + +[`ResendCodeOptionsPayload`](../../../../Types/interfaces/ResendCodeOptionsPayload) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useLoginEmailVerification' type={<a href="../../../../Types/interfaces/LoginEmailVerificationMembers">LoginEmailVerificationMembers</a>}> +> **useLoginEmailVerification**(): [`LoginEmailVerificationMembers`](../../../../Types/interfaces/LoginEmailVerificationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L54) + +**Returns** + +[`LoginEmailVerificationMembers`](../../../../Types/interfaces/LoginEmailVerificationMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index.mdx new file mode 100644 index 000000000..0fc7f06f7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index.mdx @@ -0,0 +1,311 @@ +--- +title: "login-id" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnLoginId">ScreenMembersOnLoginId</a>}> +> **useScreen**: () => [`ScreenMembersOnLoginId`](../../../../Types/interfaces/ScreenMembersOnLoginId) + +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnLoginId`](../../../../Types/interfaces/ScreenMembersOnLoginId) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnLoginId">TransactionMembersOnLoginId</a>}> +> **useTransaction**: () => [`TransactionMembersOnLoginId`](../../../../Types/interfaces/TransactionMembersOnLoginId) + +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembersOnLoginId`](../../../../Types/interfaces/TransactionMembersOnLoginId) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='federatedLogin' type={<span>void | Promise<void></span>}> +> **federatedLogin**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L37) + +**Parameters** + +**payload** + +[`FederatedLoginOptions`](../../../../Types/interfaces/FederatedLoginOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='login' type={<span>void | Promise<void></span>}> +> **login**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L36) + +**Parameters** + +**payload** + +[`LoginOptions`](../../../../Types/interfaces/LoginOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='passkeyLogin' type={<span>void | Promise<void></span>}> +> **passkeyLogin**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='pickCountryCode' type={<span>void | Promise<void></span>}> +> **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L40) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useLoginId' type={<a href="../../../../Types/interfaces/LoginIdMembers">LoginIdMembers</a>}> +> **useLoginId**(): [`LoginIdMembers`](../../../../Types/interfaces/LoginIdMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L58) + +**Returns** + +[`LoginIdMembers`](../../../../Types/interfaces/LoginIdMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useLoginIdentifiers">useLoginIdentifiers</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index.mdx new file mode 100644 index 000000000..209286dc4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index.mdx @@ -0,0 +1,277 @@ +--- +title: "login-password" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnLoginPassword">ScreenMembersOnLoginPassword</a>}> +> **useScreen**: () => [`ScreenMembersOnLoginPassword`](../../../../Types/interfaces/ScreenMembersOnLoginPassword) + +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnLoginPassword`](../../../../Types/interfaces/ScreenMembersOnLoginPassword) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnLoginPassword">TransactionMembersOnLoginPassword</a>}> +> **useTransaction**: () => [`TransactionMembersOnLoginPassword`](../../../../Types/interfaces/TransactionMembersOnLoginPassword) + +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembersOnLoginPassword`](../../../../Types/interfaces/TransactionMembersOnLoginPassword) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='federatedLogin' type={<span>void | Promise<void></span>}> +> **federatedLogin**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L36) + +**Parameters** + +**payload** + +[`FederatedLoginPasswordOptions`](../../../../Types/interfaces/FederatedLoginPasswordOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='login' type={<span>void | Promise<void></span>}> +> **login**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L35) + +**Parameters** + +**payload** + +[`LoginPasswordOptions`](../../../../Types/interfaces/LoginPasswordOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useLoginPassword' type={<a href="../../../../Types/interfaces/LoginPasswordMembers">LoginPasswordMembers</a>}> +> **useLoginPassword**(): [`LoginPasswordMembers`](../../../../Types/interfaces/LoginPasswordMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L51) + +**Returns** + +[`LoginPasswordMembers`](../../../../Types/interfaces/LoginPasswordMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index.mdx new file mode 100644 index 000000000..1f64bb0ee --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index.mdx @@ -0,0 +1,279 @@ +--- +title: "login-passwordless-email-code" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode">ScreenMembersOnLoginPasswordlessEmailCode</a>}> +> **useScreen**: () => [`ScreenMembersOnLoginPasswordlessEmailCode`](../../../../Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnLoginPasswordlessEmailCode`](../../../../Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode">TransactionMembersOnLoginPasswordlessEmailCode</a>}> +> **useTransaction**: () => [`TransactionMembersOnLoginPasswordlessEmailCode`](../../../../Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembersOnLoginPasswordlessEmailCode`](../../../../Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='resendCode' type={<span>void | Promise<void></span>}> +> **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='submitCode' type={<span>void | Promise<void></span>}> +> **submitCode**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L35) + +**Parameters** + +**payload** + +[`SubmitCodeOptions`](../../../../Types/interfaces/SubmitCodeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useLoginPasswordlessEmailCode' type={<a href="../../../../Types/interfaces/LoginPasswordlessEmailCodeMembers">LoginPasswordlessEmailCodeMembers</a>}> +> **useLoginPasswordlessEmailCode**(): [`LoginPasswordlessEmailCodeMembers`](../../../../Types/interfaces/LoginPasswordlessEmailCodeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L53) + +**Returns** + +[`LoginPasswordlessEmailCodeMembers`](../../../../Types/interfaces/LoginPasswordlessEmailCodeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index.mdx new file mode 100644 index 000000000..7498dc10b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index.mdx @@ -0,0 +1,279 @@ +--- +title: "login-passwordless-sms-otp" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp">ScreenMembersOnLoginPasswordlessSmsOtp</a>}> +> **useScreen**: () => [`ScreenMembersOnLoginPasswordlessSmsOtp`](../../../../Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnLoginPasswordlessSmsOtp`](../../../../Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp">TransactionMembersOnLoginPasswordlessSmsOtp</a>}> +> **useTransaction**: () => [`TransactionMembersOnLoginPasswordlessSmsOtp`](../../../../Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembersOnLoginPasswordlessSmsOtp`](../../../../Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='resendOTP' type={<span>void | Promise<void></span>}> +> **resendOTP**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='submitOTP' type={<span>void | Promise<void></span>}> +> **submitOTP**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L35) + +**Parameters** + +**payload** + +[`SubmitOTPOptions`](../../../../Types/interfaces/SubmitOTPOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useLoginPasswordlessSmsOtp' type={<a href="../../../../Types/interfaces/LoginPasswordlessSmsOtpMembers">LoginPasswordlessSmsOtpMembers</a>}> +> **useLoginPasswordlessSmsOtp**(): [`LoginPasswordlessSmsOtpMembers`](../../../../Types/interfaces/LoginPasswordlessSmsOtpMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L53) + +**Returns** + +[`LoginPasswordlessSmsOtpMembers`](../../../../Types/interfaces/LoginPasswordlessSmsOtpMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index.mdx new file mode 100644 index 000000000..1d2202a86 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index.mdx @@ -0,0 +1,295 @@ +--- +title: "login" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnLogin">ScreenMembersOnLogin</a>}> +> **useScreen**: () => [`ScreenMembersOnLogin`](../../../../Types/interfaces/ScreenMembersOnLogin) + +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnLogin`](../../../../Types/interfaces/ScreenMembersOnLogin) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnLogin">TransactionMembersOnLogin</a>}> +> **useTransaction**: () => [`TransactionMembersOnLogin`](../../../../Types/interfaces/TransactionMembersOnLogin) + +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembersOnLogin`](../../../../Types/interfaces/TransactionMembersOnLogin) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='federatedLogin' type={<span>void | Promise<void></span>}> +> **federatedLogin**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L37) + +**Parameters** + +**payload** + +[`FederatedLoginPayloadOptions`](../../../../Types/interfaces/FederatedLoginPayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='login' type={<span>void | Promise<void></span>}> +> **login**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L36) + +**Parameters** + +**payload** + +[`LoginPayloadOptions`](../../../../Types/interfaces/LoginPayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='pickCountryCode' type={<span>void | Promise<void></span>}> +> **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useLogin' type={<a href="../../../../Types/interfaces/LoginMembers">LoginMembers</a>}> +> **useLogin**(): [`LoginMembers`](../../../../Types/interfaces/LoginMembers) + +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:57](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L57) + +**Returns** + +[`LoginMembers`](../../../../Types/interfaces/LoginMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useLoginIdentifiers">useLoginIdentifiers</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index.mdx new file mode 100644 index 000000000..3e8373fa4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index.mdx @@ -0,0 +1,245 @@ +--- +title: "logout-aborted" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='useLogoutAborted' type={<a href="../../../../Types/interfaces/LogoutAbortedMembers">LogoutAbortedMembers</a>}> +> **useLogoutAborted**(): [`LogoutAbortedMembers`](../../../../Types/interfaces/LogoutAbortedMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L38) + +**Returns** + +[`LogoutAbortedMembers`](../../../../Types/interfaces/LogoutAbortedMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index.mdx new file mode 100644 index 000000000..0e45a700c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index.mdx @@ -0,0 +1,245 @@ +--- +title: "logout-complete" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='useLogoutComplete' type={<a href="../../../../Types/interfaces/LogoutCompleteMembers">LogoutCompleteMembers</a>}> +> **useLogoutComplete**(): [`LogoutCompleteMembers`](../../../../Types/interfaces/LogoutCompleteMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L38) + +**Returns** + +[`LogoutCompleteMembers`](../../../../Types/interfaces/LogoutCompleteMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index.mdx new file mode 100644 index 000000000..3a4830c30 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index.mdx @@ -0,0 +1,261 @@ +--- +title: "logout" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L21) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L22) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L23) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L24) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L25) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L20) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L26) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L27) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L19) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='confirmLogout' type={<span>void | Promise<void></span>}> +> **confirmLogout**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L31) + +**Parameters** + +**payload** + +[`ConfirmLogoutOptions`](../../../../Types/interfaces/ConfirmLogoutOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useLogout' type={<a href="../../../../Types/interfaces/LogoutMembers">LogoutMembers</a>}> +> **useLogout**(): [`LogoutMembers`](../../../../Types/interfaces/LogoutMembers) + +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:46](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L46) + +**Returns** + +[`LogoutMembers`](../../../../Types/interfaces/LogoutMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index.mdx new file mode 100644 index 000000000..7dcb2d136 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index.mdx @@ -0,0 +1,261 @@ +--- +title: "mfa-begin-enroll-options" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='enroll' type={<span>void | Promise<void></span>}> +> **enroll**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L34) + +**Parameters** + +**payload** + +[`MfaEnrollOptions`](../../../../Types/interfaces/MfaEnrollOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaBeginEnrollOptions' type={<a href="../../../../Types/interfaces/MfaBeginEnrollOptionsMembers">MfaBeginEnrollOptionsMembers</a>}> +> **useMfaBeginEnrollOptions**(): [`MfaBeginEnrollOptionsMembers`](../../../../Types/interfaces/MfaBeginEnrollOptionsMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L48) + +**Returns** + +[`MfaBeginEnrollOptionsMembers`](../../../../Types/interfaces/MfaBeginEnrollOptionsMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index.mdx new file mode 100644 index 000000000..545b696f5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index.mdx @@ -0,0 +1,277 @@ +--- +title: "mfa-country-codes" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaCountryCodes">ScreenMembersOnMfaCountryCodes</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaCountryCodes`](../../../../Types/interfaces/ScreenMembersOnMfaCountryCodes) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaCountryCodes`](../../../../Types/interfaces/ScreenMembersOnMfaCountryCodes) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='goBack' type={<span>void | Promise<void></span>}> +> **goBack**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='selectCountryCode' type={<span>void | Promise<void></span>}> +> **selectCountryCode**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L35) + +**Parameters** + +**payload** + +[`SelectCountryCodeOptions`](../../../../Types/interfaces/SelectCountryCodeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaCountryCodes' type={<a href="../../../../Types/interfaces/MfaCountryCodesMembers">MfaCountryCodesMembers</a>}> +> **useMfaCountryCodes**(): [`MfaCountryCodesMembers`](../../../../Types/interfaces/MfaCountryCodesMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L51) + +**Returns** + +[`MfaCountryCodesMembers`](../../../../Types/interfaces/MfaCountryCodesMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index.mdx new file mode 100644 index 000000000..4ae85e913 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index.mdx @@ -0,0 +1,261 @@ +--- +title: "mfa-detect-browser-capabilities" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='detectCapabilities' type={<span>void | Promise<void></span>}> +> **detectCapabilities**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L34) + +**Parameters** + +**payload** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaDetectBrowserCapabilities' type={<a href="../../../../Types/interfaces/MfaDetectBrowserCapabilitiesMembers">MfaDetectBrowserCapabilitiesMembers</a>}> +> **useMfaDetectBrowserCapabilities**(): [`MfaDetectBrowserCapabilitiesMembers`](../../../../Types/interfaces/MfaDetectBrowserCapabilitiesMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L49) + +**Returns** + +[`MfaDetectBrowserCapabilitiesMembers`](../../../../Types/interfaces/MfaDetectBrowserCapabilitiesMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index.mdx new file mode 100644 index 000000000..0302e9f4e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index.mdx @@ -0,0 +1,311 @@ +--- +title: "mfa-email-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L27) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L28) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L29) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L30) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaEmailChallenge">ScreenMembersOnMfaEmailChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaEmailChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaEmailChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L31) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaEmailChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaEmailChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L26) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L32) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge">UntrustedDataMembersOnMfaEmailChallenge</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembersOnMfaEmailChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L33) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembersOnMfaEmailChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L25) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L37) + +**Parameters** + +**payload** + +[`ContinuePayloadOptions`](../../../../Types/interfaces/ContinuePayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='pickEmail' type={<span>void | Promise<void></span>}> +> **pickEmail**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:41](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L41) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='resendCode' type={<span>void | Promise<void></span>}> +> **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`ResendCodePayloadOptions`](../../../../Types/interfaces/ResendCodePayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L39) + +**Parameters** + +**payload?** + +[`TryAnotherMethodPayloadOptions`](../../../../Types/interfaces/TryAnotherMethodPayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaEmailChallenge' type={<a href="../../../../Types/interfaces/MfaEmailChallengeMembers">MfaEmailChallengeMembers</a>}> +> **useMfaEmailChallenge**(): [`MfaEmailChallengeMembers`](../../../../Types/interfaces/MfaEmailChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L58) + +**Returns** + +[`MfaEmailChallengeMembers`](../../../../Types/interfaces/MfaEmailChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index.mdx new file mode 100644 index 000000000..8294f2dfb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index.mdx @@ -0,0 +1,277 @@ +--- +title: "mfa-email-list" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaEmailList">ScreenMembersOnMfaEmailList</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaEmailList`](../../../../Types/interfaces/ScreenMembersOnMfaEmailList) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaEmailList`](../../../../Types/interfaces/ScreenMembersOnMfaEmailList) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='goBack' type={<span>void | Promise<void></span>}> +> **goBack**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='selectMfaEmail' type={<span>void | Promise<void></span>}> +> **selectMfaEmail**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L35) + +**Parameters** + +**payload** + +[`SelectMfaEmailOptions`](../../../../Types/interfaces/SelectMfaEmailOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaEmailList' type={<a href="../../../../Types/interfaces/MfaEmailListMembers">MfaEmailListMembers</a>}> +> **useMfaEmailList**(): [`MfaEmailListMembers`](../../../../Types/interfaces/MfaEmailListMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L51) + +**Returns** + +[`MfaEmailListMembers`](../../../../Types/interfaces/MfaEmailListMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index.mdx new file mode 100644 index 000000000..6a7927a0f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index.mdx @@ -0,0 +1,245 @@ +--- +title: "mfa-enroll-result" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaEnrollResult">ScreenMembersOnMfaEnrollResult</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaEnrollResult`](../../../../Types/interfaces/ScreenMembersOnMfaEnrollResult) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaEnrollResult`](../../../../Types/interfaces/ScreenMembersOnMfaEnrollResult) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='useMfaEnrollResult' type={<a href="../../../../Types/interfaces/MfaEnrollResultMembers">MfaEnrollResultMembers</a>}> +> **useMfaEnrollResult**(): [`MfaEnrollResultMembers`](../../../../Types/interfaces/MfaEnrollResultMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L38) + +**Returns** + +[`MfaEnrollResultMembers`](../../../../Types/interfaces/MfaEnrollResultMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index.mdx new file mode 100644 index 000000000..fe60b9d46 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index.mdx @@ -0,0 +1,277 @@ +--- +title: "mfa-login-options" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaLoginOptions">ScreenMembersOnMfaLoginOptions</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaLoginOptions`](../../../../Types/interfaces/ScreenMembersOnMfaLoginOptions) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaLoginOptions`](../../../../Types/interfaces/ScreenMembersOnMfaLoginOptions) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='enroll' type={<span>void | Promise<void></span>}> +> **enroll**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L35) + +**Parameters** + +**payload** + +[`LoginEnrollOptions`](../../../../Types/interfaces/LoginEnrollOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='returnToPrevious' type={<span>void | Promise<void></span>}> +> **returnToPrevious**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaLoginOptions' type={<a href="../../../../Types/interfaces/MfaLoginOptionsMembers">MfaLoginOptionsMembers</a>}> +> **useMfaLoginOptions**(): [`MfaLoginOptionsMembers`](../../../../Types/interfaces/MfaLoginOptionsMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L51) + +**Returns** + +[`MfaLoginOptionsMembers`](../../../../Types/interfaces/MfaLoginOptionsMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index.mdx new file mode 100644 index 000000000..67e520cc6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index.mdx @@ -0,0 +1,277 @@ +--- +title: "mfa-otp-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaOtpChallenge">ScreenMembersOnMfaOtpChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaOtpChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaOtpChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaOtpChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaOtpChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge">UntrustedDataMembersOnMfaOtpChallenge</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembersOnMfaOtpChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembersOnMfaOtpChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`ContinueOTPOptions`](../../../../Types/interfaces/ContinueOTPOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L36) + +**Parameters** + +**payload?** + +[`TryAnotherMethodMfaOtpChallengeOptions`](../../../../Types/interfaces/TryAnotherMethodMfaOtpChallengeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaOtpChallenge' type={<a href="../../../../Types/interfaces/MfaOtpChallengeMembers">MfaOtpChallengeMembers</a>}> +> **useMfaOtpChallenge**(): [`MfaOtpChallengeMembers`](../../../../Types/interfaces/MfaOtpChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L51) + +**Returns** + +[`MfaOtpChallengeMembers`](../../../../Types/interfaces/MfaOtpChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index.mdx new file mode 100644 index 000000000..308525819 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index.mdx @@ -0,0 +1,277 @@ +--- +title: "mfa-otp-enrollment-code" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode">ScreenMembersOnMfaOtpEnrollmentCode</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaOtpEnrollmentCode`](../../../../Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaOtpEnrollmentCode`](../../../../Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L35) + +**Parameters** + +**payload** + +[`MfaOtpContinueOptions`](../../../../Types/interfaces/MfaOtpContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L36) + +**Parameters** + +**payload?** + +[`MfaOtpTryAnotherMethodOptions`](../../../../Types/interfaces/MfaOtpTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaOtpEnrollmentCode' type={<a href="../../../../Types/interfaces/MfaOtpEnrollmentCodeMembers">MfaOtpEnrollmentCodeMembers</a>}> +> **useMfaOtpEnrollmentCode**(): [`MfaOtpEnrollmentCodeMembers`](../../../../Types/interfaces/MfaOtpEnrollmentCodeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L51) + +**Returns** + +[`MfaOtpEnrollmentCodeMembers`](../../../../Types/interfaces/MfaOtpEnrollmentCodeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index.mdx new file mode 100644 index 000000000..c6e44a071 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index.mdx @@ -0,0 +1,293 @@ +--- +title: "mfa-otp-enrollment-qr" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr">ScreenMembersOnMfaOtpEnrollmentQr</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaOtpEnrollmentQr`](../../../../Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaOtpEnrollmentQr`](../../../../Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L36) + +**Parameters** + +**payload** + +[`MfaOtpEnrollmentQrContinueOptions`](../../../../Types/interfaces/MfaOtpEnrollmentQrContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='toggleView' type={<span>void | Promise<void></span>}> +> **toggleView**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L35) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaOtpEnrollmentQr' type={<a href="../../../../Types/interfaces/MfaOtpEnrollmentQrMembers">MfaOtpEnrollmentQrMembers</a>}> +> **useMfaOtpEnrollmentQr**(): [`MfaOtpEnrollmentQrMembers`](../../../../Types/interfaces/MfaOtpEnrollmentQrMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L52) + +**Returns** + +[`MfaOtpEnrollmentQrMembers`](../../../../Types/interfaces/MfaOtpEnrollmentQrMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index.mdx new file mode 100644 index 000000000..d3afbcdce --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index.mdx @@ -0,0 +1,293 @@ +--- +title: "mfa-phone-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaPhoneChallenge">ScreenMembersOnMfaPhoneChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaPhoneChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaPhoneChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaPhoneChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaPhoneChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L36) + +**Parameters** + +**payload** + +[`MfaPhoneChallengeContinueOptions`](../../../../Types/interfaces/MfaPhoneChallengeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='pickPhone' type={<span>void | Promise<void></span>}> +> **pickPhone**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L37) + +**Parameters** + +**payload?** + +[`MfaPhoneChallengePickPhoneOptions`](../../../../Types/interfaces/MfaPhoneChallengePickPhoneOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`MfaPhoneChallengePickAuthenticatorOptions`](../../../../Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaPhoneChallenge' type={<a href="../../../../Types/interfaces/MfaPhoneChallengeMembers">MfaPhoneChallengeMembers</a>}> +> **useMfaPhoneChallenge**(): [`MfaPhoneChallengeMembers`](../../../../Types/interfaces/MfaPhoneChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L53) + +**Returns** + +[`MfaPhoneChallengeMembers`](../../../../Types/interfaces/MfaPhoneChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index.mdx new file mode 100644 index 000000000..494496bf8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index.mdx @@ -0,0 +1,293 @@ +--- +title: "mfa-phone-enrollment" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueEnrollment' type={<span>void | Promise<void></span>}> +> **continueEnrollment**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L37) + +**Parameters** + +**payload** + +[`MfaPhoneEnrollmentContinueOptions`](../../../../Types/interfaces/MfaPhoneEnrollmentContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='pickCountryCode' type={<span>void | Promise<void></span>}> +> **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L35) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaPhoneEnrollment' type={<a href="../../../../Types/interfaces/MfaPhoneEnrollmentMembers">MfaPhoneEnrollmentMembers</a>}> +> **useMfaPhoneEnrollment**(): [`MfaPhoneEnrollmentMembers`](../../../../Types/interfaces/MfaPhoneEnrollmentMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L54) + +**Returns** + +[`MfaPhoneEnrollmentMembers`](../../../../Types/interfaces/MfaPhoneEnrollmentMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index.mdx new file mode 100644 index 000000000..1ec475087 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index.mdx @@ -0,0 +1,311 @@ +--- +title: "mfa-push-challenge-push" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaPushChallengePush">ScreenMembersOnMfaPushChallengePush</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaPushChallengePush`](../../../../Types/interfaces/ScreenMembersOnMfaPushChallengePush) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaPushChallengePush`](../../../../Types/interfaces/ScreenMembersOnMfaPushChallengePush) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush">UntrustedDataMembersOnMfaPushChallengePush</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembersOnMfaPushChallengePush`](../../../../Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembersOnMfaPushChallengePush`](../../../../Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L35) + +**Parameters** + +**payload?** + +[`WithRememberOptions`](../../../../Types/interfaces/WithRememberOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='enterCodeManually' type={<span>void | Promise<void></span>}> +> **enterCodeManually**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='resendPushNotification' type={<span>void | Promise<void></span>}> +> **resendPushNotification**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L37) + +**Parameters** + +**payload?** + +[`WithRememberOptions`](../../../../Types/interfaces/WithRememberOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:41](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L41) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaPushChallengePush' type={<a href="../../../../Types/interfaces/MfaPushChallengePushMembers">MfaPushChallengePushMembers</a>}> +> **useMfaPushChallengePush**(): [`MfaPushChallengePushMembers`](../../../../Types/interfaces/MfaPushChallengePushMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L59) + +**Returns** + +[`MfaPushChallengePushMembers`](../../../../Types/interfaces/MfaPushChallengePushMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useMfaPolling">useMfaPolling</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index.mdx new file mode 100644 index 000000000..0190b8ea0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index.mdx @@ -0,0 +1,263 @@ +--- +title: "mfa-push-enrollment-qr" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr">ScreenMembersOnMfaPushEnrollmentQr</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaPushEnrollmentQr`](../../../../Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaPushEnrollmentQr`](../../../../Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='pickAuthenticator' type={<span>void | Promise<void></span>}> +> **pickAuthenticator**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L34) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaPushEnrollmentQr' type={<a href="../../../../Types/interfaces/MfaPushEnrollmentQrMembers">MfaPushEnrollmentQrMembers</a>}> +> **useMfaPushEnrollmentQr**(): [`MfaPushEnrollmentQrMembers`](../../../../Types/interfaces/MfaPushEnrollmentQrMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L52) + +**Returns** + +[`MfaPushEnrollmentQrMembers`](../../../../Types/interfaces/MfaPushEnrollmentQrMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useMfaPolling">useMfaPolling</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index.mdx new file mode 100644 index 000000000..9c3dc5a15 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index.mdx @@ -0,0 +1,277 @@ +--- +title: "mfa-push-list" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='goBack' type={<span>void | Promise<void></span>}> +> **goBack**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='selectMfaPushDevice' type={<span>void | Promise<void></span>}> +> **selectMfaPushDevice**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L35) + +**Parameters** + +**payload** + +[`SelectMfaPushDeviceOptions`](../../../../Types/interfaces/SelectMfaPushDeviceOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaPushList' type={<a href="../../../../Types/interfaces/MfaPushListMembers">MfaPushListMembers</a>}> +> **useMfaPushList**(): [`MfaPushListMembers`](../../../../Types/interfaces/MfaPushListMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L51) + +**Returns** + +[`MfaPushListMembers`](../../../../Types/interfaces/MfaPushListMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index.mdx new file mode 100644 index 000000000..c29736bf1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index.mdx @@ -0,0 +1,277 @@ +--- +title: "mfa-push-welcome" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L21) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L22) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L23) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L24) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaPushWelcome">ScreenMembersOnMfaPushWelcome</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaPushWelcome`](../../../../Types/interfaces/ScreenMembersOnMfaPushWelcome) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L25) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaPushWelcome`](../../../../Types/interfaces/ScreenMembersOnMfaPushWelcome) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L20) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L26) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L27) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L19) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='enroll' type={<span>void | Promise<void></span>}> +> **enroll**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L31) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='pickAuthenticator' type={<span>void | Promise<void></span>}> +> **pickAuthenticator**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L32) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaPushWelcome' type={<a href="../../../../Types/interfaces/MfaPushWelcomeMembers">MfaPushWelcomeMembers</a>}> +> **useMfaPushWelcome**(): [`MfaPushWelcomeMembers`](../../../../Types/interfaces/MfaPushWelcomeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:47](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L47) + +**Returns** + +[`MfaPushWelcomeMembers`](../../../../Types/interfaces/MfaPushWelcomeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index.mdx new file mode 100644 index 000000000..eafd616d3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index.mdx @@ -0,0 +1,261 @@ +--- +title: "mfa-recovery-code-challenge-new-code" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode">ScreenMembersOnMfaRecoveryCodeChallengeNewCode</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](../../../../Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](../../../../Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L36) + +**Parameters** + +**payload?** + +[`MfaRecoveryCodeChallengeNewCodeContinueOptions`](../../../../Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaRecoveryCodeChallengeNewCode' type={<a href="../../../../Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers">MfaRecoveryCodeChallengeNewCodeMembers</a>}> +> **useMfaRecoveryCodeChallengeNewCode**(): [`MfaRecoveryCodeChallengeNewCodeMembers`](../../../../Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:50](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L50) + +**Returns** + +[`MfaRecoveryCodeChallengeNewCodeMembers`](../../../../Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index.mdx new file mode 100644 index 000000000..4d27021e1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index.mdx @@ -0,0 +1,277 @@ +--- +title: "mfa-recovery-code-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`MfaRecoveryCodeChallengeContinueOptions`](../../../../Types/interfaces/MfaRecoveryCodeChallengeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaRecoveryCodeChallenge' type={<a href="../../../../Types/interfaces/MfaRecoveryCodeChallengeMembers">MfaRecoveryCodeChallengeMembers</a>}> +> **useMfaRecoveryCodeChallenge**(): [`MfaRecoveryCodeChallengeMembers`](../../../../Types/interfaces/MfaRecoveryCodeChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L51) + +**Returns** + +[`MfaRecoveryCodeChallengeMembers`](../../../../Types/interfaces/MfaRecoveryCodeChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index.mdx new file mode 100644 index 000000000..5e4e260f4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index.mdx @@ -0,0 +1,261 @@ +--- +title: "mfa-recovery-code-enrollment" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment">ScreenMembersOnMfaRecoveryCodeEnrollment</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaRecoveryCodeEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaRecoveryCodeEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L34) + +**Parameters** + +**payload** + +[`MfaRecoveryCodeEnrollmentContinueOptions`](../../../../Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaRecoveryCodeEnrollment' type={<a href="../../../../Types/interfaces/MfaRecoveryCodeEnrollmentMembers">MfaRecoveryCodeEnrollmentMembers</a>}> +> **useMfaRecoveryCodeEnrollment**(): [`MfaRecoveryCodeEnrollmentMembers`](../../../../Types/interfaces/MfaRecoveryCodeEnrollmentMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L49) + +**Returns** + +[`MfaRecoveryCodeEnrollmentMembers`](../../../../Types/interfaces/MfaRecoveryCodeEnrollmentMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index.mdx new file mode 100644 index 000000000..9dadb0abd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index.mdx @@ -0,0 +1,327 @@ +--- +title: "mfa-sms-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaSmsChallenge">ScreenMembersOnMfaSmsChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaSmsChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaSmsChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaSmsChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaSmsChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge">UntrustedDataMembersOnMfaSmsChallenge</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembersOnMfaSmsChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembersOnMfaSmsChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMfaSmsChallenge' type={<span>void | Promise<void></span>}> +> **continueMfaSmsChallenge**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`MfaSmsChallengeOptions`](../../../../Types/interfaces/MfaSmsChallengeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='getACall' type={<span>void | Promise<void></span>}> +> **getACall**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:41](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L41) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='pickSms' type={<span>void | Promise<void></span>}> +> **pickSms**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='resendCode' type={<span>void | Promise<void></span>}> +> **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaSmsChallenge' type={<a href="../../../../Types/interfaces/MfaSmsChallengeMembers">MfaSmsChallengeMembers</a>}> +> **useMfaSmsChallenge**(): [`MfaSmsChallengeMembers`](../../../../Types/interfaces/MfaSmsChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L58) + +**Returns** + +[`MfaSmsChallengeMembers`](../../../../Types/interfaces/MfaSmsChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index.mdx new file mode 100644 index 000000000..933f557f7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index.mdx @@ -0,0 +1,299 @@ +--- +title: "mfa-sms-enrollment" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaSmsEnrollment">ScreenMembersOnMfaSmsEnrollment</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaSmsEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaSmsEnrollment) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaSmsEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaSmsEnrollment) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueEnrollment' type={<span>void | Promise<void></span>}> +> **continueEnrollment**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L36) + +**Parameters** + +**payload** + +**phone** + +`string` + +**captcha?** + +`string` + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='pickCountryCode' type={<span>void | Promise<void></span>}> +> **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L34) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaSmsEnrollment' type={<a href="../../../../Types/interfaces/MfaSmsEnrollmentMembers">MfaSmsEnrollmentMembers</a>}> +> **useMfaSmsEnrollment**(): [`MfaSmsEnrollmentMembers`](../../../../Types/interfaces/MfaSmsEnrollmentMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L53) + +**Returns** + +[`MfaSmsEnrollmentMembers`](../../../../Types/interfaces/MfaSmsEnrollmentMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index.mdx new file mode 100644 index 000000000..6b3a25b8a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index.mdx @@ -0,0 +1,277 @@ +--- +title: "mfa-sms-list" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='backAction' type={<span>void | Promise<void></span>}> +> **backAction**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='selectPhoneNumber' type={<span>void | Promise<void></span>}> +> **selectPhoneNumber**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L35) + +**Parameters** + +**payload?** + +[`MfaSmsListOptions`](../../../../Types/interfaces/MfaSmsListOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaSmsList' type={<a href="../../../../Types/interfaces/MfaSmsListMembers">MfaSmsListMembers</a>}> +> **useMfaSmsList**(): [`MfaSmsListMembers`](../../../../Types/interfaces/MfaSmsListMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L51) + +**Returns** + +[`MfaSmsListMembers`](../../../../Types/interfaces/MfaSmsListMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index.mdx new file mode 100644 index 000000000..c5ce0c227 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index.mdx @@ -0,0 +1,327 @@ +--- +title: "mfa-voice-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaVoiceChallenge">ScreenMembersOnMfaVoiceChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaVoiceChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaVoiceChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaVoiceChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaVoiceChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge">UntrustedDataMembersOnMfaVoiceChallenge</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembersOnMfaVoiceChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembersOnMfaVoiceChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`MfaVoiceChallengeContinueOptions`](../../../../Types/interfaces/MfaVoiceChallengeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='pickPhone' type={<span>void | Promise<void></span>}> +> **pickPhone**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='resendCode' type={<span>void | Promise<void></span>}> +> **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='switchToSms' type={<span>void | Promise<void></span>}> +> **switchToSms**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L40) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaVoiceChallenge' type={<a href="../../../../Types/interfaces/MfaVoiceChallengeMembers">MfaVoiceChallengeMembers</a>}> +> **useMfaVoiceChallenge**(): [`MfaVoiceChallengeMembers`](../../../../Types/interfaces/MfaVoiceChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L58) + +**Returns** + +[`MfaVoiceChallengeMembers`](../../../../Types/interfaces/MfaVoiceChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index.mdx new file mode 100644 index 000000000..8deaa0a1f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index.mdx @@ -0,0 +1,293 @@ +--- +title: "mfa-voice-enrollment" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L35) + +**Parameters** + +**payload** + +[`MfaVoiceEnrollmentContinueOptions`](../../../../Types/interfaces/MfaVoiceEnrollmentContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='selectPhoneCountryCode' type={<span>void | Promise<void></span>}> +> **selectPhoneCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaVoiceEnrollment' type={<a href="../../../../Types/interfaces/MfaVoiceEnrollmentMembers">MfaVoiceEnrollmentMembers</a>}> +> **useMfaVoiceEnrollment**(): [`MfaVoiceEnrollmentMembers`](../../../../Types/interfaces/MfaVoiceEnrollmentMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L53) + +**Returns** + +[`MfaVoiceEnrollmentMembers`](../../../../Types/interfaces/MfaVoiceEnrollmentMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index.mdx new file mode 100644 index 000000000..b05a226e4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index.mdx @@ -0,0 +1,261 @@ +--- +title: "mfa-webauthn-change-key-nickname" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname">ScreenMembersOnMfaWebAuthnChangeKeyNickname</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueWithNewNickname' type={<span>void | Promise<void></span>}> +> **continueWithNewNickname**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L34) + +**Parameters** + +**payload** + +[`MfaWebAuthnChangeKeyNicknameContinueOptions`](../../../../Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaWebAuthnChangeKeyNickname' type={<a href="../../../../Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers">MfaWebAuthnChangeKeyNicknameMembers</a>}> +> **useMfaWebAuthnChangeKeyNickname**(): [`MfaWebAuthnChangeKeyNicknameMembers`](../../../../Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L49) + +**Returns** + +[`MfaWebAuthnChangeKeyNicknameMembers`](../../../../Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index.mdx new file mode 100644 index 000000000..3df26d093 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index.mdx @@ -0,0 +1,261 @@ +--- +title: "mfa-webauthn-enrollment-success" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess">ScreenMembersOnMfaWebAuthnEnrollmentSuccess</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L34) + +**Parameters** + +**payload?** + +[`WebAuthnEnrollSuccessContinueOptions`](../../../../Types/interfaces/WebAuthnEnrollSuccessContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaWebAuthnEnrollmentSuccess' type={<a href="../../../../Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers">MfaWebAuthnEnrollmentSuccessMembers</a>}> +> **useMfaWebAuthnEnrollmentSuccess**(): [`MfaWebAuthnEnrollmentSuccessMembers`](../../../../Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L48) + +**Returns** + +[`MfaWebAuthnEnrollmentSuccessMembers`](../../../../Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index.mdx new file mode 100644 index 000000000..05a00b8aa --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index.mdx @@ -0,0 +1,309 @@ +--- +title: "mfa-webauthn-error" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnError">ScreenMembersOnMfaWebAuthnError</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnError`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnError) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaWebAuthnError`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnError) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='noThanks' type={<span>void | Promise<void></span>}> +> **noThanks**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAgain' type={<span>void | Promise<void></span>}> +> **tryAgain**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L34) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaWebAuthnError' type={<a href="../../../../Types/interfaces/MfaWebAuthnErrorMembers">MfaWebAuthnErrorMembers</a>}> +> **useMfaWebAuthnError**(): [`MfaWebAuthnErrorMembers`](../../../../Types/interfaces/MfaWebAuthnErrorMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L52) + +**Returns** + +[`MfaWebAuthnErrorMembers`](../../../../Types/interfaces/MfaWebAuthnErrorMembers) +</ParamField> + +<ParamField body='usePassword' type={<span>void | Promise<void></span>}> +> **usePassword**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L35) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index.mdx new file mode 100644 index 000000000..9d5a0ec5d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index.mdx @@ -0,0 +1,261 @@ +--- +title: "mfa-webauthn-not-available-error" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L34) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaWebAuthnNotAvailableError' type={<a href="../../../../Types/interfaces/MfaWebAuthnNotAvailableErrorMembers">MfaWebAuthnNotAvailableErrorMembers</a>}> +> **useMfaWebAuthnNotAvailableError**(): [`MfaWebAuthnNotAvailableErrorMembers`](../../../../Types/interfaces/MfaWebAuthnNotAvailableErrorMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L49) + +**Returns** + +[`MfaWebAuthnNotAvailableErrorMembers`](../../../../Types/interfaces/MfaWebAuthnNotAvailableErrorMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index.mdx new file mode 100644 index 000000000..a6d41c390 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index.mdx @@ -0,0 +1,293 @@ +--- +title: "mfa-webauthn-platform-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge">ScreenMembersOnMfaWebAuthnPlatformChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnPlatformChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaWebAuthnPlatformChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='reportBrowserError' type={<span>void | Promise<void></span>}> +> **reportBrowserError**(`options`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L38) + +**Parameters** + +**options** + +[`MfaWebAuthnPlatformChallengeReportErrorOptions`](../../../../Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`options?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L40) + +**Parameters** + +**options?** + +[`MfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](../../../../Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaWebAuthnPlatformChallenge' type={<a href="../../../../Types/interfaces/MfaWebAuthnPlatformChallengeMembers">MfaWebAuthnPlatformChallengeMembers</a>}> +> **useMfaWebAuthnPlatformChallenge**(): [`MfaWebAuthnPlatformChallengeMembers`](../../../../Types/interfaces/MfaWebAuthnPlatformChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:55](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L55) + +**Returns** + +[`MfaWebAuthnPlatformChallengeMembers`](../../../../Types/interfaces/MfaWebAuthnPlatformChallengeMembers) +</ParamField> + +<ParamField body='verify' type={<span>void | Promise<void></span>}> +> **verify**(`options?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L36) + +**Parameters** + +**options?** + +[`VerifyPlatformAuthenticatorOptions`](../../../../Types/interfaces/VerifyPlatformAuthenticatorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index.mdx new file mode 100644 index 000000000..6ffc1897f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index.mdx @@ -0,0 +1,309 @@ +--- +title: "mfa-webauthn-platform-enrollment" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L28) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L29) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L30) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L31) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment">ScreenMembersOnMfaWebAuthnPlatformEnrollment</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L32) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L27) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L33) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L34) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L26) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='refuseEnrollmentOnThisDevice' type={<span>void | Promise<void></span>}> +> **refuseEnrollmentOnThisDevice**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:44](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L44) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='reportBrowserError' type={<span>void | Promise<void></span>}> +> **reportBrowserError**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L40) + +**Parameters** + +**payload** + +[`ReportBrowserErrorOptions`](../../../../Types/interfaces/ReportBrowserErrorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='snoozeEnrollment' type={<span>void | Promise<void></span>}> +> **snoozeEnrollment**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:42](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L42) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='submitPasskeyCredential' type={<span>void | Promise<void></span>}> +> **submitPasskeyCredential**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L38) + +**Parameters** + +**payload?** + +[`SubmitPasskeyCredentialOptions`](../../../../Types/interfaces/SubmitPasskeyCredentialOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaWebAuthnPlatformEnrollment' type={<a href="../../../../Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers">MfaWebAuthnPlatformEnrollmentMembers</a>}> +> **useMfaWebAuthnPlatformEnrollment**(): [`MfaWebAuthnPlatformEnrollmentMembers`](../../../../Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L59) + +**Returns** + +[`MfaWebAuthnPlatformEnrollmentMembers`](../../../../Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index.mdx new file mode 100644 index 000000000..b25532b1e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index.mdx @@ -0,0 +1,293 @@ +--- +title: "mfa-webauthn-roaming-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge">ScreenMembersOnMfaWebAuthnRoamingChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnRoamingChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaWebAuthnRoamingChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='reportWebAuthnError' type={<span>void | Promise<void></span>}> +> **reportWebAuthnError**(`options`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L37) + +**Parameters** + +**options** + +[`MfaWebAuthnRoamingChallengeReportErrorOptions`](../../../../Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`options?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L39) + +**Parameters** + +**options?** + +[`MfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](../../../../Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaWebAuthnRoamingChallenge' type={<a href="../../../../Types/interfaces/MfaWebAuthnRoamingChallengeMembers">MfaWebAuthnRoamingChallengeMembers</a>}> +> **useMfaWebAuthnRoamingChallenge**(): [`MfaWebAuthnRoamingChallengeMembers`](../../../../Types/interfaces/MfaWebAuthnRoamingChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L54) + +**Returns** + +[`MfaWebAuthnRoamingChallengeMembers`](../../../../Types/interfaces/MfaWebAuthnRoamingChallengeMembers) +</ParamField> + +<ParamField body='verify' type={<span>void | Promise<void></span>}> +> **verify**(`options?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L36) + +**Parameters** + +**options?** + +[`VerifySecurityKeyOptions`](../../../../Types/interfaces/VerifySecurityKeyOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index.mdx new file mode 100644 index 000000000..1cfe88a82 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index.mdx @@ -0,0 +1,293 @@ +--- +title: "mfa-webauthn-roaming-enrollment" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment">ScreenMembersOnMfaWebAuthnRoamingEnrollment</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='enroll' type={<span>void | Promise<void></span>}> +> **enroll**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L36) + +**Parameters** + +**payload** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='showError' type={<span>void | Promise<void></span>}> +> **showError**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L37) + +**Parameters** + +**payload** + +[`ShowErrorOptions`](../../../../Types/interfaces/ShowErrorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L38) + +**Parameters** + +**payload?** + +[`MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions`](../../../../Types/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useMfaWebAuthnRoamingEnrollment' type={<a href="../../../../Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers">MfaWebAuthnRoamingEnrollmentMembers</a>}> +> **useMfaWebAuthnRoamingEnrollment**(): [`MfaWebAuthnRoamingEnrollmentMembers`](../../../../Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers) + +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L53) + +**Returns** + +[`MfaWebAuthnRoamingEnrollmentMembers`](../../../../Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index.mdx new file mode 100644 index 000000000..553cba034 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index.mdx @@ -0,0 +1,283 @@ +--- +title: "organization-picker" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='selectOrganization' type={<span>void | Promise<void></span>}> +> **selectOrganization**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L34) + +**Parameters** + +**payload** + +**organization** + +`string` + +**state** + +`string` + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='skipOrganizationSelection' type={<span>void | Promise<void></span>}> +> **skipOrganizationSelection**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useOrganizationPicker' type={<a href="../../../../Types/interfaces/OrganizationPickerMembers">OrganizationPickerMembers</a>}> +> **useOrganizationPicker**(): [`OrganizationPickerMembers`](../../../../Types/interfaces/OrganizationPickerMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L51) + +**Returns** + +[`OrganizationPickerMembers`](../../../../Types/interfaces/OrganizationPickerMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index.mdx new file mode 100644 index 000000000..aaab782c6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index.mdx @@ -0,0 +1,261 @@ +--- +title: "organization-selection" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnOrganizationSelection">ScreenMembersOnOrganizationSelection</a>}> +> **useScreen**: () => [`ScreenMembersOnOrganizationSelection`](../../../../Types/interfaces/ScreenMembersOnOrganizationSelection) + +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnOrganizationSelection`](../../../../Types/interfaces/ScreenMembersOnOrganizationSelection) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueWithOrganizationName' type={<span>void | Promise<void></span>}> +> **continueWithOrganizationName**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L34) + +**Parameters** + +**payload** + +[`ContinueWithOrganizationNameOptions`](../../../../Types/interfaces/ContinueWithOrganizationNameOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useOrganizationSelection' type={<a href="../../../../Types/interfaces/OrganizationSelectionMembers">OrganizationSelectionMembers</a>}> +> **useOrganizationSelection**(): [`OrganizationSelectionMembers`](../../../../Types/interfaces/OrganizationSelectionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L49) + +**Returns** + +[`OrganizationSelectionMembers`](../../../../Types/interfaces/OrganizationSelectionMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index.mdx new file mode 100644 index 000000000..c1225d6b2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index.mdx @@ -0,0 +1,277 @@ +--- +title: "passkey-enrollment-local" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal">ScreenMembersOnPasskeyEnrollmentLocal</a>}> +> **useScreen**: () => [`ScreenMembersOnPasskeyEnrollmentLocal`](../../../../Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnPasskeyEnrollmentLocal`](../../../../Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='abortPasskeyEnrollment' type={<span>void | Promise<void></span>}> +> **abortPasskeyEnrollment**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L37) + +**Parameters** + +**payload** + +[`AbortEnrollmentOptions`](../../../../Types/interfaces/AbortEnrollmentOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='continuePasskeyEnrollment' type={<span>void | Promise<void></span>}> +> **continuePasskeyEnrollment**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L35) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='usePasskeyEnrollmentLocal' type={<a href="../../../../Types/interfaces/PasskeyEnrollmentLocalMembers">PasskeyEnrollmentLocalMembers</a>}> +> **usePasskeyEnrollmentLocal**(): [`PasskeyEnrollmentLocalMembers`](../../../../Types/interfaces/PasskeyEnrollmentLocalMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L52) + +**Returns** + +[`PasskeyEnrollmentLocalMembers`](../../../../Types/interfaces/PasskeyEnrollmentLocalMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index.mdx new file mode 100644 index 000000000..f1ee5a265 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index.mdx @@ -0,0 +1,277 @@ +--- +title: "passkey-enrollment" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnPasskeyEnrollment">ScreenMembersOnPasskeyEnrollment</a>}> +> **useScreen**: () => [`ScreenMembersOnPasskeyEnrollment`](../../../../Types/interfaces/ScreenMembersOnPasskeyEnrollment) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnPasskeyEnrollment`](../../../../Types/interfaces/ScreenMembersOnPasskeyEnrollment) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='abortPasskeyEnrollment' type={<span>void | Promise<void></span>}> +> **abortPasskeyEnrollment**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='continuePasskeyEnrollment' type={<span>void | Promise<void></span>}> +> **continuePasskeyEnrollment**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L34) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='usePasskeyEnrollment' type={<a href="../../../../Types/interfaces/PasskeyEnrollmentMembers">PasskeyEnrollmentMembers</a>}> +> **usePasskeyEnrollment**(): [`PasskeyEnrollmentMembers`](../../../../Types/interfaces/PasskeyEnrollmentMembers) + +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L51) + +**Returns** + +[`PasskeyEnrollmentMembers`](../../../../Types/interfaces/PasskeyEnrollmentMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index.mdx new file mode 100644 index 000000000..eb153bcd2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index.mdx @@ -0,0 +1,327 @@ +--- +title: "phone-identifier-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge">ScreenMembersOnPhoneIdentifierChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnPhoneIdentifierChallenge`](../../../../Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnPhoneIdentifierChallenge`](../../../../Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='resendCode' type={<span>void | Promise<void></span>}> +> **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='returnToPrevious' type={<span>void | Promise<void></span>}> +> **returnToPrevious**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='submitPhoneChallenge' type={<span>void | Promise<void></span>}> +> **submitPhoneChallenge**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`PhoneChallengeOptions`](../../../../Types/interfaces/PhoneChallengeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='switchToText' type={<span>void | Promise<void></span>}> +> **switchToText**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:42](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L42) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='switchToVoice' type={<span>void | Promise<void></span>}> +> **switchToVoice**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L40) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='usePhoneIdentifierChallenge' type={<a href="../../../../Types/interfaces/PhoneIdentifierChallengeMembers">PhoneIdentifierChallengeMembers</a>}> +> **usePhoneIdentifierChallenge**(): [`PhoneIdentifierChallengeMembers`](../../../../Types/interfaces/PhoneIdentifierChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L59) + +**Returns** + +[`PhoneIdentifierChallengeMembers`](../../../../Types/interfaces/PhoneIdentifierChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index.mdx new file mode 100644 index 000000000..8ac50aacf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index.mdx @@ -0,0 +1,277 @@ +--- +title: "phone-identifier-enrollment" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment">ScreenMembersOnPhoneIdentifierEnrollment</a>}> +> **useScreen**: () => [`ScreenMembersOnPhoneIdentifierEnrollment`](../../../../Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnPhoneIdentifierEnrollment`](../../../../Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continuePhoneEnrollment' type={<span>void | Promise<void></span>}> +> **continuePhoneEnrollment**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L35) + +**Parameters** + +**payload** + +[`PhoneEnrollmentOptions`](../../../../Types/interfaces/PhoneEnrollmentOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='returnToPrevious' type={<span>void | Promise<void></span>}> +> **returnToPrevious**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='usePhoneIdentifierEnrollment' type={<a href="../../../../Types/interfaces/PhoneIdentifierEnrollmentMembers">PhoneIdentifierEnrollmentMembers</a>}> +> **usePhoneIdentifierEnrollment**(): [`PhoneIdentifierEnrollmentMembers`](../../../../Types/interfaces/PhoneIdentifierEnrollmentMembers) + +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L52) + +**Returns** + +[`PhoneIdentifierEnrollmentMembers`](../../../../Types/interfaces/PhoneIdentifierEnrollmentMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index.mdx new file mode 100644 index 000000000..b1acf4bcc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index.mdx @@ -0,0 +1,261 @@ +--- +title: "redeem-ticket" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L21) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L22) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L23) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L24) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L25) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L20) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L26) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L27) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L19) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L31) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useRedeemTicket' type={<a href="../../../../Types/interfaces/RedeemTicketMembers">RedeemTicketMembers</a>}> +> **useRedeemTicket**(): [`RedeemTicketMembers`](../../../../Types/interfaces/RedeemTicketMembers) + +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:45](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L45) + +**Returns** + +[`RedeemTicketMembers`](../../../../Types/interfaces/RedeemTicketMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index.mdx new file mode 100644 index 000000000..968224d0d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index.mdx @@ -0,0 +1,261 @@ +--- +title: "reset-password-email" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordEmail">ScreenMembersOnResetPasswordEmail</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordEmail`](../../../../Types/interfaces/ScreenMembersOnResetPasswordEmail) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnResetPasswordEmail`](../../../../Types/interfaces/ScreenMembersOnResetPasswordEmail) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='resendEmail' type={<span>void | Promise<void></span>}> +> **resendEmail**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L34) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useResetPasswordEmail' type={<a href="../../../../Types/interfaces/ResetPasswordEmailMembers">ResetPasswordEmailMembers</a>}> +> **useResetPasswordEmail**(): [`ResetPasswordEmailMembers`](../../../../Types/interfaces/ResetPasswordEmailMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L48) + +**Returns** + +[`ResetPasswordEmailMembers`](../../../../Types/interfaces/ResetPasswordEmailMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index.mdx new file mode 100644 index 000000000..7f972a93c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index.mdx @@ -0,0 +1,245 @@ +--- +title: "reset-password-error" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordError">ScreenMembersOnResetPasswordError</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordError`](../../../../Types/interfaces/ScreenMembersOnResetPasswordError) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnResetPasswordError`](../../../../Types/interfaces/ScreenMembersOnResetPasswordError) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='useResetPasswordError' type={<a href="../../../../Types/interfaces/ResetPasswordErrorMembers">ResetPasswordErrorMembers</a>}> +> **useResetPasswordError**(): [`ResetPasswordErrorMembers`](../../../../Types/interfaces/ResetPasswordErrorMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L38) + +**Returns** + +[`ResetPasswordErrorMembers`](../../../../Types/interfaces/ResetPasswordErrorMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index.mdx new file mode 100644 index 000000000..fe43d78ee --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index.mdx @@ -0,0 +1,295 @@ +--- +title: "reset-password-mfa-email-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L28) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L29) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L30) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L31) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge">ScreenMembersOnResetPasswordMfaEmailChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaEmailChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L32) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnResetPasswordMfaEmailChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L27) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L33) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L34) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L26) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L38) + +**Parameters** + +**payload** + +[`ContinueOptions`](../../../../Types/interfaces/ContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='resendCode' type={<span>void | Promise<void></span>}> +> **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L39) + +**Parameters** + +**payload?** + +[`ResendCodeOptions`](../../../../Types/interfaces/ResendCodeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L40) + +**Parameters** + +**payload?** + +[`TryAnotherMethodOptions`](../../../../Types/interfaces/TryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useResetPasswordMfaEmailChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaEmailChallengeMembers">ResetPasswordMfaEmailChallengeMembers</a>}> +> **useResetPasswordMfaEmailChallenge**(): [`ResetPasswordMfaEmailChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaEmailChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L58) + +**Returns** + +[`ResetPasswordMfaEmailChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaEmailChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index.mdx new file mode 100644 index 000000000..4fa9e5aa9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index.mdx @@ -0,0 +1,277 @@ +--- +title: "reset-password-mfa-otp-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`ResetPasswordMfaOtpChallengeContinueOptions`](../../../../Types/interfaces/ResetPasswordMfaOtpChallengeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L36) + +**Parameters** + +**payload?** + +[`ResetPasswordMfaOtpChallengeTryAnotherMethodOptions`](../../../../Types/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useResetPasswordMfaOtpChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaOtpChallengeMembers">ResetPasswordMfaOtpChallengeMembers</a>}> +> **useResetPasswordMfaOtpChallenge**(): [`ResetPasswordMfaOtpChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaOtpChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L51) + +**Returns** + +[`ResetPasswordMfaOtpChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaOtpChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index.mdx new file mode 100644 index 000000000..26d5c77ce --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index.mdx @@ -0,0 +1,277 @@ +--- +title: "reset-password-mfa-phone-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L27) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L28) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L29) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L30) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge">ScreenMembersOnResetPasswordMfaPhoneChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaPhoneChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L31) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnResetPasswordMfaPhoneChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L26) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L32) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L33) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L25) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L37) + +**Parameters** + +**payload** + +[`ResetPasswordMfaPhoneChallengeContinueOptions`](../../../../Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L38) + +**Parameters** + +**payload** + +[`ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions`](../../../../Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useResetPasswordMfaPhoneChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaPhoneChallengeMembers">ResetPasswordMfaPhoneChallengeMembers</a>}> +> **useResetPasswordMfaPhoneChallenge**(): [`ResetPasswordMfaPhoneChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaPhoneChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L53) + +**Returns** + +[`ResetPasswordMfaPhoneChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaPhoneChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index.mdx new file mode 100644 index 000000000..18ac34ef6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index.mdx @@ -0,0 +1,311 @@ +--- +title: "reset-password-mfa-push-challenge-push" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush">ScreenMembersOnResetPasswordMfaPushChallengePush</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaPushChallengePush`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnResetPasswordMfaPushChallengePush`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='enterCodeManually' type={<span>void | Promise<void></span>}> +> **enterCodeManually**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='resendPushNotification' type={<span>void | Promise<void></span>}> +> **resendPushNotification**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:41](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L41) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useResetPasswordMfaPushChallengePush' type={<a href="../../../../Types/interfaces/ResetPasswordMfaPushChallengePushMembers">ResetPasswordMfaPushChallengePushMembers</a>}> +> **useResetPasswordMfaPushChallengePush**(): [`ResetPasswordMfaPushChallengePushMembers`](../../../../Types/interfaces/ResetPasswordMfaPushChallengePushMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L59) + +**Returns** + +[`ResetPasswordMfaPushChallengePushMembers`](../../../../Types/interfaces/ResetPasswordMfaPushChallengePushMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useMfaPolling">useMfaPolling</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index.mdx new file mode 100644 index 000000000..f70f75b89 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index.mdx @@ -0,0 +1,281 @@ +--- +title: "reset-password-mfa-recovery-code-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`code`, `payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L36) + +**Parameters** + +**code** + +`string` + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useResetPasswordMfaRecoveryCodeChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers">ResetPasswordMfaRecoveryCodeChallengeMembers</a>}> +> **useResetPasswordMfaRecoveryCodeChallenge**(): [`ResetPasswordMfaRecoveryCodeChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L54) + +**Returns** + +[`ResetPasswordMfaRecoveryCodeChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index.mdx new file mode 100644 index 000000000..c004e198b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index.mdx @@ -0,0 +1,311 @@ +--- +title: "reset-password-mfa-sms-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge">ScreenMembersOnResetPasswordMfaSmsChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaSmsChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnResetPasswordMfaSmsChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMfaSmsChallenge' type={<span>void | Promise<void></span>}> +> **continueMfaSmsChallenge**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`ResetPasswordMfaSmsChallengeOptions`](../../../../Types/interfaces/ResetPasswordMfaSmsChallengeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='getACall' type={<span>void | Promise<void></span>}> +> **getACall**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L40) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='resendCode' type={<span>void | Promise<void></span>}> +> **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useResetPasswordMfaSmsChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaSmsChallengeMembers">ResetPasswordMfaSmsChallengeMembers</a>}> +> **useResetPasswordMfaSmsChallenge**(): [`ResetPasswordMfaSmsChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaSmsChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:57](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L57) + +**Returns** + +[`ResetPasswordMfaSmsChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaSmsChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index.mdx new file mode 100644 index 000000000..eeba1d255 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index.mdx @@ -0,0 +1,311 @@ +--- +title: "reset-password-mfa-voice-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L27) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L28) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L29) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L30) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge">ScreenMembersOnResetPasswordMfaVoiceChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaVoiceChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L31) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnResetPasswordMfaVoiceChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L26) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L32) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L33) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L25) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueMethod' type={<span>void | Promise<void></span>}> +> **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L37) + +**Parameters** + +**payload** + +[`ResetPasswordMfaVoiceChallengeContinueOptions`](../../../../Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='resendCode' type={<span>void | Promise<void></span>}> +> **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='switchToSms' type={<span>void | Promise<void></span>}> +> **switchToSms**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L40) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useResetPasswordMfaVoiceChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaVoiceChallengeMembers">ResetPasswordMfaVoiceChallengeMembers</a>}> +> **useResetPasswordMfaVoiceChallenge**(): [`ResetPasswordMfaVoiceChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaVoiceChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L58) + +**Returns** + +[`ResetPasswordMfaVoiceChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaVoiceChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index.mdx new file mode 100644 index 000000000..d6e315cab --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index.mdx @@ -0,0 +1,293 @@ +--- +title: "reset-password-mfa-webauthn-platform-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L28) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L29) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L30) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L31) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge">ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L32) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L27) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L33) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L34) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L26) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='continueWithPasskey' type={<span>void | Promise<void></span>}> +> **continueWithPasskey**(`options?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L38) + +**Parameters** + +**options?** + +[`ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='reportBrowserError' type={<span>void | Promise<void></span>}> +> **reportBrowserError**(`options`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L40) + +**Parameters** + +**options** + +[`ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`options?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:42](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L42) + +**Parameters** + +**options?** + +[`ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useResetPasswordMfaWebAuthnPlatformChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers">ResetPasswordMfaWebAuthnPlatformChallengeMembers</a>}> +> **useResetPasswordMfaWebAuthnPlatformChallenge**(): [`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L58) + +**Returns** + +[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index.mdx new file mode 100644 index 000000000..0c6811681 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index.mdx @@ -0,0 +1,293 @@ +--- +title: "reset-password-mfa-webauthn-roaming-challenge" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L28) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L29) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L30) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L31) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge">ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L32) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L27) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L33) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L34) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L26) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='showError' type={<span>void | Promise<void></span>}> +> **showError**(`options`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L40) + +**Parameters** + +**options** + +[`ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> +> **tryAnotherMethod**(`options?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:41](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L41) + +**Parameters** + +**options?** + +[`ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useResetPasswordMfaWebAuthnRoamingChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers">ResetPasswordMfaWebAuthnRoamingChallengeMembers</a>}> +> **useResetPasswordMfaWebAuthnRoamingChallenge**(): [`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:57](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L57) + +**Returns** + +[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers) +</ParamField> + +<ParamField body='useSecurityKey' type={<span>void | Promise<void></span>}> +> **useSecurityKey**(`options?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L38) + +**Parameters** + +**options?** + +[`ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index.mdx new file mode 100644 index 000000000..ab6401304 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index.mdx @@ -0,0 +1,279 @@ +--- +title: "reset-password-request" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordRequest">ScreenMembersOnResetPasswordRequest</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordRequest`](../../../../Types/interfaces/ScreenMembersOnResetPasswordRequest) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnResetPasswordRequest`](../../../../Types/interfaces/ScreenMembersOnResetPasswordRequest) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnResetPasswordRequest">TransactionMembersOnResetPasswordRequest</a>}> +> **useTransaction**: () => [`TransactionMembersOnResetPasswordRequest`](../../../../Types/interfaces/TransactionMembersOnResetPasswordRequest) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembersOnResetPasswordRequest`](../../../../Types/interfaces/TransactionMembersOnResetPasswordRequest) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='backToLogin' type={<span>void | Promise<void></span>}> +> **backToLogin**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='resetPassword' type={<span>void | Promise<void></span>}> +> **resetPassword**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L35) + +**Parameters** + +**payload** + +[`ResetPasswordRequestOptions`](../../../../Types/interfaces/ResetPasswordRequestOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useResetPasswordRequest' type={<a href="../../../../Types/interfaces/ResetPasswordRequestMembers">ResetPasswordRequestMembers</a>}> +> **useResetPasswordRequest**(): [`ResetPasswordRequestMembers`](../../../../Types/interfaces/ResetPasswordRequestMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L54) + +**Returns** + +[`ResetPasswordRequestMembers`](../../../../Types/interfaces/ResetPasswordRequestMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useLoginIdentifiers">useLoginIdentifiers</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index.mdx new file mode 100644 index 000000000..c836b2867 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index.mdx @@ -0,0 +1,245 @@ +--- +title: "reset-password-success" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordSuccess">ScreenMembersOnResetPasswordSuccess</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordSuccess`](../../../../Types/interfaces/ScreenMembersOnResetPasswordSuccess) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnResetPasswordSuccess`](../../../../Types/interfaces/ScreenMembersOnResetPasswordSuccess) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='useResetPasswordSuccess' type={<a href="../../../../Types/interfaces/ResetPasswordSuccessMembers">ResetPasswordSuccessMembers</a>}> +> **useResetPasswordSuccess**(): [`ResetPasswordSuccessMembers`](../../../../Types/interfaces/ResetPasswordSuccessMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L38) + +**Returns** + +[`ResetPasswordSuccessMembers`](../../../../Types/interfaces/ResetPasswordSuccessMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index.mdx new file mode 100644 index 000000000..4206d928f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index.mdx @@ -0,0 +1,263 @@ +--- +title: "reset-password" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPassword">ScreenMembersOnResetPassword</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPassword`](../../../../Types/interfaces/ScreenMembersOnResetPassword) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnResetPassword`](../../../../Types/interfaces/ScreenMembersOnResetPassword) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnResetPassword">TransactionMembersOnResetPassword</a>}> +> **useTransaction**: () => [`TransactionMembersOnResetPassword`](../../../../Types/interfaces/TransactionMembersOnResetPassword) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembersOnResetPassword`](../../../../Types/interfaces/TransactionMembersOnResetPassword) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='resetPassword' type={<span>void | Promise<void></span>}> +> **resetPassword**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L34) + +**Parameters** + +**payload** + +[`ResetPasswordOptions`](../../../../Types/interfaces/ResetPasswordOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useResetPassword' type={<a href="../../../../Types/interfaces/ResetPasswordMembers">ResetPasswordMembers</a>}> +> **useResetPassword**(): [`ResetPasswordMembers`](../../../../Types/interfaces/ResetPasswordMembers) + +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L52) + +**Returns** + +[`ResetPasswordMembers`](../../../../Types/interfaces/ResetPasswordMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/usePasswordValidation">usePasswordValidation</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index.mdx new file mode 100644 index 000000000..7d911d89e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index.mdx @@ -0,0 +1,297 @@ +--- +title: "signup-id" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnSignupId">ScreenMembersOnSignupId</a>}> +> **useScreen**: () => [`ScreenMembersOnSignupId`](../../../../Types/interfaces/ScreenMembersOnSignupId) + +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnSignupId`](../../../../Types/interfaces/ScreenMembersOnSignupId) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a>}> +> **useTransaction**: () => [`TransactionMembersOnSignupId`](../../../../Types/interfaces/TransactionMembersOnSignupId) + +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembersOnSignupId`](../../../../Types/interfaces/TransactionMembersOnSignupId) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='federatedSignup' type={<span>void | Promise<void></span>}> +> **federatedSignup**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L37) + +**Parameters** + +**payload** + +[`FederatedSignupOptions`](../../../../Types/interfaces/FederatedSignupOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='pickCountryCode' type={<span>void | Promise<void></span>}> +> **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='signup' type={<span>void | Promise<void></span>}> +> **signup**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L36) + +**Parameters** + +**payload** + +[`SignupOptions`](../../../../Types/interfaces/SignupOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useSignupId' type={<a href="../../../../Types/interfaces/SignupIdMembers">SignupIdMembers</a>}> +> **useSignupId**(): [`SignupIdMembers`](../../../../Types/interfaces/SignupIdMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:60](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L60) + +**Returns** + +[`SignupIdMembers`](../../../../Types/interfaces/SignupIdMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/useSignupIdentifiers">useSignupIdentifiers</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useUsernameValidation">useUsernameValidation</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index.mdx new file mode 100644 index 000000000..c856746bb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index.mdx @@ -0,0 +1,279 @@ +--- +title: "signup-password" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnSignupPassword">ScreenMembersOnSignupPassword</a>}> +> **useScreen**: () => [`ScreenMembersOnSignupPassword`](../../../../Types/interfaces/ScreenMembersOnSignupPassword) + +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnSignupPassword`](../../../../Types/interfaces/ScreenMembersOnSignupPassword) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnSignupPassword">TransactionMembersOnSignupPassword</a>}> +> **useTransaction**: () => [`TransactionMembersOnSignupPassword`](../../../../Types/interfaces/TransactionMembersOnSignupPassword) + +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembersOnSignupPassword`](../../../../Types/interfaces/TransactionMembersOnSignupPassword) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='federatedSignup' type={<span>void | Promise<void></span>}> +> **federatedSignup**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L36) + +**Parameters** + +**payload** + +[`FederatedSignupPasswordPayloadOptions`](../../../../Types/interfaces/FederatedSignupPasswordPayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='signup' type={<span>void | Promise<void></span>}> +> **signup**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L35) + +**Parameters** + +**payload** + +[`SignupPasswordOptions`](../../../../Types/interfaces/SignupPasswordOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useSignupPassword' type={<a href="../../../../Types/interfaces/SignupPasswordMembers">SignupPasswordMembers</a>}> +> **useSignupPassword**(): [`SignupPasswordMembers`](../../../../Types/interfaces/SignupPasswordMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L54) + +**Returns** + +[`SignupPasswordMembers`](../../../../Types/interfaces/SignupPasswordMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/usePasswordValidation">usePasswordValidation</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index.mdx new file mode 100644 index 000000000..e13ae434f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index.mdx @@ -0,0 +1,299 @@ +--- +title: "signup" +--- + +## Variables + +<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`ClientMembers`](../../../../Types/interfaces/ClientMembers) + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`PromptMembers`](../../../../Types/interfaces/PromptMembers) + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnSignup">ScreenMembersOnSignup</a>}> +> **useScreen**: () => [`ScreenMembersOnSignup`](../../../../Types/interfaces/ScreenMembersOnSignup) + +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`ScreenMembersOnSignup`](../../../../Types/interfaces/ScreenMembersOnSignup) + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](../../../../Types/interfaces/TenantMembers) + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnSignup">TransactionMembersOnSignup</a>}> +> **useTransaction**: () => [`TransactionMembersOnSignup`](../../../../Types/interfaces/TransactionMembersOnSignup) + +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`TransactionMembersOnSignup`](../../../../Types/interfaces/TransactionMembersOnSignup) + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`UserMembers`](../../../../Types/interfaces/UserMembers) + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + + +## Functions + +<ParamField body='federatedSignup' type={<span>void | Promise<void></span>}> +> **federatedSignup**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L37) + +**Parameters** + +**payload** + +[`FederatedSignupPayloadOptions`](../../../../Types/interfaces/FederatedSignupPayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='pickCountryCode' type={<span>void | Promise<void></span>}> +> **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](../../../../Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='signup' type={<span>void | Promise<void></span>}> +> **signup**(`payload`): `void` \| `Promise`\<`void`\> + +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L36) + +**Parameters** + +**payload** + +[`SignupPayloadOptions`](../../../../Types/interfaces/SignupPayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> +</ParamField> + +<ParamField body='useSignup' type={<a href="../../../../Types/interfaces/SignupMembers">SignupMembers</a>}> +> **useSignup**(): [`SignupMembers`](../../../../Types/interfaces/SignupMembers) + +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:63](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L63) + +**Returns** + +[`SignupMembers`](../../../../Types/interfaces/SignupMembers) +</ParamField> + + +## References + +<ParamField body={<a href="../../../Hooks/functions/usePasswordValidation">usePasswordValidation</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useSignupIdentifiers">useSignupIdentifiers</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useUsernameValidation">useUsernameValidation</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> + +<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks.mdx new file mode 100644 index 000000000..054df4fbd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks.mdx @@ -0,0 +1,241 @@ +--- +title: "ContextHooks<T>" +--- + +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:7](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L7) + +Factory class that creates context hooks for accessing Auth0 Universal Login data. +These hooks provide access to various aspects of the authentication flow and tenant configuration. + +## Type Parameters + +### T + +`T` *extends* [`BaseMembers`](../interfaces/BaseMembers) + +### Constructor + +> **new ContextHooks**\<`T`\>(`instance`): `ContextHooks`\<`T`\> + +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:8](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L8) + +#### Parameters + +<ParamField body='instance' type='T'> +</ParamField> + +#### Returns + +`ContextHooks`\<`T`\> + +## Methods + +<ParamField body='useUser()' type='T["user"]'> +> **useUser**(): `T`\[`"user"`\] + +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L21) + +Hook to access user information and profile data. + +**Returns** + +`T`\[`"user"`\] + +User object containing profile information, attributes, and user-specific data + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` +</ParamField> + +<ParamField body='useTenant()' type='T["tenant"]'> +> **useTenant**(): `T`\[`"tenant"`\] + +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L34) + +Hook to access tenant configuration and settings. + +**Returns** + +`T`\[`"tenant"`\] + +Tenant object containing domain, region, and tenant-specific configuration + +**Example** + +```jsx +import { useTenant } from '@auth0/auth0-acul-react/login-id'; +function TenantInfo() { + const tenant = useTenant(); +} +``` +</ParamField> + +<ParamField body='useBranding()' type='T["branding"]'> +> **useBranding**(): `T`\[`"branding"`\] + +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:47](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L47) + +Hook to access branding and theme configuration. + +**Returns** + +`T`\[`"branding"`\] + +Branding object containing colors, logos, fonts, and visual customization settings + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` +</ParamField> + +<ParamField body='useClient()' type='T["client"]'> +> **useClient**(): `T`\[`"client"`\] + +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:60](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L60) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +`T`\[`"client"`\] + +Client object containing application settings, callbacks, and client-specific data + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` +</ParamField> + +<ParamField body='useOrganization()' type='T["organization"]'> +> **useOrganization**(): `T`\[`"organization"`\] + +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:76](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L76) + +Hook to access organization context and settings. + +**Returns** + +`T`\[`"organization"`\] + +Organization object containing org-specific data, metadata, and configuration + +**Example** + +```jsx +import { useOrganization } from '@auth0/auth0-acul-react/login-id'; +function OrgSelector() { + const organization = useOrganization(); + if (!organization) { + return <p>No organization context</p>; + } +} +``` +</ParamField> + +<ParamField body='usePrompt()' type='T["prompt"]'> +> **usePrompt**(): `T`\[`"prompt"`\] + +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:89](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L89) + +Hook to access prompt configuration and flow settings. + +**Returns** + +`T`\[`"prompt"`\] + +Prompt object containing flow configuration, screen settings, and prompt-specific data + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` +</ParamField> + +<ParamField body='useUntrustedData()' type='T["untrustedData"]'> +> **useUntrustedData**(): `T`\[`"untrustedData"`\] + +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:102](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L102) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +`T`\[`"untrustedData"`\] + +Object containing untrusted user input that should be validated before use + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` +</ParamField> + +<ParamField body='useScreen()' type='T["screen"]'> +> **useScreen**(): `T`\[`"screen"`\] + +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:115](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L115) + +Hook to access current screen information and metadata. + +**Returns** + +`T`\[`"screen"`\] + +Screen object containing current screen name, configuration, and screen-specific data + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` +</ParamField> + +<ParamField body='useTransaction()' type='T["transaction"]'> +> **useTransaction**(): `T`\[`"transaction"`\] + +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:128](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L128) + +Hook to access transaction state and authentication flow data. + +**Returns** + +`T`\[`"transaction"`\] + +Transaction object containing flow state, session data, and transaction-specific information + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/index.mdx new file mode 100644 index 000000000..aebf2d784 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/index.mdx @@ -0,0 +1,360 @@ +--- +title: "Types" +--- + +## Classes + +- [ContextHooks](./classes/ContextHooks): Factory class that creates context hooks for accessing Auth0 Universal Login data. These hooks provide access to various aspects of the authentication flow and tenant configuration. + +## Interfaces + +- [CustomOptions](./interfaces/CustomOptions) +- [WebAuthnErrorDetails](./interfaces/WebAuthnErrorDetails): Details of a WebAuthn browser error. +- [CurrentScreenOptions](./interfaces/CurrentScreenOptions): CurrentScreenOptions details. +- [FlattenedTheme](./interfaces/FlattenedTheme) +- [BaseMembers](./interfaces/BaseMembers) +- [BrandingSettings](./interfaces/BrandingSettings) +- [BrandingThemes](./interfaces/BrandingThemes) +- [BrandingMembers](./interfaces/BrandingMembers) +- [ClientMembers](./interfaces/ClientMembers) +- [Branding](./interfaces/Branding) +- [OrganizationMembers](./interfaces/OrganizationMembers) +- [PromptMembers](./interfaces/PromptMembers) +- [CaptchaContext](./interfaces/CaptchaContext) +- [AllowCredential](./interfaces/AllowCredential) +- [PasskeyCreate](./interfaces/PasskeyCreate) +- [PhonePrefix](./interfaces/PhonePrefix) +- [Scope](./interfaces/Scope) +- [AuthorizationDetail](./interfaces/AuthorizationDetail) +- [ScreenMembers](./interfaces/ScreenMembers) +- [TenantMembers](./interfaces/TenantMembers) +- [Connection](./interfaces/Connection) +- [UsernamePolicy](./interfaces/UsernamePolicy) +- [PasswordPolicy](./interfaces/PasswordPolicy) +- [EnterpriseConnection](./interfaces/EnterpriseConnection) +- [PasswordComplexityRule](./interfaces/PasswordComplexityRule) +- [Error](./interfaces/Error) +- [TransactionMembers](./interfaces/TransactionMembers) +- [UntrustedDataMembers](./interfaces/UntrustedDataMembers) +- [EnrolledEmail](./interfaces/EnrolledEmail) +- [EnrolledPhoneNumber](./interfaces/EnrolledPhoneNumber) +- [EnrolledDevice](./interfaces/EnrolledDevice) +- [Organizations](./interfaces/Organizations) +- [UserMembers](./interfaces/UserMembers) +- [ScreenMembersOnAcceptInvitation](./interfaces/ScreenMembersOnAcceptInvitation) +- [AcceptInvitationMembers](./interfaces/AcceptInvitationMembers) +- [ScreenMembersOnConsent](./interfaces/ScreenMembersOnConsent): ScreenMembersOnConsent +- [ConsentMembers](./interfaces/ConsentMembers): ConsentMembers +- [ScreenMembersOnCustomizedConsent](./interfaces/ScreenMembersOnCustomizedConsent): ScreenMembersOnCustomizedConsent +- [CustomizedConsentMembers](./interfaces/CustomizedConsentMembers): CustomizedConsentMembers +- [DeviceCodeActivationAllowedMembers](./interfaces/DeviceCodeActivationAllowedMembers): Interface describing the members of the Device Code Activation Allowed screen. +- [DeviceCodeActivationDeniedMembers](./interfaces/DeviceCodeActivationDeniedMembers): Interface describing the members of the Device Code Activation Denied screen. +- [DeviceCodeActivationContinueOptions](./interfaces/DeviceCodeActivationContinueOptions): payload for continuing device code activation. +- [DeviceCodeActivationMembers](./interfaces/DeviceCodeActivationMembers): Interface describing the members of the Device Code Activation screen. +- [ScreenMembersOnDeviceCodeConfirmation](./interfaces/ScreenMembersOnDeviceCodeConfirmation): Interface describing the data available on the Device Code Confirmation screen. +- [DeviceCodeConfirmationMembers](./interfaces/DeviceCodeConfirmationMembers): Interface describing the members of the Device Code Confirmation screen. +- [EmailChallengeOptions](./interfaces/EmailChallengeOptions) +- [ScreenMembersOnEmailIdentifierChallenge](./interfaces/ScreenMembersOnEmailIdentifierChallenge) +- [EmailIdentifierChallengeMembers](./interfaces/EmailIdentifierChallengeMembers) +- [ScreenMembersOnEmailOTPChallenge](./interfaces/ScreenMembersOnEmailOTPChallenge): Represents the members of the Email OTP Challenge screen. Extends the base ScreenMembers interface. +- [OtpCodeOptions](./interfaces/OtpCodeOptions) +- [EmailOTPChallengeMembers](./interfaces/EmailOTPChallengeMembers): Represents the Email OTP Challenge screen interface. +- [ScreenMembersOnEmailVerificationResult](./interfaces/ScreenMembersOnEmailVerificationResult): ScreenMembersOnEmailVerificationResult +- [EmailVerificationResultMembers](./interfaces/EmailVerificationResultMembers): EmailVerificationResultMembers +- [SubmitCaptchaOptions](./interfaces/SubmitCaptchaOptions) +- [InterstitialCaptchaMembers](./interfaces/InterstitialCaptchaMembers) +- [ContinueWithCodeOptionPayload](./interfaces/ContinueWithCodeOptionPayload): ContinueWithCodeOptions description Options for the `continueWithCode` method on the Login Email Verification screen. This operation is used when the user submits the verification code they received via email to proceed with the authentication flow. +- [ResendCodeOptionsPayload](./interfaces/ResendCodeOptionsPayload): ResendCodeOptions description Options for the `resendCode` method on the Login Email Verification screen. This operation is used when the user requests a new verification code to be sent to their email, for instance, if they did not receive the initial code or if it has expired. +- [LoginEmailVerificationMembers](./interfaces/LoginEmailVerificationMembers): LoginEmailVerificationMembers description Defines the members (properties and methods) available for interacting with the Login Email Verification screen. This screen is a crucial part of email verification processes, typically during login, where a user must prove ownership of an email address by providing a one-time code. The SDK facilitates submitting this code or requesting a new one. +- [ScreenMembersOnLoginId](./interfaces/ScreenMembersOnLoginId) +- [TransactionMembersOnLoginId](./interfaces/TransactionMembersOnLoginId) +- [LoginOptions](./interfaces/LoginOptions) +- [FederatedLoginOptions](./interfaces/FederatedLoginOptions) +- [LoginIdMembers](./interfaces/LoginIdMembers) +- [ScreenMembersOnLoginPassword](./interfaces/ScreenMembersOnLoginPassword) +- [TransactionMembersOnLoginPassword](./interfaces/TransactionMembersOnLoginPassword) +- [LoginPasswordOptions](./interfaces/LoginPasswordOptions) +- [FederatedLoginPasswordOptions](./interfaces/FederatedLoginPasswordOptions) +- [LoginPasswordMembers](./interfaces/LoginPasswordMembers) +- [ScreenMembersOnLoginPasswordlessEmailCode](./interfaces/ScreenMembersOnLoginPasswordlessEmailCode) +- [TransactionMembersOnLoginPasswordlessEmailCode](./interfaces/TransactionMembersOnLoginPasswordlessEmailCode) +- [SubmitCodeOptions](./interfaces/SubmitCodeOptions) +- [LoginPasswordlessEmailCodeMembers](./interfaces/LoginPasswordlessEmailCodeMembers) +- [ScreenMembersOnLoginPasswordlessSmsOtp](./interfaces/ScreenMembersOnLoginPasswordlessSmsOtp) +- [TransactionMembersOnLoginPasswordlessSmsOtp](./interfaces/TransactionMembersOnLoginPasswordlessSmsOtp) +- [SubmitOTPOptions](./interfaces/SubmitOTPOptions) +- [LoginPasswordlessSmsOtpMembers](./interfaces/LoginPasswordlessSmsOtpMembers) +- [ScreenMembersOnLogin](./interfaces/ScreenMembersOnLogin): Extended screen members interface for the login screen +- [TransactionMembersOnLogin](./interfaces/TransactionMembersOnLogin): Extended transaction members interface for the login screen +- [LoginPayloadOptions](./interfaces/LoginPayloadOptions): Options for performing login operations +- [FederatedLoginPayloadOptions](./interfaces/FederatedLoginPayloadOptions): Options for performing social login operations +- [LoginMembers](./interfaces/LoginMembers): Login screen members interface extending base members +- [LogoutAbortedMembers](./interfaces/LogoutAbortedMembers): Interface defining the available methods and properties for the logout-aborted screen +- [LogoutCompleteMembers](./interfaces/LogoutCompleteMembers): Interface defining the available methods and properties for the logout-complete screen +- [ConfirmLogoutOptions](./interfaces/ConfirmLogoutOptions): Options for confirming logout +- [LogoutMembers](./interfaces/LogoutMembers): Interface defining the available methods and properties for the logout screen +- [MfaEnrollOptions](./interfaces/MfaEnrollOptions): Options for continuing with factor enrollment +- [MfaBeginEnrollOptionsMembers](./interfaces/MfaBeginEnrollOptionsMembers): MFA Begin Enroll Options screen members interface +- [ScreenMembersOnMfaCountryCodes](./interfaces/ScreenMembersOnMfaCountryCodes): Interface for screen data specific to mfa-country-codes screen +- [SelectCountryCodeOptions](./interfaces/SelectCountryCodeOptions): Options for selecting a country code +- [MfaCountryCodesMembers](./interfaces/MfaCountryCodesMembers): Interface defining the available methods and properties for the mfa-country-codes screen +- [MfaDetectBrowserCapabilitiesMembers](./interfaces/MfaDetectBrowserCapabilitiesMembers): Interface defining the available methods and properties for the mfa-detect-browser-capabilities screen +- [ScreenMembersOnMfaEmailChallenge](./interfaces/ScreenMembersOnMfaEmailChallenge): Interface for the screen data specific to mfa-email-challenge screen +- [UntrustedDataMembersOnMfaEmailChallenge](./interfaces/UntrustedDataMembersOnMfaEmailChallenge): Interface for untrusted data specific to mfa-email-challenge screen +- [ContinuePayloadOptions](./interfaces/ContinuePayloadOptions): Options for continuing with the email challenge +- [ResendCodePayloadOptions](./interfaces/ResendCodePayloadOptions): Options for resending the email code +- [TryAnotherMethodPayloadOptions](./interfaces/TryAnotherMethodPayloadOptions): Options for trying another method +- [MfaEmailChallengeMembers](./interfaces/MfaEmailChallengeMembers): Interface defining the available methods and properties for the mfa-email-challenge screen +- [ScreenMembersOnMfaEmailList](./interfaces/ScreenMembersOnMfaEmailList): Interface for the screen data specific to mfa-email-list screen +- [SelectMfaEmailOptions](./interfaces/SelectMfaEmailOptions): Options for selecting an email address +- [MfaEmailListMembers](./interfaces/MfaEmailListMembers): Interface defining the available methods and properties for the mfa-email-list screen +- [ScreenMembersOnMfaEnrollResult](./interfaces/ScreenMembersOnMfaEnrollResult): ScreenMembersOnMfaEnrollResult +- [MfaEnrollResultMembers](./interfaces/MfaEnrollResultMembers): MfaEnrollResultMembers +- [ScreenMembersOnMfaLoginOptions](./interfaces/ScreenMembersOnMfaLoginOptions): Interface for the screen data specific to mfa-login-options screen +- [LoginEnrollOptions](./interfaces/LoginEnrollOptions): Options for continuing with a selected MFA factor +- [MfaLoginOptionsMembers](./interfaces/MfaLoginOptionsMembers): Interface defining the available methods and properties for the mfa-login-options screen +- [ScreenMembersOnMfaOtpChallenge](./interfaces/ScreenMembersOnMfaOtpChallenge): Interface for the screen data specific to mfa-otp-challenge screen +- [UntrustedDataMembersOnMfaOtpChallenge](./interfaces/UntrustedDataMembersOnMfaOtpChallenge): Interface for untrusted data specific to mfa-otp-challenge screen +- [ContinueOTPOptions](./interfaces/ContinueOTPOptions): Options for continuing with the OTP challenge +- [TryAnotherMethodMfaOtpChallengeOptions](./interfaces/TryAnotherMethodMfaOtpChallengeOptions): Options for trying another method +- [MfaOtpChallengeMembers](./interfaces/MfaOtpChallengeMembers): Interface defining the available methods and properties for the mfa-otp-challenge screen +- [MfaOtpContinueOptions](./interfaces/MfaOtpContinueOptions): Options for continuing with the MFA OTP enrollment code. +- [MfaOtpTryAnotherMethodOptions](./interfaces/MfaOtpTryAnotherMethodOptions): Options for trying another MFA method. +- [ScreenMembersOnMfaOtpEnrollmentCode](./interfaces/ScreenMembersOnMfaOtpEnrollmentCode): Interface for the screen data specific to the mfa-otp-enrollment-code screen. +- [MfaOtpEnrollmentCodeMembers](./interfaces/MfaOtpEnrollmentCodeMembers): Interface defining the available methods and properties for the mfa-otp-enrollment-code screen. +- [ScreenMembersOnMfaOtpEnrollmentQr](./interfaces/ScreenMembersOnMfaOtpEnrollmentQr): Interface for the screen data specific to mfa-otp-enrollment-qr screen +- [MfaOtpEnrollmentQrContinueOptions](./interfaces/MfaOtpEnrollmentQrContinueOptions): Interface for the payload of the continue method +- [MfaOtpEnrollmentQrMembers](./interfaces/MfaOtpEnrollmentQrMembers): Interface defining the available methods and properties for the mfa-otp-enrollment-qr screen +- [ScreenMembersOnMfaPhoneChallenge](./interfaces/ScreenMembersOnMfaPhoneChallenge): ScreenMembersOnMfaPhoneChallenge +- [MfaPhoneChallengeContinueOptions](./interfaces/MfaPhoneChallengeContinueOptions): ContinueOptions Defines the options required to continue the MFA phone challenge process. This typically involves selecting the method (SMS or Voice) to receive the verification code. +- [MfaPhoneChallengePickPhoneOptions](./interfaces/MfaPhoneChallengePickPhoneOptions): PickPhoneOptions Defines the options for the 'pick-phone' action. Although the interface only shows one phone number, this action might be used in scenarios where the server needs to redirect to a phone selection screen. +- [MfaPhoneChallengePickAuthenticatorOptions](./interfaces/MfaPhoneChallengePickAuthenticatorOptions): PickAuthenticatorOptions Defines the options for the 'pick-authenticator' action. This allows the user to choose a different MFA method if available. +- [MfaPhoneChallengeMembers](./interfaces/MfaPhoneChallengeMembers): MfaPhoneChallengeMembers +- [MfaPhoneEnrollmentContinueOptions](./interfaces/MfaPhoneEnrollmentContinueOptions): Options for continuing with the MFA phone enrollment. +- [MfaPhoneEnrollmentMembers](./interfaces/MfaPhoneEnrollmentMembers) +- [ScreenMembersOnMfaPushChallengePush](./interfaces/ScreenMembersOnMfaPushChallengePush): Interface for the screen data specific to mfa-push-challenge-push screen +- [UntrustedDataMembersOnMfaPushChallengePush](./interfaces/UntrustedDataMembersOnMfaPushChallengePush): Interface for untrusted data specific to mfa-push-challenge-push screen +- [WithRememberOptions](./interfaces/WithRememberOptions) +- [MfaPushChallengePushMembers](./interfaces/MfaPushChallengePushMembers): Interface defining the available methods and properties for the mfa-push-challenge-push screen +- [ScreenMembersOnMfaPushEnrollmentQr](./interfaces/ScreenMembersOnMfaPushEnrollmentQr): Interface for the screen data specific to mfa-push-enrollment-qr screen +- [MfaPushEnrollmentQrMembers](./interfaces/MfaPushEnrollmentQrMembers): Interface defining the available methods and properties for the mfa-push-enrollment-qr screen +- [SelectMfaPushDeviceOptions](./interfaces/SelectMfaPushDeviceOptions): Options for selecting an MFA push device. +- [MfaPushListMembers](./interfaces/MfaPushListMembers): Interface defining the available methods and properties for the mfa-push-list screen +- [ScreenMembersOnMfaPushWelcome](./interfaces/ScreenMembersOnMfaPushWelcome) +- [MfaPushWelcomeMembers](./interfaces/MfaPushWelcomeMembers) +- [ScreenMembersOnMfaRecoveryCodeChallengeNewCode](./interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode): ScreenMembersOnMfaRecoveryCodeChallengeNewCode +- [MfaRecoveryCodeChallengeNewCodeContinueOptions](./interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions): ContinueOptions +- [MfaRecoveryCodeChallengeNewCodeMembers](./interfaces/MfaRecoveryCodeChallengeNewCodeMembers): MfaRecoveryCodeChallengeNewCodeMembers +- [MfaRecoveryCodeChallengeContinueOptions](./interfaces/MfaRecoveryCodeChallengeContinueOptions): Options for continuing with the MFA Recovery Code Challenge. +- [MfaRecoveryCodeChallengeMembers](./interfaces/MfaRecoveryCodeChallengeMembers): Interface describing the members of the Mfa Recovery Code Challenge screen. +- [ScreenMembersOnMfaRecoveryCodeEnrollment](./interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment): Interface describing the data available on the Mfa Recovery Code Enrollment screen. +- [MfaRecoveryCodeEnrollmentContinueOptions](./interfaces/MfaRecoveryCodeEnrollmentContinueOptions) +- [MfaRecoveryCodeEnrollmentMembers](./interfaces/MfaRecoveryCodeEnrollmentMembers): Interface describing the members of the Mfa Recovery Code Enrollment screen. +- [MfaSmsChallengeOptions](./interfaces/MfaSmsChallengeOptions) +- [ScreenMembersOnMfaSmsChallenge](./interfaces/ScreenMembersOnMfaSmsChallenge): Interface for the screen data specific to mfa-sms-challenge screen +- [MfaSmsChallengeMembers](./interfaces/MfaSmsChallengeMembers) +- [UntrustedDataMembersOnMfaSmsChallenge](./interfaces/UntrustedDataMembersOnMfaSmsChallenge): Interface for untrusted data specific to mfa-sms-challenge screen +- [MfaSmsEnrollmentOptions](./interfaces/MfaSmsEnrollmentOptions) +- [ScreenMembersOnMfaSmsEnrollment](./interfaces/ScreenMembersOnMfaSmsEnrollment) +- [MfaSmsEnrollmentMembers](./interfaces/MfaSmsEnrollmentMembers) +- [MfaSmsListOptions](./interfaces/MfaSmsListOptions): MfaSmsListOptions Options for performing actions on the mfa-sms-list screen. +- [MfaSmsListMembers](./interfaces/MfaSmsListMembers): MfaSmsListMembers Interface defining the members and methods for the MfaSmsList class. +- [MfaVoiceChallengeContinueOptions](./interfaces/MfaVoiceChallengeContinueOptions): Options for submitting the voice challenge code. +- [ScreenMembersOnMfaVoiceChallenge](./interfaces/ScreenMembersOnMfaVoiceChallenge): Extended screen members interface for the MFA Voice Challenge screen. +- [MfaVoiceChallengeMembers](./interfaces/MfaVoiceChallengeMembers): Interface defining all members and operations available on the MFA Voice Challenge screen. +- [UntrustedDataMembersOnMfaVoiceChallenge](./interfaces/UntrustedDataMembersOnMfaVoiceChallenge): Interface for untrusted data specific to mfa-voice-challenge screen +- [MfaVoiceEnrollmentContinueOptions](./interfaces/MfaVoiceEnrollmentContinueOptions): Payload for continuing the MFA Voice Enrollment flow. +- [MfaVoiceEnrollmentMembers](./interfaces/MfaVoiceEnrollmentMembers): Interface describing the members of the Mfa Voice Enrollment screen. +- [ScreenMembersOnMfaWebAuthnChangeKeyNickname](./interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname): ScreenMembersOnMfaWebAuthnChangeKeyNickname +- [MfaWebAuthnChangeKeyNicknameContinueOptions](./interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions): ContinueOptions +- [MfaWebAuthnChangeKeyNicknameMembers](./interfaces/MfaWebAuthnChangeKeyNicknameMembers): MfaWebAuthnChangeKeyNicknameMembers +- [ScreenMembersOnMfaWebAuthnEnrollmentSuccess](./interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess): ScreenMembersOnMfaWebAuthnEnrollmentSuccess +- [WebAuthnEnrollSuccessContinueOptions](./interfaces/WebAuthnEnrollSuccessContinueOptions): ContinueOptions +- [MfaWebAuthnEnrollmentSuccessMembers](./interfaces/MfaWebAuthnEnrollmentSuccessMembers): MfaWebAuthnEnrollmentSuccessMembers +- [ScreenMembersOnMfaWebAuthnError](./interfaces/ScreenMembersOnMfaWebAuthnError): ScreenMembersOnMfaWebAuthnError +- [MfaWebAuthnErrorMembers](./interfaces/MfaWebAuthnErrorMembers): MfaWebAuthnErrorMembers +- [MfaWebAuthnNotAvailableErrorMembers](./interfaces/MfaWebAuthnNotAvailableErrorMembers): MfaWebAuthnNotAvailableErrorMembers +- [ScreenMembersOnMfaWebAuthnPlatformChallenge](./interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge): ScreenMembersOnMfaWebAuthnPlatformChallenge +- [VerifyPlatformAuthenticatorOptions](./interfaces/VerifyPlatformAuthenticatorOptions): VerifyPlatformAuthenticatorOptions +- [MfaWebAuthnPlatformChallengeReportErrorOptions](./interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions): ReportBrowserErrorOptions +- [MfaWebAuthnPlatformChallengeTryAnotherMethodOptions](./interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions): TryAnotherMethodOptions +- [MfaWebAuthnPlatformChallengeMembers](./interfaces/MfaWebAuthnPlatformChallengeMembers): MfaWebAuthnPlatformChallengeMembers +- [ScreenMembersOnMfaWebAuthnPlatformEnrollment](./interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment): ScreenMembersOnMfaWebAuthnPlatformEnrollment +- [SubmitPasskeyCredentialOptions](./interfaces/SubmitPasskeyCredentialOptions): SubmitPasskeyCredentialOptions +- [ReportBrowserErrorOptions](./interfaces/ReportBrowserErrorOptions): ReportBrowserErrorOptions +- [MfaWebAuthnPlatformEnrollmentMembers](./interfaces/MfaWebAuthnPlatformEnrollmentMembers): MfaWebAuthnPlatformEnrollmentMembers +- [ScreenMembersOnMfaWebAuthnRoamingChallenge](./interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge): ScreenMembersOnMfaWebAuthnRoamingChallenge +- [VerifySecurityKeyOptions](./interfaces/VerifySecurityKeyOptions): VerifySecurityKeyOptions +- [MfaWebAuthnRoamingChallengeReportErrorOptions](./interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions): ReportWebAuthnErrorOptions +- [MfaWebAuthnRoamingChallengeTryAnotherMethodOptions](./interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions): TryAnotherMethodOptions +- [MfaWebAuthnRoamingChallengeMembers](./interfaces/MfaWebAuthnRoamingChallengeMembers): MfaWebAuthnRoamingChallengeMembers +- [ScreenMembersOnMfaWebAuthnRoamingEnrollment](./interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment): Interface for screen data specific to mfa-webauthn-roaming-enrollment screen. +- [ShowErrorOptions](./interfaces/ShowErrorOptions): Options for submitting a WebAuthn browser error. +- [MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions](./interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions): Options for trying another MFA method. +- [MfaWebAuthnRoamingEnrollmentMembers](./interfaces/MfaWebAuthnRoamingEnrollmentMembers): Interface defining the available methods and properties for the mfa-webauthn-roaming-enrollment screen. +- [SelectOrganizationOptions](./interfaces/SelectOrganizationOptions) +- [OrganizationPickerMembers](./interfaces/OrganizationPickerMembers): Interface defining the available methods and properties for the organization-picker screen +- [ContinueWithOrganizationNameOptions](./interfaces/ContinueWithOrganizationNameOptions): Options for continuing with the selected organization name. +- [ScreenMembersOnOrganizationSelection](./interfaces/ScreenMembersOnOrganizationSelection): Interface for the screen data specific to organization-selection screen. +- [OrganizationSelectionMembers](./interfaces/OrganizationSelectionMembers): Interface defining the available methods and properties for the organization-selection screen. +- [AbortEnrollmentOptions](./interfaces/AbortEnrollmentOptions) +- [ScreenMembersOnPasskeyEnrollmentLocal](./interfaces/ScreenMembersOnPasskeyEnrollmentLocal) +- [PasskeyEnrollmentLocalMembers](./interfaces/PasskeyEnrollmentLocalMembers) +- [ScreenMembersOnPasskeyEnrollment](./interfaces/ScreenMembersOnPasskeyEnrollment) +- [PasskeyEnrollmentMembers](./interfaces/PasskeyEnrollmentMembers) +- [PhoneChallengeOptions](./interfaces/PhoneChallengeOptions) +- [ScreenMembersOnPhoneIdentifierChallenge](./interfaces/ScreenMembersOnPhoneIdentifierChallenge) +- [PhoneIdentifierChallengeMembers](./interfaces/PhoneIdentifierChallengeMembers) +- [ScreenMembersOnPhoneIdentifierEnrollment](./interfaces/ScreenMembersOnPhoneIdentifierEnrollment) +- [PhoneEnrollmentOptions](./interfaces/PhoneEnrollmentOptions) +- [PhoneIdentifierEnrollmentMembers](./interfaces/PhoneIdentifierEnrollmentMembers) +- [RedeemTicketMembers](./interfaces/RedeemTicketMembers): Interface describing the data available on the Redeem Ticket screen. +- [ResetPasswordEmailOptions](./interfaces/ResetPasswordEmailOptions) +- [ScreenMembersOnResetPasswordEmail](./interfaces/ScreenMembersOnResetPasswordEmail) +- [ResetPasswordEmailMembers](./interfaces/ResetPasswordEmailMembers) +- [ScreenMembersOnResetPasswordError](./interfaces/ScreenMembersOnResetPasswordError) +- [ResetPasswordErrorMembers](./interfaces/ResetPasswordErrorMembers) +- [ScreenMembersOnResetPasswordMfaEmailChallenge](./interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge): Interface for the screen data specific to reset-password-mfa-email-challenge screen +- [ContinueOptions](./interfaces/ContinueOptions): Options for continuing with the email challenge. +- [ResendCodeOptions](./interfaces/ResendCodeOptions): Options for resending the email code. +- [TryAnotherMethodOptions](./interfaces/TryAnotherMethodOptions): Options for trying another method. +- [ResetPasswordMfaEmailChallengeMembers](./interfaces/ResetPasswordMfaEmailChallengeMembers): Interface defining the available methods and properties for the reset-password-mfa-email-challenge screen +- [ResetPasswordMfaOtpChallengeContinueOptions](./interfaces/ResetPasswordMfaOtpChallengeContinueOptions): Options for continuing with the OTP challenge. +- [ResetPasswordMfaOtpChallengeTryAnotherMethodOptions](./interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions): Options for trying another method. +- [ResetPasswordMfaOtpChallengeMembers](./interfaces/ResetPasswordMfaOtpChallengeMembers): Interface defining the available methods and properties for the reset-password-mfa-otp-challenge screen +- [ScreenMembersOnResetPasswordMfaPhoneChallenge](./interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge): ScreenMembersOnResetPasswordMfaPhoneChallenge +- [ResetPasswordMfaPhoneChallengeContinueOptions](./interfaces/ResetPasswordMfaPhoneChallengeContinueOptions): ContinueOptions +- [ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions](./interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions): TryAnotherMethodOptions +- [ResetPasswordMfaPhoneChallengeMembers](./interfaces/ResetPasswordMfaPhoneChallengeMembers): ResetPasswordMfaPhoneChallengeMembers +- [ScreenMembersOnResetPasswordMfaPushChallengePush](./interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush): Interface for the screen data specific to reset-password-mfa-push-challenge-push screen +- [ResetPasswordMfaPushChallengePushMembers](./interfaces/ResetPasswordMfaPushChallengePushMembers): Interface defining the available methods and properties for the reset-password-mfa-push-challenge-push screen +- [ResetPasswordMfaRecoveryCodeChallengeMembers](./interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers): Interface describing the members of the Mfa Recovery Code Challenge screen. +- [ResetPasswordMfaSmsChallengeOptions](./interfaces/ResetPasswordMfaSmsChallengeOptions) +- [ScreenMembersOnResetPasswordMfaSmsChallenge](./interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge) +- [ResetPasswordMfaSmsChallengeMembers](./interfaces/ResetPasswordMfaSmsChallengeMembers) +- [ScreenMembersOnResetPasswordMfaVoiceChallenge](./interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge): Interface for the screen data specific to reset-password-mfa-voice-challenge screen. +- [ResetPasswordMfaVoiceChallengeContinueOptions](./interfaces/ResetPasswordMfaVoiceChallengeContinueOptions): Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers. +- [ResetPasswordMfaVoiceChallengeMembers](./interfaces/ResetPasswordMfaVoiceChallengeMembers): Interface defining the available methods and properties for the reset-password-mfa-voice-challenge screen. +- [ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge](./interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge): ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge +- [ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions](./interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions): ContinueWithPasskeyOptions +- [ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions](./interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions): ReportBrowserErrorOptions +- [ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions](./interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions): TryAnotherMethodOptions +- [ResetPasswordMfaWebAuthnPlatformChallengeMembers](./interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers): ResetPasswordMfaWebAuthnPlatformChallengeMembers +- [ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge](./interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge): ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge +- [ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions](./interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions): UseSecurityKeyOptions +- [ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions](./interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions): ShowErrorOptions +- [ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions](./interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions): TryAnotherMethodOptions +- [ResetPasswordMfaWebAuthnRoamingChallengeMembers](./interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers): ResetPasswordMfaWebAuthnRoamingChallengeMembers +- [ResetPasswordRequestOptions](./interfaces/ResetPasswordRequestOptions) +- [TransactionMembersOnResetPasswordRequest](./interfaces/TransactionMembersOnResetPasswordRequest) +- [ScreenMembersOnResetPasswordRequest](./interfaces/ScreenMembersOnResetPasswordRequest) +- [ResetPasswordRequestMembers](./interfaces/ResetPasswordRequestMembers) +- [ScreenMembersOnResetPasswordSuccess](./interfaces/ScreenMembersOnResetPasswordSuccess) +- [ResetPasswordSuccessMembers](./interfaces/ResetPasswordSuccessMembers) +- [ResetPasswordOptions](./interfaces/ResetPasswordOptions) +- [ScreenMembersOnResetPassword](./interfaces/ScreenMembersOnResetPassword) +- [TransactionMembersOnResetPassword](./interfaces/TransactionMembersOnResetPassword) +- [ResetPasswordMembers](./interfaces/ResetPasswordMembers) +- [ScreenMembersOnSignupId](./interfaces/ScreenMembersOnSignupId) +- [TransactionMembersOnSignupId](./interfaces/TransactionMembersOnSignupId) +- [FederatedSignupOptions](./interfaces/FederatedSignupOptions) +- [SignupOptions](./interfaces/SignupOptions) +- [SignupIdMembers](./interfaces/SignupIdMembers) +- [FederatedSignupPasswordPayloadOptions](./interfaces/FederatedSignupPasswordPayloadOptions) +- [ScreenMembersOnSignupPassword](./interfaces/ScreenMembersOnSignupPassword) +- [TransactionMembersOnSignupPassword](./interfaces/TransactionMembersOnSignupPassword) +- [SignupPasswordOptions](./interfaces/SignupPasswordOptions) +- [SignupPasswordMembers](./interfaces/SignupPasswordMembers) +- [SignupPayloadOptions](./interfaces/SignupPayloadOptions) +- [FederatedSignupPayloadOptions](./interfaces/FederatedSignupPayloadOptions) +- [ScreenMembersOnSignup](./interfaces/ScreenMembersOnSignup) +- [TransactionMembersOnSignup](./interfaces/TransactionMembersOnSignup) +- [SignupMembers](./interfaces/SignupMembers) +- [CredentialResponse](./interfaces/CredentialResponse) +- [PasskeyCreateResponse](./interfaces/PasskeyCreateResponse) +- [MfaPushPollingControl](./interfaces/MfaPushPollingControl): Control interface for managing an MFA push-notification polling session. +- [StartResendOptions](./interfaces/StartResendOptions): Options for configuring resend functionality +- [ResendControl](./interfaces/ResendControl): Control object returned by resendManager method +- [Identifier](./interfaces/Identifier): Describes a configured identifier field (e.g. email, phone, or username) for use in a signup form or authentication flow. +- [PasswordValidationResult](./interfaces/PasswordValidationResult) +- [UsernameValidationError](./interfaces/UsernameValidationError): Represents a single username validation error returned during validation. +- [UsernameValidationResult](./interfaces/UsernameValidationResult): The result of validating a username against one or more rules. +- [ErrorsResult](./interfaces/ErrorsResult) +- [UseErrorOptions](./interfaces/UseErrorOptions) +- [UseErrorsResult](./interfaces/UseErrorsResult) +- [MfaPollingResult](./interfaces/MfaPollingResult): Result object returned by [useMfaPolling](../Hooks/functions/useMfaPolling). +- [UseResendReturn](./interfaces/UseResendReturn): Return type for [useResend](../Hooks/functions/useResend). +- [UseResendOptions](./interfaces/UseResendOptions): Optional configuration for [useResend](../Hooks/functions/useResend). +- [ErrorItem](./interfaces/ErrorItem) + +## Type Aliases + +- [AuthenticatorTransport](./type-aliases/AuthenticatorTransport) +- [WebAuthnType](./type-aliases/WebAuthnType) +- [MfaPollingOptions](./type-aliases/MfaPollingOptions): Configuration options for managing an MFA push-notification polling process. +- [OnStatusChangeCallback](./type-aliases/OnStatusChangeCallback): Callback function for status changes during resend countdown. +- [ScreenIdentifierType](./type-aliases/ScreenIdentifierType): Represents the types of user identifiers that can be used during signup. +- [IdentifierType](./type-aliases/IdentifierType): Type representing valid identifier values +- [MfaLoginFactorType](./type-aliases/MfaLoginFactorType): Type definition for MFA login factor constants +- [MfaEnrollFactorType](./type-aliases/MfaEnrollFactorType): Type definition for MFA enroll factor constants +- [ErrorKind](./type-aliases/ErrorKind) + +## References + +### ULError + +Renames and re-exports [Error](./interfaces/Error) + +*** + +### useAuth0Themes + +Re-exports [useAuth0Themes](../Hooks/functions/useAuth0Themes) + +*** + +### useCurrentScreen + +Re-exports [useCurrentScreen](../Hooks/functions/useCurrentScreen) + +*** + +### useErrors + +Re-exports [useErrors](../Hooks/functions/useErrors) + +*** + +### useLoginIdentifiers + +Re-exports [useLoginIdentifiers](../Hooks/functions/useLoginIdentifiers) + +*** + +### useSignupIdentifiers + +Re-exports [useSignupIdentifiers](../Hooks/functions/useSignupIdentifiers) + +*** + +### useMfaPolling + +Re-exports [useMfaPolling](../Hooks/functions/useMfaPolling) + +*** + +### useResend + +Re-exports [useResend](../Hooks/functions/useResend) + +*** + +### usePasswordValidation + +Re-exports [usePasswordValidation](../Hooks/functions/usePasswordValidation) + +*** + +### useUsernameValidation + +Re-exports [useUsernameValidation](../Hooks/functions/useUsernameValidation) \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AbortEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AbortEnrollmentOptions.mdx new file mode 100644 index 000000000..187ef4e78 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AbortEnrollmentOptions.mdx @@ -0,0 +1,17 @@ +--- +title: "AbortEnrollmentOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment-local.d.ts:15 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='doNotShowAgain?' type='boolean'> +> `optional` **doNotShowAgain**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment-local.d.ts:16 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers.mdx new file mode 100644 index 000000000..992a29d1c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers.mdx @@ -0,0 +1,131 @@ +--- +title: "AcceptInvitationMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:14 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:15 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:16 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:17 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnAcceptInvitation](./ScreenMembersOnAcceptInvitation)'> +> **screen**: [`ScreenMembersOnAcceptInvitation`](./ScreenMembersOnAcceptInvitation) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:18 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:19 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='acceptInvitation()' type='unknown'> +> **acceptInvitation**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:24 + +Accepts the invitation to the organization. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential.mdx new file mode 100644 index 000000000..08acb0306 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential.mdx @@ -0,0 +1,27 @@ +--- +title: "AllowCredential" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:8 + +## Properties + +<ParamField body='type' type='"public-key"'> +> **type**: `"public-key"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:9 + +</ParamField> + +<ParamField body='id' type='string'> +> **id**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:10 + +</ParamField> + +<ParamField body='transports?' type='[AuthenticatorTransport](../type-aliases/AuthenticatorTransport)[]'> +> `optional` **transports**: [`AuthenticatorTransport`](../type-aliases/AuthenticatorTransport)[] + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:11 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AuthorizationDetail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AuthorizationDetail.mdx new file mode 100644 index 000000000..a905307ef --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AuthorizationDetail.mdx @@ -0,0 +1,17 @@ +--- +title: "AuthorizationDetail" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:56 + +## Indexable + +\[`key`: `string`\]: `string` + +## Properties + +<ParamField body='type' type='string'> +> **type**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:57 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.mdx new file mode 100644 index 000000000..a21505045 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.mdx @@ -0,0 +1,148 @@ +--- +title: "BaseMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:21 + +## Extended by + +- [`LogoutMembers`](./LogoutMembers) +- [`LogoutAbortedMembers`](./LogoutAbortedMembers) +- [`LoginIdMembers`](./LoginIdMembers) +- [`LoginPasswordMembers`](./LoginPasswordMembers) +- [`SignupIdMembers`](./SignupIdMembers) +- [`SignupPasswordMembers`](./SignupPasswordMembers) +- [`LoginPasswordlessEmailCodeMembers`](./LoginPasswordlessEmailCodeMembers) +- [`LoginPasswordlessSmsOtpMembers`](./LoginPasswordlessSmsOtpMembers) +- [`PasskeyEnrollmentMembers`](./PasskeyEnrollmentMembers) +- [`PasskeyEnrollmentLocalMembers`](./PasskeyEnrollmentLocalMembers) +- [`PhoneIdentifierChallengeMembers`](./PhoneIdentifierChallengeMembers) +- [`PhoneIdentifierEnrollmentMembers`](./PhoneIdentifierEnrollmentMembers) +- [`EmailIdentifierChallengeMembers`](./EmailIdentifierChallengeMembers) +- [`InterstitialCaptchaMembers`](./InterstitialCaptchaMembers) +- [`LoginMembers`](./LoginMembers) +- [`SignupMembers`](./SignupMembers) +- [`ResetPasswordEmailMembers`](./ResetPasswordEmailMembers) +- [`ResetPasswordRequestMembers`](./ResetPasswordRequestMembers) +- [`ResetPasswordMembers`](./ResetPasswordMembers) +- [`ResetPasswordErrorMembers`](./ResetPasswordErrorMembers) +- [`ResetPasswordSuccessMembers`](./ResetPasswordSuccessMembers) +- [`ResetPasswordMfaPushChallengePushMembers`](./ResetPasswordMfaPushChallengePushMembers) +- [`MfaPushEnrollmentQrMembers`](./MfaPushEnrollmentQrMembers) +- [`MfaPushListMembers`](./MfaPushListMembers) +- [`MfaPushWelcomeMembers`](./MfaPushWelcomeMembers) +- [`MfaSmsEnrollmentMembers`](./MfaSmsEnrollmentMembers) +- [`MfaBeginEnrollOptionsMembers`](./MfaBeginEnrollOptionsMembers) +- [`MfaSmsChallengeMembers`](./MfaSmsChallengeMembers) +- [`MfaCountryCodesMembers`](./MfaCountryCodesMembers) +- [`ResetPasswordMfaEmailChallengeMembers`](./ResetPasswordMfaEmailChallengeMembers) +- [`ResetPasswordMfaSmsChallengeMembers`](./ResetPasswordMfaSmsChallengeMembers) +- [`MfaDetectBrowserCapabilitiesMembers`](./MfaDetectBrowserCapabilitiesMembers) +- [`MfaEmailChallengeMembers`](./MfaEmailChallengeMembers) +- [`MfaEmailListMembers`](./MfaEmailListMembers) +- [`MfaSmsListMembers`](./MfaSmsListMembers) +- [`MfaEnrollResultMembers`](./MfaEnrollResultMembers) +- [`MfaLoginOptionsMembers`](./MfaLoginOptionsMembers) +- [`MfaPushChallengePushMembers`](./MfaPushChallengePushMembers) +- [`MfaOtpChallengeMembers`](./MfaOtpChallengeMembers) +- [`MfaOtpEnrollmentQrMembers`](./MfaOtpEnrollmentQrMembers) +- [`MfaOtpEnrollmentCodeMembers`](./MfaOtpEnrollmentCodeMembers) +- [`ResetPasswordMfaOtpChallengeMembers`](./ResetPasswordMfaOtpChallengeMembers) +- [`OrganizationSelectionMembers`](./OrganizationSelectionMembers) +- [`OrganizationPickerMembers`](./OrganizationPickerMembers) +- [`AcceptInvitationMembers`](./AcceptInvitationMembers) +- [`CustomizedConsentMembers`](./CustomizedConsentMembers) +- [`MfaPhoneEnrollmentMembers`](./MfaPhoneEnrollmentMembers) +- [`MfaVoiceEnrollmentMembers`](./MfaVoiceEnrollmentMembers) +- [`MfaRecoveryCodeChallengeMembers`](./MfaRecoveryCodeChallengeMembers) +- [`DeviceCodeActivationAllowedMembers`](./DeviceCodeActivationAllowedMembers) +- [`DeviceCodeActivationDeniedMembers`](./DeviceCodeActivationDeniedMembers) +- [`DeviceCodeActivationMembers`](./DeviceCodeActivationMembers) +- [`MfaVoiceChallengeMembers`](./MfaVoiceChallengeMembers) +- [`ResetPasswordMfaRecoveryCodeChallengeMembers`](./ResetPasswordMfaRecoveryCodeChallengeMembers) +- [`ResetPasswordMfaVoiceChallengeMembers`](./ResetPasswordMfaVoiceChallengeMembers) +- [`RedeemTicketMembers`](./RedeemTicketMembers) +- [`DeviceCodeConfirmationMembers`](./DeviceCodeConfirmationMembers) +- [`MfaPhoneChallengeMembers`](./MfaPhoneChallengeMembers) +- [`MfaRecoveryCodeEnrollmentMembers`](./MfaRecoveryCodeEnrollmentMembers) +- [`ResetPasswordMfaPhoneChallengeMembers`](./ResetPasswordMfaPhoneChallengeMembers) +- [`MfaRecoveryCodeChallengeNewCodeMembers`](./MfaRecoveryCodeChallengeNewCodeMembers) +- [`LogoutCompleteMembers`](./LogoutCompleteMembers) +- [`EmailVerificationResultMembers`](./EmailVerificationResultMembers) +- [`EmailOTPChallengeMembers`](./EmailOTPChallengeMembers) +- [`LoginEmailVerificationMembers`](./LoginEmailVerificationMembers) +- [`MfaWebAuthnPlatformEnrollmentMembers`](./MfaWebAuthnPlatformEnrollmentMembers) +- [`MfaWebAuthnErrorMembers`](./MfaWebAuthnErrorMembers) +- [`MfaWebAuthnNotAvailableErrorMembers`](./MfaWebAuthnNotAvailableErrorMembers) +- [`MfaWebAuthnRoamingEnrollmentMembers`](./MfaWebAuthnRoamingEnrollmentMembers) +- [`MfaWebAuthnRoamingChallengeMembers`](./MfaWebAuthnRoamingChallengeMembers) +- [`MfaWebAuthnPlatformChallengeMembers`](./MfaWebAuthnPlatformChallengeMembers) +- [`MfaWebAuthnEnrollmentSuccessMembers`](./MfaWebAuthnEnrollmentSuccessMembers) +- [`MfaWebAuthnChangeKeyNicknameMembers`](./MfaWebAuthnChangeKeyNicknameMembers) +- [`ConsentMembers`](./ConsentMembers) +- [`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](./ResetPasswordMfaWebAuthnPlatformChallengeMembers) +- [`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](./ResetPasswordMfaWebAuthnRoamingChallengeMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding.mdx new file mode 100644 index 000000000..e5392fff4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding.mdx @@ -0,0 +1,28 @@ +--- +title: "Branding" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:17 + +## Properties + +<ParamField body='logoUrl?' type='string'> +> `optional` **logoUrl**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:18 + +</ParamField> + +<ParamField body='colors?' type='object'> +> `optional` **colors**: `object` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:19 + +**primary?** + +> `optional` **primary**: `string` + +**pageBackground?** + +> `optional` **pageBackground**: `string` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers.mdx new file mode 100644 index 000000000..979e3750c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers.mdx @@ -0,0 +1,20 @@ +--- +title: "BrandingMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:53 + +## Properties + +<ParamField body='settings' type='[BrandingSettings](./BrandingSettings) '> +> **settings**: [`BrandingSettings`](./BrandingSettings) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:54 + +</ParamField> + +<ParamField body='themes' type='[BrandingThemes](./BrandingThemes) '> +> **themes**: [`BrandingThemes`](./BrandingThemes) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:55 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings.mdx new file mode 100644 index 000000000..99716ffef --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings.mdx @@ -0,0 +1,42 @@ +--- +title: "BrandingSettings" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:29 + +## Properties + +<ParamField body='colors?' type='object'> +> `optional` **colors**: `object` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:30 + +**primary?** + +> `optional` **primary**: `string` + +**pageBackground?** + +> `optional` **pageBackground**: `string` \| \{ `type`: `string`; `start`: `string`; `end`: `string`; `angleDegree`: `number`; \} + +</ParamField> + +<ParamField body='faviconUrl?' type='string'> +> `optional` **faviconUrl**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:39 + +</ParamField> + +<ParamField body='logoUrl?' type='string'> +> `optional` **logoUrl**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:40 + +</ParamField> + +<ParamField body='fontUrl?' type='string'> +> `optional` **fontUrl**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:41 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes.mdx new file mode 100644 index 000000000..7801cd09d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes.mdx @@ -0,0 +1,37 @@ +--- +title: "BrandingThemes" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:43 + +## Properties + +<ParamField body='default' type='object'> +> **default**: `object` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:44 + +**borders** + +> **borders**: `Record`\<`string`, `string` \| `boolean` \| `number`\> + +**colors** + +> **colors**: `Record`\<`string`, `string`\> + +**displayName** + +> **displayName**: `string` + +**fonts** + +> **fonts**: `Record`\<`string`, `string` \| `boolean` \| `object`\> + +**pageBackground** + +> **pageBackground**: `Record`\<`string`, `string`\> + +**widget** + +> **widget**: `Record`\<`string`, `string` \| `number`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext.mdx new file mode 100644 index 000000000..52e8f861f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext.mdx @@ -0,0 +1,27 @@ +--- +title: "CaptchaContext" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:1 + +## Properties + +<ParamField body='provider' type='string'> +> **provider**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:2 + +</ParamField> + +<ParamField body='image?' type='string'> +> `optional` **image**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:3 + +</ParamField> + +<ParamField body='siteKey?' type='string'> +> `optional` **siteKey**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:4 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers.mdx new file mode 100644 index 000000000..5a1827411 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers.mdx @@ -0,0 +1,41 @@ +--- +title: "ClientMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/client.d.ts:10 + +## Properties + +<ParamField body='id' type='string'> +> **id**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/client.d.ts:11 + +</ParamField> + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/client.d.ts:12 + +</ParamField> + +<ParamField body='logoUrl' type='string '> +> **logoUrl**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/client.d.ts:13 + +</ParamField> + +<ParamField body='description' type='string '> +> **description**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/client.d.ts:14 + +</ParamField> + +<ParamField body='metadata' type='{[key: string]: string; } '> +> **metadata**: \{\[`key`: `string`\]: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/client.d.ts:15 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions.mdx new file mode 100644 index 000000000..65053c02c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions.mdx @@ -0,0 +1,25 @@ +--- +title: "ConfirmLogoutOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/logout.d.ts:6 + +Options for confirming logout + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='action' type='"accept" '> +> **action**: `"accept"` \| `"deny"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/logout.d.ts:8 + +The authentication transaction state +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection.mdx new file mode 100644 index 000000000..6a53f1da2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection.mdx @@ -0,0 +1,31 @@ +--- +title: "Connection" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:1 + +## Extended by + +- [`EnterpriseConnection`](./EnterpriseConnection) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:2 + +</ParamField> + +<ParamField body='strategy' type='string'> +> **strategy**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:3 + +</ParamField> + +<ParamField body='metadata?' type='Record<string, string>'> +> `optional` **metadata**: `Record`\<`string`, `string`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:4 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers.mdx new file mode 100644 index 000000000..fa28ecfb3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers.mdx @@ -0,0 +1,209 @@ +--- +title: "ConsentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/consent.d.ts:38 + +ConsentMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnConsent](./ScreenMembersOnConsent)'> +> **screen**: [`ScreenMembersOnConsent`](./ScreenMembersOnConsent) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/consent.d.ts:44 + +Provides access to the specific properties and data of the Consent screen, +including the list of `scopes` being requested and the `hideScopes` flag. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='accept()' type='unknown'> +> **accept**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/consent.d.ts:72 + +Submits the user's decision to accept (grant) the requested permissions. +This action posts to the `/u/consent` endpoint with `action: "accept"`. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional. An object for any custom key-value pairs + to be sent with the request. These parameters will be + included in the form data submitted to the server. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the accept action is successfully submitted. + On success, Auth0 typically redirects the user back to the application + or to the next step in the authentication flow. + +**Throws** + +Throws an error if the form submission fails (e.g., network issue, invalid state). + Server-side errors (like "invalid_request") will be reflected in `this.transaction.errors` + after the operation, rather than being thrown as JavaScript errors. + +**Example** + +```typescript +// Assuming 'consentManager' is an instance of the Consent screen SDK class +try { + await consentManager.accept(); + // If successful, the page will typically redirect. +} catch (error) { + // Handle unexpected errors during the submission itself. + console.error("Failed to submit consent acceptance:", error); +} +// After the await, check consentManager.transaction.errors for server-side validation issues. +``` + +</ParamField> + +<ParamField body='deny()' type='unknown'> +> **deny**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/consent.d.ts:98 + +Submits the user's decision to deny (reject) the requested permissions. +This action posts to the `/u/consent` endpoint with `action: "deny"`. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional. An object for any custom key-value pairs + to be sent with the request. These parameters will be + included in the form data submitted to the server. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the deny action is successfully submitted. + On success, Auth0 typically redirects the user, potentially showing an + access denied message or returning an error to the application. + +**Throws** + +Throws an error if the form submission fails (e.g., network issue, invalid state). + Server-side errors are reflected in `this.transaction.errors`. + +**Example** + +```typescript +// Assuming 'consentManager' is an instance of the Consent screen SDK class +try { + await consentManager.deny({ reason: "user_declined" }); // Example custom option + // If successful, the page will typically redirect. +} catch (error) { + console.error("Failed to submit consent denial:", error); +} +// After the await, check consentManager.transaction.errors for server-side validation issues. +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOTPOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOTPOptions.mdx new file mode 100644 index 000000000..70ee908c3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOTPOptions.mdx @@ -0,0 +1,32 @@ +--- +title: "ContinueOTPOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:23 + +Options for continuing with the OTP challenge + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:25 + +The code entered by the user + +</ParamField> + +<ParamField body='rememberDevice?' type='boolean'> +> `optional` **rememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:27 + +Indicates whether to remember the browser +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOptions.mdx new file mode 100644 index 000000000..f37bffb5a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOptions.mdx @@ -0,0 +1,32 @@ +--- +title: "ContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:15 + +Options for continuing with the email challenge. + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:17 + +The code entered by the user. + +</ParamField> + +<ParamField body='rememberDevice?' type='boolean'> +> `optional` **rememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:19 + +Indicates whether to remember the device. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinuePayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinuePayloadOptions.mdx new file mode 100644 index 000000000..02b3c783f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinuePayloadOptions.mdx @@ -0,0 +1,32 @@ +--- +title: "ContinuePayloadOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:26 + +Options for continuing with the email challenge + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:28 + +The code entered by the user + +</ParamField> + +<ParamField body='rememberDevice?' type='boolean'> +> `optional` **rememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:30 + +Indicates whether to remember the device +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload.mdx new file mode 100644 index 000000000..4986b29e9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload.mdx @@ -0,0 +1,39 @@ +--- +title: "ContinueWithCodeOptionPayload" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-email-verification.d.ts:11 + +ContinueWithCodeOptions +description Options for the `continueWithCode` method on the Login Email Verification screen. +This operation is used when the user submits the verification code they received via email +to proceed with the authentication flow. + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-email-verification.d.ts:19 + +The verification code sent to the user's email. This is typically a short numeric +or alphanumeric string that the user must enter into the form. + +**Examples** + +```ts +"123456" +``` + +```ts +"ABCXYZ" +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithOrganizationNameOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithOrganizationNameOptions.mdx new file mode 100644 index 000000000..2be3942d3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithOrganizationNameOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "ContinueWithOrganizationNameOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:11 + +Options for continuing with the selected organization name. + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options. + +## Properties + +<ParamField body='organizationName' type='string'> +> **organizationName**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:15 + +The organization name. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CredentialResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CredentialResponse.mdx new file mode 100644 index 000000000..1514df10f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CredentialResponse.mdx @@ -0,0 +1,27 @@ +--- +title: "CredentialResponse" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:14 + +## Properties + +<ParamField body='clientDataJSON' type='string '> +> **clientDataJSON**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:15 + +</ParamField> + +<ParamField body='attestationObject' type='string '> +> **attestationObject**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:16 + +</ParamField> + +<ParamField body='transports?' type='string[]'> +> `optional` **transports**: `string`[] + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:17 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions.mdx new file mode 100644 index 000000000..4231148b1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions.mdx @@ -0,0 +1,57 @@ +--- +title: "CurrentScreenOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:25 + +CurrentScreenOptions details. + +## Properties + +<ParamField body='client' type='{ id: string; metadata: Record<string, string> '> +> **client**: \{ `id`: `string`; `metadata`: `Record`\<`string`, `string`\> \| `null`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:26 + +</ParamField> + +<ParamField body='organization' type='{ id: string; metadata: Record<string, string> '> +> **organization**: \{ `id`: `string`; `metadata`: `Record`\<`string`, `string`\> \| `null`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:30 + +</ParamField> + +<ParamField body='prompt' type='{ name: string; } '> +> **prompt**: \{ `name`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:34 + +</ParamField> + +<ParamField body='screen' type='{ name: string; } '> +> **screen**: \{ `name`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:37 + +</ParamField> + +<ParamField body='tenant' type='{ enabledLocales: string[]; } '> +> **tenant**: \{ `enabledLocales`: `string`[]; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:40 + +</ParamField> + +<ParamField body='transaction' type='{ errors: [Error](./Error)[] '> +> **transaction**: \{ `errors`: [`Error`](./Error)[] \| `null`; `state`: `string`; `locale`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:43 + +</ParamField> + +<ParamField body='untrustedData' type='{ authorizationParams: Record<string, string> '> +> **untrustedData**: \{ `authorizationParams`: `Record`\<`string`, `string`\> \| `null`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:48 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions.mdx new file mode 100644 index 000000000..c063c176e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions.mdx @@ -0,0 +1,41 @@ +--- +title: "CustomOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:2 + +## Extended by + +- [`OtpCodeOptions`](./OtpCodeOptions) +- [`WithRememberOptions`](./WithRememberOptions) +- [`MfaPhoneChallengeContinueOptions`](./MfaPhoneChallengeContinueOptions) +- [`MfaPhoneChallengePickPhoneOptions`](./MfaPhoneChallengePickPhoneOptions) +- [`MfaPhoneChallengePickAuthenticatorOptions`](./MfaPhoneChallengePickAuthenticatorOptions) +- [`MfaRecoveryCodeEnrollmentContinueOptions`](./MfaRecoveryCodeEnrollmentContinueOptions) +- [`ResetPasswordMfaPhoneChallengeContinueOptions`](./ResetPasswordMfaPhoneChallengeContinueOptions) +- [`ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions`](./ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions) +- [`MfaRecoveryCodeChallengeNewCodeContinueOptions`](./MfaRecoveryCodeChallengeNewCodeContinueOptions) +- [`ConfirmLogoutOptions`](./ConfirmLogoutOptions) +- [`ContinueWithCodeOptionPayload`](./ContinueWithCodeOptionPayload) +- [`ResendCodeOptionsPayload`](./ResendCodeOptionsPayload) +- [`SubmitPasskeyCredentialOptions`](./SubmitPasskeyCredentialOptions) +- [`VerifySecurityKeyOptions`](./VerifySecurityKeyOptions) +- [`MfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](./MfaWebAuthnRoamingChallengeTryAnotherMethodOptions) +- [`VerifyPlatformAuthenticatorOptions`](./VerifyPlatformAuthenticatorOptions) +- [`MfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](./MfaWebAuthnPlatformChallengeTryAnotherMethodOptions) +- [`WebAuthnEnrollSuccessContinueOptions`](./WebAuthnEnrollSuccessContinueOptions) +- [`MfaWebAuthnChangeKeyNicknameContinueOptions`](./MfaWebAuthnChangeKeyNicknameContinueOptions) +- [`ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions`](./ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions) +- [`ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](./ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions) +- [`ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions`](./ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions) +- [`ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](./ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions) +- [`MfaOtpEnrollmentQrContinueOptions`](./MfaOtpEnrollmentQrContinueOptions) +- [`DeviceCodeActivationContinueOptions`](./DeviceCodeActivationContinueOptions) +- [`MfaPhoneEnrollmentContinueOptions`](./MfaPhoneEnrollmentContinueOptions) +- [`MfaRecoveryCodeChallengeContinueOptions`](./MfaRecoveryCodeChallengeContinueOptions) +- [`MfaVoiceEnrollmentContinueOptions`](./MfaVoiceEnrollmentContinueOptions) +- [`ResetPasswordMfaVoiceChallengeContinueOptions`](./ResetPasswordMfaVoiceChallengeContinueOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers.mdx new file mode 100644 index 000000000..dc20127e1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers.mdx @@ -0,0 +1,211 @@ +--- +title: "CustomizedConsentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/customized-consent.d.ts:49 + +CustomizedConsentMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnCustomizedConsent](./ScreenMembersOnCustomizedConsent)'> +> **screen**: [`ScreenMembersOnCustomizedConsent`](./ScreenMembersOnCustomizedConsent) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/customized-consent.d.ts:55 + +Provides access to the specific properties and data of the Customized Consent screen, +including the list of `scopes` and `authorizationDetails` being requested. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='accept()' type='unknown'> +> **accept**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/customized-consent.d.ts:84 + +Submits the user's decision to accept (grant) the requested permissions and authorization details. +This action posts to the `/u/customized-consent` endpoint with `action: "accept"`. +The transaction state is automatically included. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional. An object for any custom key-value pairs + to be sent with the request. These parameters will be + included in the form data submitted to the server. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the accept action is successfully submitted. + On success, Auth0 typically redirects the user back to the application + or to the next step in the authentication flow. + +**Throws** + +Throws an error if the form submission fails (e.g., network issue, invalid state). + Server-side errors (like "invalid_request") will be reflected in `this.transaction.errors` + after the operation, rather than being thrown as JavaScript errors. + +**Example** + +```typescript +// Assuming 'customizedConsentManager' is an instance of the CustomizedConsent SDK class +try { + await customizedConsentManager.accept(); + // If successful, the page will typically redirect. +} catch (error) { + // Handle unexpected errors during the submission itself. + console.error("Failed to submit consent acceptance:", error); +} +// After the await, check customizedConsentManager.transaction.errors for server-side validation issues. +``` + +</ParamField> + +<ParamField body='deny()' type='unknown'> +> **deny**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/customized-consent.d.ts:111 + +Submits the user's decision to deny (reject) the requested permissions and authorization details. +This action posts to the `/u/customized-consent` endpoint with `action: "deny"`. +The transaction state is automatically included. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional. An object for any custom key-value pairs + to be sent with the request. These parameters will be + included in the form data submitted to the server. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the deny action is successfully submitted. + On success, Auth0 typically redirects the user, potentially showing an + access denied message or returning an error to the application. + +**Throws** + +Throws an error if the form submission fails (e.g., network issue, invalid state). + Server-side errors are reflected in `this.transaction.errors`. + +**Example** + +```typescript +// Assuming 'customizedConsentManager' is an instance of the CustomizedConsent SDK class +try { + await customizedConsentManager.deny({ reason_code: "user_rejected_details" }); // Example custom option + // If successful, the page will typically redirect. +} catch (error) { + console.error("Failed to submit consent denial:", error); +} +// After the await, check customizedConsentManager.transaction.errors for server-side validation issues. +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers.mdx new file mode 100644 index 000000000..4067e9a3e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers.mdx @@ -0,0 +1,111 @@ +--- +title: "DeviceCodeActivationAllowedMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-activation-allowed.d.ts:5 + +Interface describing the members of the Device Code Activation Allowed screen. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions.mdx new file mode 100644 index 000000000..831d2dc30 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "DeviceCodeActivationContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-activation.d.ts:10 + +payload for continuing device code activation. + +This interface extends `CustomOptions`, meaning all custom option properties +are merged into the top level of the object. This avoids nesting and provides +a simpler structure for consumers of this interface. + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-activation.d.ts:11 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers.mdx new file mode 100644 index 000000000..e64170384 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers.mdx @@ -0,0 +1,111 @@ +--- +title: "DeviceCodeActivationDeniedMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-activation-denied.d.ts:5 + +Interface describing the members of the Device Code Activation Denied screen. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers.mdx new file mode 100644 index 000000000..fb2c02538 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers.mdx @@ -0,0 +1,137 @@ +--- +title: "DeviceCodeActivationMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-activation.d.ts:16 + +Interface describing the members of the Device Code Activation screen. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-activation.d.ts:27 + +Submits the device code entered by the user. +This action is triggered when the user enters the code displayed on their device and submits the form. + +**Parameters** + +**payload** + +[`DeviceCodeActivationContinueOptions`](./DeviceCodeActivationContinueOptions) + +An object containing the code entered by the user and any custom payload. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the code is successfully submitted. +Rejects with an error if the submission fails. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers.mdx new file mode 100644 index 000000000..c5ff5b693 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers.mdx @@ -0,0 +1,154 @@ +--- +title: "DeviceCodeConfirmationMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-confirmation.d.ts:15 + +Interface describing the members of the Device Code Confirmation screen. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnDeviceCodeConfirmation](./ScreenMembersOnDeviceCodeConfirmation)'> +> **screen**: [`ScreenMembersOnDeviceCodeConfirmation`](./ScreenMembersOnDeviceCodeConfirmation) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-confirmation.d.ts:16 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='confirm()' type='unknown'> +> **confirm**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-confirmation.d.ts:21 + +Confirms the device code. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='cancel()' type='unknown'> +> **cancel**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-confirmation.d.ts:26 + +Cancels the device code flow. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailChallengeOptions.mdx new file mode 100644 index 000000000..8478eae2d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailChallengeOptions.mdx @@ -0,0 +1,24 @@ +--- +title: "EmailChallengeOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:5 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:6 + +</ParamField> + +<ParamField body='captcha?' type='string'> +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:7 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers.mdx new file mode 100644 index 000000000..5aed362d4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers.mdx @@ -0,0 +1,178 @@ +--- +title: "EmailIdentifierChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:17 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnEmailIdentifierChallenge](./ScreenMembersOnEmailIdentifierChallenge)'> +> **screen**: [`ScreenMembersOnEmailIdentifierChallenge`](./ScreenMembersOnEmailIdentifierChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:18 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='submitEmailChallenge()' type='unknown'> +> **submitEmailChallenge**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:19 + +**Parameters** + +**payload** + +[`EmailChallengeOptions`](./EmailChallengeOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendCode()' type='unknown'> +> **resendCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:20 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager()' type='unknown'> +> **resendManager**(`payload?`): [`ResendControl`](./ResendControl) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:21 + +**Parameters** + +**payload?** + +[`StartResendOptions`](./StartResendOptions) + +**Returns** + +[`ResendControl`](./ResendControl) + +</ParamField> + +<ParamField body='returnToPrevious()' type='unknown'> +> **returnToPrevious**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:22 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers.mdx new file mode 100644 index 000000000..1d4d53ad9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers.mdx @@ -0,0 +1,175 @@ +--- +title: "EmailOTPChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-otp-challenge.d.ts:20 + +Represents the Email OTP Challenge screen interface. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnEmailOTPChallenge](./ScreenMembersOnEmailOTPChallenge)'> +> **screen**: [`ScreenMembersOnEmailOTPChallenge`](./ScreenMembersOnEmailOTPChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-otp-challenge.d.ts:21 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='submitCode()' type='unknown'> +> **submitCode**(`options`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-otp-challenge.d.ts:26 + +Submits the OTP code entered by the user. + +**Parameters** + +**options** + +[`OtpCodeOptions`](./OtpCodeOptions) + +Optional parameters to include in the submission. + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendCode()' type='unknown'> +> **resendCode**(`options?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-otp-challenge.d.ts:31 + +Requests a new OTP code to be sent to the user's email. + +**Parameters** + +**options?** + +[`CustomOptions`](./CustomOptions) + +Optional parameters to include in the resend request. + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager()' type='unknown'> +> **resendManager**(`options?`): [`ResendControl`](./ResendControl) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-otp-challenge.d.ts:36 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](./StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](./ResendControl) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers.mdx new file mode 100644 index 000000000..442a0e055 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers.mdx @@ -0,0 +1,113 @@ +--- +title: "EmailVerificationResultMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-verification-result.d.ts:42 + +EmailVerificationResultMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnEmailVerificationResult](./ScreenMembersOnEmailVerificationResult)'> +> **screen**: [`ScreenMembersOnEmailVerificationResult`](./ScreenMembersOnEmailVerificationResult) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-verification-result.d.ts:48 + +Screen-specific data, including verification status and login link. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledDevice.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledDevice.mdx new file mode 100644 index 000000000..de6fa95e4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledDevice.mdx @@ -0,0 +1,20 @@ +--- +title: "EnrolledDevice" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:10 + +## Properties + +<ParamField body='id' type='number'> +> **id**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:11 + +</ParamField> + +<ParamField body='device' type='string'> +> **device**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:12 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledEmail.mdx new file mode 100644 index 000000000..00ce1af56 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledEmail.mdx @@ -0,0 +1,20 @@ +--- +title: "EnrolledEmail" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:2 + +## Properties + +<ParamField body='id' type='number'> +> **id**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:3 + +</ParamField> + +<ParamField body='email' type='string'> +> **email**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:4 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledPhoneNumber.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledPhoneNumber.mdx new file mode 100644 index 000000000..e622fdf65 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledPhoneNumber.mdx @@ -0,0 +1,20 @@ +--- +title: "EnrolledPhoneNumber" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:6 + +## Properties + +<ParamField body='id' type='number'> +> **id**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:7 + +</ParamField> + +<ParamField body='phoneNumber' type='string'> +> **phoneNumber**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:8 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection.mdx new file mode 100644 index 000000000..cad8dbb42 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection.mdx @@ -0,0 +1,62 @@ +--- +title: "EnterpriseConnection" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:116 + +## Extends + +- [`Connection`](./Connection) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:2 + +**Inherited from** + +[`Connection`](./Connection).[`name`](./Connection.md#name) + +</ParamField> + +<ParamField body='strategy' type='string'> +> **strategy**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:3 + +**Inherited from** + +[`Connection`](./Connection).[`strategy`](./Connection.md#strategy) + +</ParamField> + +<ParamField body='metadata?' type='Record<string, string>'> +> `optional` **metadata**: `Record`\<`string`, `string`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:4 + +**Inherited from** + +[`Connection`](./Connection).[`metadata`](./Connection.md#metadata) + +</ParamField> + +<ParamField body='options' type='object'> +> **options**: `object` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:117 + +**iconUrl?** + +> `optional` **iconUrl**: `string` + +**displayName?** + +> `optional` **displayName**: `string` + +**showAsButton** + +> **showAsButton**: `boolean` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.mdx new file mode 100644 index 000000000..d160b2977 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.mdx @@ -0,0 +1,38 @@ +--- +title: "Error" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:137 + +## Extended by + +- [`ErrorItem`](./ErrorItem) + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:138 + +</ParamField> + +<ParamField body='field?' type='string'> +> `optional` **field**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:139 + +</ParamField> + +<ParamField body='message' type='string'> +> **message**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:140 + +</ParamField> + +<ParamField body='rules?' type='[PasswordComplexityRule](./PasswordComplexityRule)[]'> +> `optional` **rules**: [`PasswordComplexityRule`](./PasswordComplexityRule)[] + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:141 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem.mdx new file mode 100644 index 000000000..fe2d6174b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem.mdx @@ -0,0 +1,75 @@ +--- +title: "ErrorItem" +--- + +Defined in: [packages/auth0-acul-react/src/state/error-store.ts:3](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/state/error-store.ts#L3) + +## Extends + +- [`Error`](./Error) + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:138 + +**Inherited from** + +[`Error`](./Error).[`code`](./Error.md#code) + +</ParamField> + +<ParamField body='field?' type='string'> +> `optional` **field**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:139 + +**Inherited from** + +[`Error`](./Error).[`field`](./Error.md#field) + +</ParamField> + +<ParamField body='message' type='string'> +> **message**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:140 + +**Inherited from** + +[`Error`](./Error).[`message`](./Error.md#message) + +</ParamField> + +<ParamField body='rules?' type='[PasswordComplexityRule](./PasswordComplexityRule)[]'> +> `optional` **rules**: [`PasswordComplexityRule`](./PasswordComplexityRule)[] + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:141 + +**Inherited from** + +[`Error`](./Error).[`rules`](./Error.md#rules) + +</ParamField> + +<ParamField body='id' type='string'> +> **id**: `string` + +Defined in: [packages/auth0-acul-react/src/state/error-store.ts:4](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/state/error-store.ts#L4) + +</ParamField> + +<ParamField body='label?' type='string'> +> `optional` **label**: `string` + +Defined in: [packages/auth0-acul-react/src/state/error-store.ts:5](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/state/error-store.ts#L5) + +</ParamField> + +<ParamField body='kind?' type='[ErrorKind](../type-aliases/ErrorKind)'> +> `optional` **kind**: [`ErrorKind`](../type-aliases/ErrorKind) + +Defined in: [packages/auth0-acul-react/src/state/error-store.ts:6](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/state/error-store.ts#L6) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult.mdx new file mode 100644 index 000000000..0a56f747d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult.mdx @@ -0,0 +1,61 @@ +--- +title: "ErrorsResult" +--- + +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:12](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L12) + +## Extends + +- `ReadonlyArray`\<[`ErrorItem`](./ErrorItem)\> + +## Indexable + +\[`n`: `number`\]: [`ErrorItem`](./ErrorItem) + +## Methods + +### byKind() + +> **byKind**(`kind`, `opts?`): readonly [`ErrorItem`](./ErrorItem)[] + +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:13](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L13) + +#### Parameters + +##### kind + +[`ErrorKind`](../type-aliases/ErrorKind) + +##### opts? + +###### field? + +`string` + +#### Returns + +readonly [`ErrorItem`](./ErrorItem)[] + +*** + +### byField() + +> **byField**(`field`, `opts?`): readonly [`ErrorItem`](./ErrorItem)[] + +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:14](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L14) + +#### Parameters + +##### field + +`string` + +##### opts? + +###### kind? + +[`ErrorKind`](../type-aliases/ErrorKind) + +#### Returns + +readonly [`ErrorItem`](./ErrorItem)[] \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginOptions.mdx new file mode 100644 index 000000000..0abf9b8ae --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginOptions.mdx @@ -0,0 +1,17 @@ +--- +title: "FederatedLoginOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:44 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + +<ParamField body='connection' type='string'> +> **connection**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:45 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPasswordOptions.mdx new file mode 100644 index 000000000..6ab4a011a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPasswordOptions.mdx @@ -0,0 +1,17 @@ +--- +title: "FederatedLoginPasswordOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:41 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + +<ParamField body='connection' type='string'> +> **connection**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:42 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPayloadOptions.mdx new file mode 100644 index 000000000..8997916d1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPayloadOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "FederatedLoginPayloadOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:64 + +Options for performing social login operations + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +Any additional custom options + +## Properties + +<ParamField body='connection' type='string'> +> **connection**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:66 + +The social connection name to use +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupOptions.mdx new file mode 100644 index 000000000..77b33de0f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupOptions.mdx @@ -0,0 +1,17 @@ +--- +title: "FederatedSignupOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:35 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + +<ParamField body='connection' type='string'> +> **connection**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:36 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPasswordPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPasswordPayloadOptions.mdx new file mode 100644 index 000000000..34a79bb14 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPasswordPayloadOptions.mdx @@ -0,0 +1,17 @@ +--- +title: "FederatedSignupPasswordPayloadOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:20 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + +<ParamField body='connection' type='string'> +> **connection**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:21 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPayloadOptions.mdx new file mode 100644 index 000000000..8756cac3d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPayloadOptions.mdx @@ -0,0 +1,17 @@ +--- +title: "FederatedSignupPayloadOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:17 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + +<ParamField body='connection' type='string'> +> **connection**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:18 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme.mdx new file mode 100644 index 000000000..31b2fb65f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme.mdx @@ -0,0 +1,41 @@ +--- +title: "FlattenedTheme" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:52 + +## Properties + +<ParamField body='colors' type='Record<string, string>'> +> **colors**: `Record`\<`string`, `string`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:53 + +</ParamField> + +<ParamField body='fonts' type='Record<string, string '> +> **fonts**: `Record`\<`string`, `string` \| `number` \| `boolean` \| `object`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:54 + +</ParamField> + +<ParamField body='borders' type='Record<string, string '> +> **borders**: `Record`\<`string`, `string` \| `number` \| `boolean`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:55 + +</ParamField> + +<ParamField body='pageBackground' type='Record<string, string>'> +> **pageBackground**: `Record`\<`string`, `string`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:56 + +</ParamField> + +<ParamField body='widget' type='Record<string, string '> +> **widget**: `Record`\<`string`, `string` \| `number`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:57 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier.mdx new file mode 100644 index 000000000..f0fe37654 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier.mdx @@ -0,0 +1,40 @@ +--- +title: "Identifier" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/signup-identifiers.d.ts:29 + +Describes a configured identifier field (e.g. email, phone, or username) +for use in a signup form or authentication flow. + +## Example + +```ts +const emailIdentifier: Identifier = { + type: 'email', + required: true +}; +``` + +## Properties + +<ParamField body='type' type='[ScreenIdentifierType](../type-aliases/ScreenIdentifierType)'> +> **type**: [`ScreenIdentifierType`](../type-aliases/ScreenIdentifierType) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/signup-identifiers.d.ts:35 + +The type of identifier, such as `'email'`, `'phone'`, or `'username'`. + +**See** + +IdentifierType + +</ParamField> + +<ParamField body='required' type='boolean'> +> **required**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/signup-identifiers.d.ts:39 + +Whether this identifier is required for signup. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers.mdx new file mode 100644 index 000000000..c2714aec6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers.mdx @@ -0,0 +1,126 @@ +--- +title: "InterstitialCaptchaMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/interstitial-captcha.d.ts:6 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='submitCaptcha()' type='(payload) => void'> +> **submitCaptcha**: (`payload`) => `void` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/interstitial-captcha.d.ts:7 + +**Parameters** + +**payload** + +[`SubmitCaptchaOptions`](./SubmitCaptchaOptions) + +**Returns** + +`void` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers.mdx new file mode 100644 index 000000000..3ce440ff6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers.mdx @@ -0,0 +1,268 @@ +--- +title: "LoginEmailVerificationMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-email-verification.d.ts:46 + +LoginEmailVerificationMembers +description Defines the members (properties and methods) available for interacting with the Login Email Verification screen. +This screen is a crucial part of email verification processes, typically during login, where a user must prove +ownership of an email address by providing a one-time code. The SDK facilitates submitting this code +or requesting a new one. + +The `universal_login_context` for this screen (`window.universal_login_context`) will contain: +- `client`: Information about the Auth0 application. +- `organization` (optional): Details if the authentication is for a specific organization. +- `prompt`: Context of the current authentication prompt (e.g., 'login'). +- `screen`: UI texts and general screen information. No screen-specific `data` fields are uniquely defined for `login-email-verification` beyond standard ones. +- `transaction`: Details of the ongoing transaction, including state and any errors from previous attempts (e.g., "invalid-code"). + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +**Methods** +</ParamField> + +<ParamField body='continueWithCode()' type='unknown'> +> **continueWithCode**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-email-verification.d.ts:90 + +Submits the email verification code entered by the user. +This action corresponds to the user entering the code they received via email and +clicking a "Continue" or "Verify" button. The SDK will then POST this code +to the Auth0 `/u/login-email-verification` endpoint. + +If the code is valid, Auth0 will typically redirect the user to the next step in the +authentication flow. If the code is invalid, expired, or another error occurs, +Auth0 will usually re-render the login-email-verification screen, and the +`transaction.errors` array in the SDK's context will be updated with details +about the failure (e.g., error code `invalid-code`). + +**Parameters** + +**payload** + +[`ContinueWithCodeOptionPayload`](./ContinueWithCodeOptionPayload) + +An object containing the `code` string entered by the user. + It can also include any `CustomOptions` for extensibility. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the form submission is initiated. + It does not return data directly upon resolution, as a redirect or + page re-render is the common outcome. + +**Throws** + +Throws an error if `payload.code` is not provided or is not a string, + or if the `FormHandler` encounters an unrecoverable issue during submission (e.g., network error). + Validation errors from Auth0 (like an invalid code) are not thrown as JavaScript errors + but are reflected in `this.transaction.errors` after the operation. + +**Example** + +```typescript +// Assuming 'manager' is an instance of LoginEmailVerification +const userInputCode = "123456"; +try { + await manager.continueWithCode({ code: userInputCode }); + // If successful, page redirects. No further client-side action needed here. +} catch (error) { + // This catch is for unexpected errors, not for Auth0 validation errors. + console.error("Failed to submit the verification code:", error); +} +// After the await, always check manager.transaction.errors for server-side validation issues. +if (manager.transaction.errors && manager.transaction.errors.length > 0) { + manager.transaction.errors.forEach(err => { + if (err.code === 'invalid-code') { + // Display "The code you entered is invalid" to the user. + } + }); +} +``` + +</ParamField> + +<ParamField body='resendCode()' type='unknown'> +> **resendCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-email-verification.d.ts:130 + +Requests a new verification code to be sent to the user's email address. +This action is typically invoked when the user clicks a "Resend Code" button, perhaps because +they didn't receive the first email, the code expired, or they suspect an issue. +The SDK will POST to the Auth0 `/u/login-email-verification` endpoint with an action indicating +a resend request. + +Upon successful submission of this request, Auth0 attempts to send a new email. +The page may re-render. If there are issues (e.g., too many resend attempts for the same email, +identified by error code `too-many-emails`), `transaction.errors` will be updated. + +**Parameters** + +**payload?** + +[`ResendCodeOptionsPayload`](./ResendCodeOptionsPayload) + +Optional. An object for `CustomOptions` if any + additional parameters need to be sent with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the resend request is initiated. + Like `continueWithCode`, this usually results in a page re-render or state update + rather than direct data in the promise resolution. + +**Throws** + +Throws if the `FormHandler` encounters an unrecoverable issue (e.g., network error). + Server-side errors (like rate limits) are reflected in `this.transaction.errors`. + +**Example** + +```typescript +// Assuming 'manager' is an instance of LoginEmailVerification +try { + await manager.resendCode(); + // Optionally, update UI to inform the user a new code has been sent. + alert("A new verification code has been dispatched to your email."); +} catch (error) { + console.error("Failed to request a new code:", error); +} +// After the await, check manager.transaction.errors for server-side issues. +if (manager.transaction.errors && manager.transaction.errors.length > 0) { + manager.transaction.errors.forEach(err => { + if (err.code === 'too-many-emails') { + // Display "You have requested too many emails. Please wait a few minutes." + } + }); +} +``` + +</ParamField> + +<ParamField body='resendManager()' type='unknown'> +> **resendManager**(`options?`): [`ResendControl`](./ResendControl) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-email-verification.d.ts:135 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](./StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](./ResendControl) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions.mdx new file mode 100644 index 000000000..4eb7966b5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "LoginEnrollOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-login-options.d.ts:17 + +Options for continuing with a selected MFA factor + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='action' type='[MfaLoginFactorType](../type-aliases/MfaLoginFactorType)'> +> **action**: [`MfaLoginFactorType`](../type-aliases/MfaLoginFactorType) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-login-options.d.ts:19 + +The action indicating which factor to use for login +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers.mdx new file mode 100644 index 000000000..076eeefd2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers.mdx @@ -0,0 +1,189 @@ +--- +title: "LoginIdMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:48 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnLoginId](./ScreenMembersOnLoginId)'> +> **screen**: [`ScreenMembersOnLoginId`](./ScreenMembersOnLoginId) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:49 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembersOnLoginId](./TransactionMembersOnLoginId)'> +> **transaction**: [`TransactionMembersOnLoginId`](./TransactionMembersOnLoginId) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:50 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='login()' type='unknown'> +> **login**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:51 + +**Parameters** + +**payload** + +[`LoginOptions`](./LoginOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='federatedLogin()' type='unknown'> +> **federatedLogin**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:52 + +**Parameters** + +**payload** + +[`FederatedLoginOptions`](./FederatedLoginOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='passkeyLogin()' type='unknown'> +> **passkeyLogin**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:53 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pickCountryCode()' type='unknown'> +> **pickCountryCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:54 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='getLoginIdentifiers()' type='unknown'> +> **getLoginIdentifiers**(): [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:55 + +**Returns** + +[`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers.mdx new file mode 100644 index 000000000..335f1d8e6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers.mdx @@ -0,0 +1,192 @@ +--- +title: "LoginMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:73 + +Login screen members interface extending base members + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnLogin](./ScreenMembersOnLogin)'> +> **screen**: [`ScreenMembersOnLogin`](./ScreenMembersOnLogin) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:74 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembersOnLogin](./TransactionMembersOnLogin)'> +> **transaction**: [`TransactionMembersOnLogin`](./TransactionMembersOnLogin) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:75 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='login()' type='unknown'> +> **login**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:80 + +Performs login with username/password + +**Parameters** + +**payload** + +[`LoginPayloadOptions`](./LoginPayloadOptions) + +The login options + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='federatedLogin()' type='unknown'> +> **federatedLogin**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:85 + +Performs login with social provider + +**Parameters** + +**payload** + +[`FederatedLoginPayloadOptions`](./FederatedLoginPayloadOptions) + +The social login options + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pickCountryCode()' type='unknown'> +> **pickCountryCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:90 + +Picks country code for phone number input + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='getLoginIdentifiers()' type='unknown'> +> **getLoginIdentifiers**(): [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:96 + +Gets the active identifier types for the login screen + +**Returns** + +[`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` + +An array of active identifier types or null if none are active + +**Utility Feature** +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginOptions.mdx new file mode 100644 index 000000000..76ecb3781 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginOptions.mdx @@ -0,0 +1,24 @@ +--- +title: "LoginOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:39 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='username' type='string'> +> **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:40 + +</ParamField> + +<ParamField body='captcha?' type='string'> +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:41 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers.mdx new file mode 100644 index 000000000..7c0ef33e6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers.mdx @@ -0,0 +1,144 @@ +--- +title: "LoginPasswordMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:45 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnLoginPassword](./ScreenMembersOnLoginPassword)'> +> **screen**: [`ScreenMembersOnLoginPassword`](./ScreenMembersOnLoginPassword) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:46 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembersOnLoginPassword](./TransactionMembersOnLoginPassword)'> +> **transaction**: [`TransactionMembersOnLoginPassword`](./TransactionMembersOnLoginPassword) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:47 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='login()' type='unknown'> +> **login**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:48 + +**Parameters** + +**payload** + +[`LoginPasswordOptions`](./LoginPasswordOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='federatedLogin()' type='unknown'> +> **federatedLogin**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:49 + +**Parameters** + +**payload** + +[`FederatedLoginPasswordOptions`](./FederatedLoginPasswordOptions) + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordOptions.mdx new file mode 100644 index 000000000..452bd8a6d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordOptions.mdx @@ -0,0 +1,31 @@ +--- +title: "LoginPasswordOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:35 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='username' type='string'> +> **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:36 + +</ParamField> + +<ParamField body='password' type='string'> +> **password**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:37 + +</ParamField> + +<ParamField body='captcha?' type='string'> +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:38 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers.mdx new file mode 100644 index 000000000..9ed0057c3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers.mdx @@ -0,0 +1,161 @@ +--- +title: "LoginPasswordlessEmailCodeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:23 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnLoginPasswordlessEmailCode](./ScreenMembersOnLoginPasswordlessEmailCode)'> +> **screen**: [`ScreenMembersOnLoginPasswordlessEmailCode`](./ScreenMembersOnLoginPasswordlessEmailCode) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:24 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembersOnLoginPasswordlessEmailCode](./TransactionMembersOnLoginPasswordlessEmailCode)'> +> **transaction**: [`TransactionMembersOnLoginPasswordlessEmailCode`](./TransactionMembersOnLoginPasswordlessEmailCode) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:25 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='submitCode()' type='unknown'> +> **submitCode**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:26 + +**Parameters** + +**payload** + +[`SubmitCodeOptions`](./SubmitCodeOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendCode()' type='unknown'> +> **resendCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:27 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager()' type='unknown'> +> **resendManager**(`options?`): [`ResendControl`](./ResendControl) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:28 + +**Parameters** + +**options?** + +[`StartResendOptions`](./StartResendOptions) + +**Returns** + +[`ResendControl`](./ResendControl) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers.mdx new file mode 100644 index 000000000..18b2472cd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers.mdx @@ -0,0 +1,165 @@ +--- +title: "LoginPasswordlessSmsOtpMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:31 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnLoginPasswordlessSmsOtp](./ScreenMembersOnLoginPasswordlessSmsOtp)'> +> **screen**: [`ScreenMembersOnLoginPasswordlessSmsOtp`](./ScreenMembersOnLoginPasswordlessSmsOtp) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:32 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembersOnLoginPasswordlessSmsOtp](./TransactionMembersOnLoginPasswordlessSmsOtp)'> +> **transaction**: [`TransactionMembersOnLoginPasswordlessSmsOtp`](./TransactionMembersOnLoginPasswordlessSmsOtp) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:33 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='submitOTP()' type='unknown'> +> **submitOTP**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:34 + +**Parameters** + +**payload** + +[`SubmitOTPOptions`](./SubmitOTPOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendOTP()' type='unknown'> +> **resendOTP**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:35 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager()' type='unknown'> +> **resendManager**(`options?`): [`ResendControl`](./ResendControl) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:40 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](./StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](./ResendControl) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPayloadOptions.mdx new file mode 100644 index 000000000..0c7b40569 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPayloadOptions.mdx @@ -0,0 +1,41 @@ +--- +title: "LoginPayloadOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:51 + +Options for performing login operations + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='username' type='string'> +> **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:53 + +The username/email to login with + +</ParamField> + +<ParamField body='password' type='string'> +> **password**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:55 + +The password for authentication + +</ParamField> + +<ParamField body='captcha?' type='string'> +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:57 + +Optional captcha value if required +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers.mdx new file mode 100644 index 000000000..695e499ff --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers.mdx @@ -0,0 +1,111 @@ +--- +title: "LogoutAbortedMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/logout-aborted.d.ts:5 + +Interface defining the available methods and properties for the logout-aborted screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers.mdx new file mode 100644 index 000000000..98c1b6bf0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers.mdx @@ -0,0 +1,111 @@ +--- +title: "LogoutCompleteMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/logout-complete.d.ts:5 + +Interface defining the available methods and properties for the logout-complete screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers.mdx new file mode 100644 index 000000000..e20bb4080 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers.mdx @@ -0,0 +1,133 @@ +--- +title: "LogoutMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/logout.d.ts:13 + +Interface defining the available methods and properties for the logout screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +**Methods** +</ParamField> + +<ParamField body='confirmLogout()' type='unknown'> +> **confirmLogout**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/logout.d.ts:18 + +Confirms the logout action (accept or deny) + +**Parameters** + +**payload** + +[`ConfirmLogoutOptions`](./ConfirmLogoutOptions) + +The options containing the action to perform + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers.mdx new file mode 100644 index 000000000..9de56c8ce --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers.mdx @@ -0,0 +1,133 @@ +--- +title: "MfaBeginEnrollOptionsMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-begin-enroll-options.d.ts:15 + +MFA Begin Enroll Options screen members interface + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +**Methods** +</ParamField> + +<ParamField body='enroll()' type='unknown'> +> **enroll**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-begin-enroll-options.d.ts:20 + +Continues the enrollment process with the selected factor + +**Parameters** + +**payload** + +[`MfaEnrollOptions`](./MfaEnrollOptions) + +The enrollment options including the selected factor + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers.mdx new file mode 100644 index 000000000..e9f9476d7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers.mdx @@ -0,0 +1,154 @@ +--- +title: "MfaCountryCodesMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-country-codes.d.ts:27 + +Interface defining the available methods and properties for the mfa-country-codes screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaCountryCodes](./ScreenMembersOnMfaCountryCodes)'> +> **screen**: [`ScreenMembersOnMfaCountryCodes`](./ScreenMembersOnMfaCountryCodes) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-country-codes.d.ts:28 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='selectCountryCode()' type='unknown'> +> **selectCountryCode**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-country-codes.d.ts:33 + +Selects a country code from the available options + +**Parameters** + +**payload** + +[`SelectCountryCodeOptions`](./SelectCountryCodeOptions) + +The options containing the country code selection action + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='goBack()' type='unknown'> +> **goBack**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-country-codes.d.ts:38 + +Navigates back to the previous screen + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx new file mode 100644 index 000000000..4a770fed5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx @@ -0,0 +1,140 @@ +--- +title: "MfaDetectBrowserCapabilitiesMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-detect-browser-capabilities.d.ts:6 + +Interface defining the available methods and properties for the mfa-detect-browser-capabilities screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +**Methods** +</ParamField> + +<ParamField body='detectCapabilities()' type='unknown'> +> **detectCapabilities**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-detect-browser-capabilities.d.ts:16 + +Picks an authenticator based on browser capabilities + +**Parameters** + +**payload** + +[`CustomOptions`](./CustomOptions) + +The options containing browser capability flags + +**Returns** + +`Promise`\<`void`\> + +**Example** + +```typescript +const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); +await mfaDetectBrowserCapabilities.detectCapabilities(); +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers.mdx new file mode 100644 index 000000000..ace7db102 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers.mdx @@ -0,0 +1,217 @@ +--- +title: "MfaEmailChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:51 + +Interface defining the available methods and properties for the mfa-email-challenge screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaEmailChallenge](./ScreenMembersOnMfaEmailChallenge)'> +> **screen**: [`ScreenMembersOnMfaEmailChallenge`](./ScreenMembersOnMfaEmailChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:52 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembersOnMfaEmailChallenge](./UntrustedDataMembersOnMfaEmailChallenge)'> +> **untrustedData**: [`UntrustedDataMembersOnMfaEmailChallenge`](./UntrustedDataMembersOnMfaEmailChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:53 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:58 + +Continues with the email challenge using the provided code + +**Parameters** + +**payload** + +[`ContinuePayloadOptions`](./ContinuePayloadOptions) + +The options containing the code and rememberDevice flag + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendCode()' type='unknown'> +> **resendCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:63 + +Resends the email code + +**Parameters** + +**payload?** + +[`ResendCodePayloadOptions`](./ResendCodePayloadOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:68 + +Allows the user to try another MFA method + +**Parameters** + +**payload?** + +[`TryAnotherMethodPayloadOptions`](./TryAnotherMethodPayloadOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pickEmail()' type='unknown'> +> **pickEmail**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:73 + +Submits the action to pick a different Email configuration, if available + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager()' type='unknown'> +> **resendManager**(`options?`): [`ResendControl`](./ResendControl) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:78 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](./StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](./ResendControl) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers.mdx new file mode 100644 index 000000000..3d9c01657 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers.mdx @@ -0,0 +1,154 @@ +--- +title: "MfaEmailListMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-list.d.ts:28 + +Interface defining the available methods and properties for the mfa-email-list screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaEmailList](./ScreenMembersOnMfaEmailList)'> +> **screen**: [`ScreenMembersOnMfaEmailList`](./ScreenMembersOnMfaEmailList) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-list.d.ts:29 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='selectMfaEmail()' type='unknown'> +> **selectMfaEmail**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-list.d.ts:34 + +Selects an enrolled email address from the list + +**Parameters** + +**payload** + +[`SelectMfaEmailOptions`](./SelectMfaEmailOptions) + +The options containing the selection action + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='goBack()' type='unknown'> +> **goBack**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-list.d.ts:39 + +Navigates back to the previous screen + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions.mdx new file mode 100644 index 000000000..0dff70c94 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "MfaEnrollOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-begin-enroll-options.d.ts:6 + +Options for continuing with factor enrollment + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='action' type='[MfaEnrollFactorType](../type-aliases/MfaEnrollFactorType)'> +> **action**: [`MfaEnrollFactorType`](../type-aliases/MfaEnrollFactorType) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-begin-enroll-options.d.ts:8 + +The action indicating which factor to enroll +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers.mdx new file mode 100644 index 000000000..b74bc429e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers.mdx @@ -0,0 +1,113 @@ +--- +title: "MfaEnrollResultMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-enroll-result.d.ts:43 + +MfaEnrollResultMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaEnrollResult](./ScreenMembersOnMfaEnrollResult)'> +> **screen**: [`ScreenMembersOnMfaEnrollResult`](./ScreenMembersOnMfaEnrollResult) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-enroll-result.d.ts:49 + +Screen-specific data, including enrollment status. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers.mdx new file mode 100644 index 000000000..b4063febb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers.mdx @@ -0,0 +1,170 @@ +--- +title: "MfaLoginOptionsMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-login-options.d.ts:26 + +Interface defining the available methods and properties for the mfa-login-options screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaLoginOptions](./ScreenMembersOnMfaLoginOptions)'> +> **screen**: [`ScreenMembersOnMfaLoginOptions`](./ScreenMembersOnMfaLoginOptions) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-login-options.d.ts:27 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='enroll()' type='unknown'> +> **enroll**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-login-options.d.ts:39 + +Continues the login process with the selected MFA factor + +**Parameters** + +**payload** + +[`LoginEnrollOptions`](./LoginEnrollOptions) + +The options containing the selected factor + +**Returns** + +`Promise`\<`void`\> + +**Example** + +```typescript +const mfaLoginOptions = new MfaLoginOptions(); +await mfaLoginOptions.enroll({ + action: 'push-notification' +}); +``` + +</ParamField> + +<ParamField body='returnToPrevious()' type='unknown'> +> **returnToPrevious**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-login-options.d.ts:49 + +Returns to the previous screen in the authentication flow + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options + +**Returns** + +`Promise`\<`void`\> + +**Example** + +```typescript +const mfaLoginOptions = new MfaLoginOptions(); +await mfaLoginOptions.returnToPrevious(); +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers.mdx new file mode 100644 index 000000000..730bdb507 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers.mdx @@ -0,0 +1,154 @@ +--- +title: "MfaOtpChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:41 + +Interface defining the available methods and properties for the mfa-otp-challenge screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaOtpChallenge](./ScreenMembersOnMfaOtpChallenge)'> +> **screen**: [`ScreenMembersOnMfaOtpChallenge`](./ScreenMembersOnMfaOtpChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:42 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembersOnMfaOtpChallenge](./UntrustedDataMembersOnMfaOtpChallenge)'> +> **untrustedData**: [`UntrustedDataMembersOnMfaOtpChallenge`](./UntrustedDataMembersOnMfaOtpChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:43 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:48 + +Continues with the OTP challenge using the provided code + +**Parameters** + +**payload** + +[`ContinueOTPOptions`](./ContinueOTPOptions) + +The options containing the code and rememberDevice flag + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:53 + +Allows the user to try another MFA method + +**Parameters** + +**payload?** + +[`TryAnotherMethodMfaOtpChallengeOptions`](./TryAnotherMethodMfaOtpChallengeOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpContinueOptions.mdx new file mode 100644 index 000000000..87026634b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpContinueOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "MfaOtpContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-code.d.ts:6 + +Options for continuing with the MFA OTP enrollment code. + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options. + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-code.d.ts:10 + +The OTP code entered by the user. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers.mdx new file mode 100644 index 000000000..802359bd2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers.mdx @@ -0,0 +1,156 @@ +--- +title: "MfaOtpEnrollmentCodeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-code.d.ts:39 + +Interface defining the available methods and properties for the mfa-otp-enrollment-code screen. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaOtpEnrollmentCode](./ScreenMembersOnMfaOtpEnrollmentCode)'> +> **screen**: [`ScreenMembersOnMfaOtpEnrollmentCode`](./ScreenMembersOnMfaOtpEnrollmentCode) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-code.d.ts:43 + +The screen properties for the mfa-otp-enrollment-code screen. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-code.d.ts:48 + +Continues the MFA OTP enrollment process by submitting the OTP code. + +**Parameters** + +**payload** + +[`MfaOtpContinueOptions`](./MfaOtpContinueOptions) + +The options containing the OTP code. + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-code.d.ts:53 + +Allows the user to try another MFA method. + +**Parameters** + +**payload?** + +[`MfaOtpTryAnotherMethodOptions`](./MfaOtpTryAnotherMethodOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx new file mode 100644 index 000000000..87a3e12e6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "MfaOtpEnrollmentQrContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-qr.d.ts:16 + +Interface for the payload of the continue method + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-qr.d.ts:17 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers.mdx new file mode 100644 index 000000000..34b9e8e35 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers.mdx @@ -0,0 +1,175 @@ +--- +title: "MfaOtpEnrollmentQrMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-qr.d.ts:22 + +Interface defining the available methods and properties for the mfa-otp-enrollment-qr screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaOtpEnrollmentQr](./ScreenMembersOnMfaOtpEnrollmentQr)'> +> **screen**: [`ScreenMembersOnMfaOtpEnrollmentQr`](./ScreenMembersOnMfaOtpEnrollmentQr) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-qr.d.ts:23 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='toggleView()' type='unknown'> +> **toggleView**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-qr.d.ts:28 + +Toggles the view. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-qr.d.ts:33 + +Continues with the default action. + +**Parameters** + +**payload** + +[`MfaOtpEnrollmentQrContinueOptions`](./MfaOtpEnrollmentQrContinueOptions) + +Payload containing code and optional custom options + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-qr.d.ts:38 + +Allows trying another authentication method + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..871293f62 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpTryAnotherMethodOptions.mdx @@ -0,0 +1,13 @@ +--- +title: "MfaOtpTryAnotherMethodOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-code.d.ts:19 + +Options for trying another MFA method. + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options. \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions.mdx new file mode 100644 index 000000000..01d391f8d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "MfaPhoneChallengeContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:29 + +ContinueOptions +Defines the options required to continue the MFA phone challenge process. +This typically involves selecting the method (SMS or Voice) to receive the verification code. + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='type' type='"voice" '> +> **type**: `"voice"` \| `"sms"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:36 + +The type of challenge to perform. +'sms': Send the code via text message. +'voice': Send the code via a voice call. + +**Default** + +```ts +'sms' +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers.mdx new file mode 100644 index 000000000..849b961fd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers.mdx @@ -0,0 +1,231 @@ +--- +title: "MfaPhoneChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:58 + +MfaPhoneChallengeMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaPhoneChallenge](./ScreenMembersOnMfaPhoneChallenge)'> +> **screen**: [`ScreenMembersOnMfaPhoneChallenge`](./ScreenMembersOnMfaPhoneChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:62 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:84 + +continue +Submits the choice of MFA delivery method (SMS or Voice) to proceed with the challenge. +This will trigger sending the verification code to the user's phone. + +**Parameters** + +**payload** + +[`MfaPhoneChallengeContinueOptions`](./MfaPhoneChallengeContinueOptions) + +The options specifying the delivery type ('sms' or 'voice'). + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the action is submitted. + +**Throws** + +Throws an error if the submission fails. + +**Example** + +```typescript +import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + +const mfaPhoneChallenge = new MfaPhoneChallenge(); + +// To send the code via SMS +await mfaPhoneChallenge.continue({ type: 'sms' }); + +// To send the code via Voice Call +await mfaPhoneChallenge.continue({ type: 'voice' }); +``` + +</ParamField> + +<ParamField body='pickPhone()' type='unknown'> +> **pickPhone**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:101 + +pickPhone +Initiates the action to pick a different phone number. +This typically redirects the user to a screen where they can select from multiple enrolled phone numbers, if applicable. + +**Parameters** + +**payload?** + +[`MfaPhoneChallengePickPhoneOptions`](./MfaPhoneChallengePickPhoneOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the action is submitted. + +**Throws** + +Throws an error if the submission fails. + +**Example** + +```typescript +import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + +const mfaPhoneChallenge = new MfaPhoneChallenge(); +await mfaPhoneChallenge.pickPhone(); +``` + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:118 + +tryAnotherMethod +Initiates the action to select a different MFA factor/authenticator. +This redirects the user to a screen where they can choose an alternative MFA method (e.g., OTP app, recovery code). + +**Parameters** + +**payload?** + +[`MfaPhoneChallengePickAuthenticatorOptions`](./MfaPhoneChallengePickAuthenticatorOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the action is submitted. + +**Throws** + +Throws an error if the submission fails. + +**Example** + +```typescript +import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + +const mfaPhoneChallenge = new MfaPhoneChallenge(); +await mfaPhoneChallenge.tryAnotherMethod(); +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx new file mode 100644 index 000000000..307dec8ee --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx @@ -0,0 +1,17 @@ +--- +title: "MfaPhoneChallengePickAuthenticatorOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:51 + +PickAuthenticatorOptions +Defines the options for the 'pick-authenticator' action. +This allows the user to choose a different MFA method if available. + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions.mdx new file mode 100644 index 000000000..8c05c431e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions.mdx @@ -0,0 +1,18 @@ +--- +title: "MfaPhoneChallengePickPhoneOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:44 + +PickPhoneOptions +Defines the options for the 'pick-phone' action. +Although the interface only shows one phone number, this action might be used +in scenarios where the server needs to redirect to a phone selection screen. + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions.mdx new file mode 100644 index 000000000..3b9a113b7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions.mdx @@ -0,0 +1,32 @@ +--- +title: "MfaPhoneEnrollmentContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:13 + +Options for continuing with the MFA phone enrollment. + +Extends `CustomOptions` to allow passing custom options alongside phone and type. + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='phone' type='string'> +> **phone**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:14 + +</ParamField> + +<ParamField body='type' type='"voice" '> +> **type**: `"voice"` \| `"sms"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:15 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers.mdx new file mode 100644 index 000000000..6c1a2eb55 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers.mdx @@ -0,0 +1,173 @@ +--- +title: "MfaPhoneEnrollmentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:17 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:18 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:19 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:20 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:21 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:22 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='pickCountryCode()' type='unknown'> +> **pickCountryCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:27 + +Selects the country code for the phone number. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='continueEnrollment()' type='unknown'> +> **continueEnrollment**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:32 + +Continues the enrollment process with the provided phone number and type (SMS or voice). + +**Parameters** + +**payload** + +[`MfaPhoneEnrollmentContinueOptions`](./MfaPhoneEnrollmentContinueOptions) + +The phone number, type, and optional custom options. + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:37 + +Allows the user to try another MFA method. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult.mdx new file mode 100644 index 000000000..e9db5c3cc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult.mdx @@ -0,0 +1,53 @@ +--- +title: "MfaPollingResult" +--- + +Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L17) + +Result object returned by [useMfaPolling](../../Hooks/functions/useMfaPolling). + +## Properties + +<ParamField body='isRunning' type='boolean'> +> **isRunning**: `boolean` + +Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L25) + +Indicates whether the MFA push polling process is currently active. + +- `true` — Polling is running and awaiting completion. +- `false` — Polling has stopped, either due to completion, + manual cancellation, or component unmount. + +</ParamField> + +<ParamField body='startPolling()' type='() => void'> +> **startPolling**: () => `void` + +Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L33) + +Starts or resumes the polling process. + +- If polling is already active, this call has no effect. +- If previously stopped, calling this restarts the polling loop. + +**Returns** + +`void` + +</ParamField> + +<ParamField body='stopPolling()' type='() => void'> +> **stopPolling**: () => `void` + +Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:41](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L41) + +Stops the polling process immediately. + +- Cancels any scheduled timers or in-flight requests. +- Safe to call multiple times; subsequent calls have no effect. + +**Returns** + +`void` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers.mdx new file mode 100644 index 000000000..d79a136a9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers.mdx @@ -0,0 +1,219 @@ +--- +title: "MfaPushChallengePushMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:31 + +Interface defining the available methods and properties for the mfa-push-challenge-push screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaPushChallengePush](./ScreenMembersOnMfaPushChallengePush)'> +> **screen**: [`ScreenMembersOnMfaPushChallengePush`](./ScreenMembersOnMfaPushChallengePush) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:32 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembersOnMfaPushChallengePush](./UntrustedDataMembersOnMfaPushChallengePush)'> +> **untrustedData**: [`UntrustedDataMembersOnMfaPushChallengePush`](./UntrustedDataMembersOnMfaPushChallengePush) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:33 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:38 + +Continues with the push notification challenge + +**Parameters** + +**payload?** + +[`WithRememberOptions`](./WithRememberOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendPushNotification()' type='unknown'> +> **resendPushNotification**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:43 + +Resends the push notification + +**Parameters** + +**payload?** + +[`WithRememberOptions`](./WithRememberOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='enterCodeManually()' type='unknown'> +> **enterCodeManually**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:48 + +Switches to entering the verification code manually + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:53 + +Allows trying another authentication method + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pollingManager()' type='unknown'> +> **pollingManager**(`options`): [`MfaPushPollingControl`](./MfaPushPollingControl) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:59 + +Manages polling for MFA push challenge status + +**Parameters** + +**options** + +[`MfaPollingOptions`](../type-aliases/MfaPollingOptions) + +Configuration options for polling of type [MfaPollingOptions](../type-aliases/MfaPollingOptions) + +**Returns** + +[`MfaPushPollingControl`](./MfaPushPollingControl) + +An object to control the polling process +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers.mdx new file mode 100644 index 000000000..9f0cd061b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers.mdx @@ -0,0 +1,150 @@ +--- +title: "MfaPushEnrollmentQrMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-enrollment-qr.d.ts:18 + +Interface defining the available methods and properties for the mfa-push-enrollment-qr screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaPushEnrollmentQr](./ScreenMembersOnMfaPushEnrollmentQr)'> +> **screen**: [`ScreenMembersOnMfaPushEnrollmentQr`](./ScreenMembersOnMfaPushEnrollmentQr) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-enrollment-qr.d.ts:19 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='pickAuthenticator()' type='unknown'> +> **pickAuthenticator**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-enrollment-qr.d.ts:24 + +Navigates to the authenticator selection screen. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pollingManager()' type='unknown'> +> **pollingManager**(`options`): [`MfaPushPollingControl`](./MfaPushPollingControl) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-enrollment-qr.d.ts:25 + +**Parameters** + +**options** + +[`MfaPollingOptions`](../type-aliases/MfaPollingOptions) + +**Returns** + +[`MfaPushPollingControl`](./MfaPushPollingControl) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers.mdx new file mode 100644 index 000000000..ccd63733b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers.mdx @@ -0,0 +1,154 @@ +--- +title: "MfaPushListMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-list.d.ts:17 + +Interface defining the available methods and properties for the mfa-push-list screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +**Methods** +</ParamField> + +<ParamField body='selectMfaPushDevice()' type='unknown'> +> **selectMfaPushDevice**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-list.d.ts:22 + +Selects a registered device from the list to initiate MFA push. + +**Parameters** + +**payload** + +[`SelectMfaPushDeviceOptions`](./SelectMfaPushDeviceOptions) + +The options containing the device index. + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='goBack()' type='unknown'> +> **goBack**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-list.d.ts:27 + +Navigates back to the previous screen. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl.mdx new file mode 100644 index 000000000..c479f300e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl.mdx @@ -0,0 +1,87 @@ +--- +title: "MfaPushPollingControl" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/polling-control.d.ts:49 + +Control interface for managing an MFA push-notification polling session. + +This interface provides imperative methods to start, stop, and inspect the status of a +long-running polling loop that checks whether an MFA push challenge has been +approved. + +## Properties + +<ParamField body='stopPolling()' type='() => void'> +> **stopPolling**: () => `void` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/polling-control.d.ts:66 + +Stops the polling process immediately. + +- Cancels any scheduled timer or pending request. +- Once stopped, `isRunning()` returns `false`. +- Safe to call multiple times; subsequent calls have no effect. + +**Returns** + +`void` + +**Example** + +```ts +const control = mfaPushChallengePush.pollingManager({ intervalMs: 5000 }); +control.startPolling(); + +// Later, if the user cancels: +control.stopPolling(); +``` + +</ParamField> + +<ParamField body='startPolling()' type='() => void'> +> **startPolling**: () => `void` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/polling-control.d.ts:78 + +Starts or resumes the polling process. + +- If polling is already active, calling this again has no effect. +- If previously stopped, calling this restarts the polling loop. + +**Returns** + +`void` + +**Example** + +```ts +control.startPolling(); // Begin checking the MFA push challenge +``` + +</ParamField> + +<ParamField body='isRunning()' type='() => boolean'> +> **isRunning**: () => `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/polling-control.d.ts:94 + +Indicates whether the polling process is currently running. + +- Returns `true` if polling is active and not cancelled. +- Returns `false` if polling has been stopped or has completed. + +**Returns** + +`boolean` + +**Example** + +```ts +if (control.isRunning()) { + console.log('Polling in progress...'); +} else { + console.log('Polling is stopped or completed.'); +} +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers.mdx new file mode 100644 index 000000000..8deb0f188 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers.mdx @@ -0,0 +1,144 @@ +--- +title: "MfaPushWelcomeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcome.d.ts:16 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaPushWelcome](./ScreenMembersOnMfaPushWelcome)'> +> **screen**: [`ScreenMembersOnMfaPushWelcome`](./ScreenMembersOnMfaPushWelcome) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcome.d.ts:17 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='enroll()' type='unknown'> +> **enroll**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcome.d.ts:18 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pickAuthenticator()' type='unknown'> +> **pickAuthenticator**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcome.d.ts:19 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx new file mode 100644 index 000000000..18b7f7023 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "MfaRecoveryCodeChallengeContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:11 + +Options for continuing with the MFA Recovery Code Challenge. + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:12 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers.mdx new file mode 100644 index 000000000..20f235fa0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers.mdx @@ -0,0 +1,158 @@ +--- +title: "MfaRecoveryCodeChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:17 + +Interface describing the members of the Mfa Recovery Code Challenge screen. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:18 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:19 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:20 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:21 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:22 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:28 + +Continues with the provided recovery code. + +**Parameters** + +**payload** + +[`MfaRecoveryCodeChallengeContinueOptions`](./MfaRecoveryCodeChallengeContinueOptions) + +The continue options containing the recovery code and optional custom options. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the continuation is successful. + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:34 + +Navigates to the screen where the user can pick another MFA method. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional payload. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the navigation is complete. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx new file mode 100644 index 000000000..6a7fbdc0f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx @@ -0,0 +1,15 @@ +--- +title: "MfaRecoveryCodeChallengeNewCodeContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge-new-code.d.ts:30 + +ContinueOptions + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx new file mode 100644 index 000000000..6f00343b2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx @@ -0,0 +1,161 @@ +--- +title: "MfaRecoveryCodeChallengeNewCodeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge-new-code.d.ts:39 + +MfaRecoveryCodeChallengeNewCodeMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaRecoveryCodeChallengeNewCode](./ScreenMembersOnMfaRecoveryCodeChallengeNewCode)'> +> **screen**: [`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](./ScreenMembersOnMfaRecoveryCodeChallengeNewCode) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge-new-code.d.ts:45 + +Access to the specific properties and data of the 'mfa-recovery-code-challenge-new-code' screen. +Includes the `textCode` which is the recovery code to be displayed. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge-new-code.d.ts:71 + +Confirms that the user has saved the new recovery code and continues the authentication flow. +This method should be called after the user indicates they have securely stored the displayed recovery code. +It sends a confirmation to the Auth0 server to proceed to the next step. + +**Parameters** + +**payload?** + +[`MfaRecoveryCodeChallengeNewCodeContinueOptions`](./MfaRecoveryCodeChallengeNewCodeContinueOptions) + +Optional custom data to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the confirmation is successfully submitted. + +**Throws** + +Throws an error if the submission fails (e.g., network issue, invalid state). + +**Example** + +```typescript +import MfaRecoveryCodeChallengeNewCode from '@auth0/auth0-acul-js/mfa-recovery-code-challenge-new-code'; + +const screenManager = new MfaRecoveryCodeChallengeNewCode(); + +// Assuming the user has checked a box confirming they saved the code +try { + await screenManager.continue(); + // Redirects to the next screen on success +} catch (error) { + console.error("Failed to confirm recovery code saved:", error); + // Handle error, e.g., display a message from screenManager.transaction.errors +} +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx new file mode 100644 index 000000000..a694479cb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx @@ -0,0 +1,21 @@ +--- +title: "MfaRecoveryCodeEnrollmentContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-enrollment.d.ts:15 + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='isCodeCopied' type='boolean'> +> **isCodeCopied**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-enrollment.d.ts:16 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx new file mode 100644 index 000000000..7ae2c0df3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx @@ -0,0 +1,138 @@ +--- +title: "MfaRecoveryCodeEnrollmentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-enrollment.d.ts:21 + +Interface describing the members of the Mfa Recovery Code Enrollment screen. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaRecoveryCodeEnrollment](./ScreenMembersOnMfaRecoveryCodeEnrollment)'> +> **screen**: [`ScreenMembersOnMfaRecoveryCodeEnrollment`](./ScreenMembersOnMfaRecoveryCodeEnrollment) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-enrollment.d.ts:22 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-enrollment.d.ts:33 + +Declares that the user saved the recovery code. +This action is triggered when the user declares that they have saved the recovery code. +It redirects to the next screen in the authentication flow. + +**Parameters** + +**payload** + +[`MfaRecoveryCodeEnrollmentContinueOptions`](./MfaRecoveryCodeEnrollmentContinueOptions) + +An object containing any custom options. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted. +Rejects with an error if the submission fails. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers.mdx new file mode 100644 index 000000000..c376a2bd6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers.mdx @@ -0,0 +1,216 @@ +--- +title: "MfaSmsChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:30 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaSmsChallenge](./ScreenMembersOnMfaSmsChallenge)'> +> **screen**: [`ScreenMembersOnMfaSmsChallenge`](./ScreenMembersOnMfaSmsChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:31 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembersOnMfaSmsChallenge](./UntrustedDataMembersOnMfaSmsChallenge)'> +> **untrustedData**: [`UntrustedDataMembersOnMfaSmsChallenge`](./UntrustedDataMembersOnMfaSmsChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:32 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +**Methods** +</ParamField> + +<ParamField body='continueMfaSmsChallenge()' type='unknown'> +> **continueMfaSmsChallenge**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:33 + +**Parameters** + +**payload** + +[`MfaSmsChallengeOptions`](./MfaSmsChallengeOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pickSms()' type='unknown'> +> **pickSms**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:34 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendCode()' type='unknown'> +> **resendCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:35 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:36 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='getACall()' type='unknown'> +> **getACall**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:37 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager()' type='unknown'> +> **resendManager**(`options?`): [`ResendControl`](./ResendControl) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:42 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](./StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](./ResendControl) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeOptions.mdx new file mode 100644 index 000000000..4ca102bfe --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeOptions.mdx @@ -0,0 +1,24 @@ +--- +title: "MfaSmsChallengeOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:6 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:7 + +</ParamField> + +<ParamField body='rememberDevice?' type='boolean'> +> `optional` **rememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:8 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers.mdx new file mode 100644 index 000000000..d0d1caec0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers.mdx @@ -0,0 +1,167 @@ +--- +title: "MfaSmsEnrollmentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:14 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaSmsEnrollment](./ScreenMembersOnMfaSmsEnrollment)'> +> **screen**: [`ScreenMembersOnMfaSmsEnrollment`](./ScreenMembersOnMfaSmsEnrollment) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:15 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='pickCountryCode()' type='unknown'> +> **pickCountryCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:16 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='continueEnrollment()' type='unknown'> +> **continueEnrollment**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:17 + +**Parameters** + +**payload** + +**phone** + +`string` + +**captcha?** + +`string` + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:21 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentOptions.mdx new file mode 100644 index 000000000..dbc3861d7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentOptions.mdx @@ -0,0 +1,24 @@ +--- +title: "MfaSmsEnrollmentOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:4 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='phone?' type='string'> +> `optional` **phone**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:5 + +</ParamField> + +<ParamField body='captcha?' type='string'> +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:6 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers.mdx new file mode 100644 index 000000000..133241704 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers.mdx @@ -0,0 +1,159 @@ +--- +title: "MfaSmsListMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-list.d.ts:20 + +MfaSmsListMembers +Interface defining the members and methods for the MfaSmsList class. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +**Methods** +</ParamField> + +<ParamField body='selectPhoneNumber()' type='unknown'> +> **selectPhoneNumber**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-list.d.ts:27 + +Selects a phone number from the list of enrolled phone numbers. + +**Parameters** + +**payload?** + +[`MfaSmsListOptions`](./MfaSmsListOptions) + +Optional payload for the action. + +**Returns** + +`Promise`\<`void`\> + +**Throws** + +If the index is out of bounds. + +</ParamField> + +<ParamField body='backAction()' type='unknown'> +> **backAction**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-list.d.ts:33 + +Navigates back to the previous screen. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional payload for the action. + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListOptions.mdx new file mode 100644 index 000000000..be96b9eed --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListOptions.mdx @@ -0,0 +1,26 @@ +--- +title: "MfaSmsListOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-list.d.ts:7 + +MfaSmsListOptions +Options for performing actions on the mfa-sms-list screen. + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='index' type='number'> +> **index**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-list.d.ts:11 + +**Param** + +The index of the phone number to select. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeContinueOptions.mdx new file mode 100644 index 000000000..72a77419d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeContinueOptions.mdx @@ -0,0 +1,32 @@ +--- +title: "MfaVoiceChallengeContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:9 + +Options for submitting the voice challenge code. + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Additional custom options to pass with the request. + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:13 + +The verification code received via voice call. + +</ParamField> + +<ParamField body='rememberDevice?' type='boolean'> +> `optional` **rememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:17 + +Optional flag to remember the device for 30 days, skipping future MFA challenges. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers.mdx new file mode 100644 index 000000000..9ee681159 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers.mdx @@ -0,0 +1,288 @@ +--- +title: "MfaVoiceChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:48 + +Interface defining all members and operations available on the MFA Voice Challenge screen. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaVoiceChallenge](./ScreenMembersOnMfaVoiceChallenge)'> +> **screen**: [`ScreenMembersOnMfaVoiceChallenge`](./ScreenMembersOnMfaVoiceChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:52 + +Screen-specific properties and data. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembersOnMfaVoiceChallenge](./UntrustedDataMembersOnMfaVoiceChallenge)'> +> **untrustedData**: [`UntrustedDataMembersOnMfaVoiceChallenge`](./UntrustedDataMembersOnMfaVoiceChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:53 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:69 + +Submits the voice verification code to validate the MFA challenge. + +**Parameters** + +**payload** + +[`MfaVoiceChallengeContinueOptions`](./MfaVoiceChallengeContinueOptions) + +Object containing the verification code and optional parameters + +**Returns** + +`Promise`\<`void`\> + +Promise that resolves when the code is successfully validated + +**Example** + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.continue({ + code: '123456', + rememberDevice: true +}); +``` + +</ParamField> + +<ParamField body='pickPhone()' type='unknown'> +> **pickPhone**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:82 + +Navigates to the screen for selecting a different phone number. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom parameters + +**Returns** + +`Promise`\<`void`\> + +Promise that resolves when navigation is complete + +**Example** + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.pickPhone(); +``` + +</ParamField> + +<ParamField body='switchToSms()' type='unknown'> +> **switchToSms**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:95 + +Switches to SMS verification method instead of voice call. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom parameters + +**Returns** + +`Promise`\<`void`\> + +Promise that resolves when switching is complete + +**Example** + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.switchToSms(); +``` + +</ParamField> + +<ParamField body='resendCode()' type='unknown'> +> **resendCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:108 + +Requests a new voice call with a verification code. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom parameters + +**Returns** + +`Promise`\<`void`\> + +Promise that resolves when the new code is sent + +**Example** + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.resendCode(); +``` + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:121 + +Navigates to the screen for selecting an alternative MFA method. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom parameters + +**Returns** + +`Promise`\<`void`\> + +Promise that resolves when navigation is complete + +**Example** + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.tryAnotherMethod(); +``` + +</ParamField> + +<ParamField body='resendManager()' type='unknown'> +> **resendManager**(`options?`): [`ResendControl`](./ResendControl) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:126 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](./StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](./ResendControl) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions.mdx new file mode 100644 index 000000000..cc399e2a5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "MfaVoiceEnrollmentContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:11 + +Payload for continuing the MFA Voice Enrollment flow. + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='phone' type='string'> +> **phone**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:12 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers.mdx new file mode 100644 index 000000000..4dc3cfb45 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers.mdx @@ -0,0 +1,181 @@ +--- +title: "MfaVoiceEnrollmentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:17 + +Interface describing the members of the Mfa Voice Enrollment screen. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:18 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:19 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:20 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:21 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:22 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:28 + +Continues with the voice enrollment process. + +**Parameters** + +**payload** + +[`MfaVoiceEnrollmentContinueOptions`](./MfaVoiceEnrollmentContinueOptions) + +The phone number and optional custom options. + +**Returns** + +`Promise`\<`void`\> + +Promise that resolves when enrollment continues. + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:34 + +Allows trying another authentication method. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options. + +**Returns** + +`Promise`\<`void`\> + +Promise that resolves when the user switches method. + +</ParamField> + +<ParamField body='selectPhoneCountryCode()' type='unknown'> +> **selectPhoneCountryCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:40 + +Allows picking a country code for the phone number. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options. + +**Returns** + +`Promise`\<`void`\> + +Promise that resolves when the country code is selected. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx new file mode 100644 index 000000000..d898ed637 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "MfaWebAuthnChangeKeyNicknameContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-change-key-nickname.d.ts:41 + +ContinueOptions + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='nickname' type='string'> +> **nickname**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-change-key-nickname.d.ts:50 + +The new nickname for the WebAuthn security key. + This is the value entered by the user in the input field. + It must adhere to length and character constraints defined by the server. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx new file mode 100644 index 000000000..8b0912154 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx @@ -0,0 +1,178 @@ +--- +title: "MfaWebAuthnChangeKeyNicknameMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-change-key-nickname.d.ts:67 + +MfaWebAuthnChangeKeyNicknameMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaWebAuthnChangeKeyNickname](./ScreenMembersOnMfaWebAuthnChangeKeyNickname)'> +> **screen**: [`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](./ScreenMembersOnMfaWebAuthnChangeKeyNickname) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-change-key-nickname.d.ts:71 + +The screen object with MFA WebAuthn Change Key Nickname specific data structure. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='continueWithNewNickname()' type='unknown'> +> **continueWithNewNickname**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-change-key-nickname.d.ts:115 + +Submits the new nickname for the WebAuthn security key. +This action corresponds to the user entering a new nickname and clicking a "Save" or "Continue" button. +The SDK will POST this new nickname to the Auth0 `/u/mfa-webauthn-change-key-nickname` endpoint. + +If the new nickname is valid and the update is successful, Auth0 will typically redirect the user +to the next appropriate screen (e.g., back to MFA factor management or a success confirmation). +If the nickname is invalid (e.g., empty, too long, too short), Auth0 will re-render the +'mfa-webauthn-change-key-nickname' screen, and the `transaction.errors` array in the SDK's +context will be updated with details about the validation failure. + +**Parameters** + +**payload** + +[`MfaWebAuthnChangeKeyNicknameContinueOptions`](./MfaWebAuthnChangeKeyNicknameContinueOptions) + +An object containing the `nickname` (string) entered by the user. + It can also include any `CustomOptions` for extensibility. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the form submission is initiated. + It does not return data directly upon resolution, as a redirect or + page re-render is the common outcome. + +**Throws** + +Throws an error if `payload.nickname` is not provided or is not a string, + or if the `FormHandler` encounters an unrecoverable issue during submission (e.g., network error). + Validation errors from Auth0 (like an invalid nickname) are not thrown as JavaScript errors + but are reflected in `this.transaction.errors` after the operation. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnChangeKeyNickname +const newNickname = "My Favorite YubiKey"; // Value from user input +try { + await sdk.continueWithNewNickname({ nickname: newNickname }); + // If successful, page redirects. +} catch (error) { + // This catch is for unexpected errors during the SDK call itself. + console.error("Failed to submit the new nickname:", error); +} +// After the await, always check sdk.transaction.errors for server-side validation issues. +if (sdk.transaction.errors && sdk.transaction.errors.length > 0) { + sdk.transaction.errors.forEach(err => { + if (err.field === 'nickname') { + // Display err.message related to the nickname input field. + // e.g., "Name is too short", "Name is required" + } + }); +} +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx new file mode 100644 index 000000000..f1d85d2a9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx @@ -0,0 +1,158 @@ +--- +title: "MfaWebAuthnEnrollmentSuccessMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-enrollment-success.d.ts:53 + +MfaWebAuthnEnrollmentSuccessMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaWebAuthnEnrollmentSuccess](./ScreenMembersOnMfaWebAuthnEnrollmentSuccess)'> +> **screen**: [`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](./ScreenMembersOnMfaWebAuthnEnrollmentSuccess) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-enrollment-success.d.ts:59 + +Access to the specific properties and data of the 'mfa-webauthn-enrollment-success' screen. +Includes the `nickname` of the enrolled authenticator and its `webauthnType`. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-enrollment-success.d.ts:82 + +Allows the user to continue the authentication flow after successful WebAuthn enrollment. +This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` endpoint with `action: "default"`. + +**Parameters** + +**payload?** + +[`WebAuthnEnrollSuccessContinueOptions`](./WebAuthnEnrollSuccessContinueOptions) + +Optional. An object for `CustomOptions` if any + additional parameters need to be sent with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the continue action is successfully submitted. + On success, the browser will typically be redirected to the next step in the flow. + +**Throws** + +Throws an error if the form submission fails (e.g., network issue, invalid state). + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnEnrollmentSuccess +try { + await sdk.continue(); + // User is redirected to the next step. +} catch (error) { + console.error("Failed to continue after WebAuthn enrollment:", error); + // Handle error, potentially by inspecting sdk.transaction.errors if the page re-renders with an error. +} +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers.mdx new file mode 100644 index 000000000..b7829e04e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers.mdx @@ -0,0 +1,254 @@ +--- +title: "MfaWebAuthnErrorMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-error.d.ts:43 + +MfaWebAuthnErrorMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaWebAuthnError](./ScreenMembersOnMfaWebAuthnError)'> +> **screen**: [`ScreenMembersOnMfaWebAuthnError`](./ScreenMembersOnMfaWebAuthnError) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-error.d.ts:47 + +The screen object with MFA WebAuthn Error specific data structure. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='tryAgain()' type='unknown'> +> **tryAgain**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-error.d.ts:61 + +Allows the user to attempt the previous WebAuthn operation again. +This typically redirects the user back to the screen where the WebAuthn operation was initiated. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted. + +**Throws** + +Throws an error if the submission fails. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.tryAgain(); +``` + +</ParamField> + +<ParamField body='usePassword()' type='unknown'> +> **usePassword**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-error.d.ts:75 + +Allows the user to opt for password-based authentication as an alternative, if configured. +This is typically available if the primary authentication or a previous step involved a password. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted. + +**Throws** + +Throws an error if the submission fails. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.usePassword(); +``` + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-error.d.ts:89 + +Allows the user to select a different MFA method if other factors are enrolled or available. +This navigates the user to an authenticator selection screen. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted. + +**Throws** + +Throws an error if the submission fails. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.tryAnotherMethod(); +``` + +</ParamField> + +<ParamField body='noThanks()' type='unknown'> +> **noThanks**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-error.d.ts:103 + +Allows the user to refuse adding a device or completing the WebAuthn step, effectively declining the current WebAuthn flow. +This action is typically used in enrollment scenarios where the user decides not to proceed. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted. + +**Throws** + +Throws an error if the submission fails. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.noThanks(); +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx new file mode 100644 index 000000000..d2516981b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx @@ -0,0 +1,154 @@ +--- +title: "MfaWebAuthnNotAvailableErrorMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-not-available-error.d.ts:13 + +MfaWebAuthnNotAvailableErrorMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +**Methods** +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-not-available-error.d.ts:34 + +Allows the user to select a different MFA method because WebAuthn is not available. +This action navigates the user to an authenticator selection screen where they can choose +from other available/enrolled MFA factors. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom parameters to be sent with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves upon successful submission of the 'pick-authenticator' action. + +**Throws** + +Throws an error if the form submission fails (e.g., network issues, server-side validation errors). + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnNotAvailableError +try { + await sdk.tryAnotherMethod(); + // On success, Auth0 handles redirection to the authenticator selection screen. +} catch (error) { + console.error('Failed to switch to another MFA method:', error); + // Potentially update UI to inform the user of the failure. +} +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx new file mode 100644 index 000000000..e9f7f4570 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx @@ -0,0 +1,256 @@ +--- +title: "MfaWebAuthnPlatformChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:75 + +MfaWebAuthnPlatformChallengeMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaWebAuthnPlatformChallenge](./ScreenMembersOnMfaWebAuthnPlatformChallenge)'> +> **screen**: [`ScreenMembersOnMfaWebAuthnPlatformChallenge`](./ScreenMembersOnMfaWebAuthnPlatformChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:80 + +Screen-specific properties and data, including WebAuthn challenge options and remember device preference. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='verify()' type='unknown'> +> **verify**(`options?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:115 + +Initiates the WebAuthn platform authenticator challenge. +This method internally calls `navigator.credentials.get()` using the challenge options +provided in `screen.publicKey`. +If successful, it submits the resulting credential to Auth0 with `action: "default"`. + +If `navigator.credentials.get()` fails (e.g., user cancellation, timeout, or other WebAuthn API errors), +it's recommended to call `reportBrowserError` with the error details. + +**Parameters** + +**options?** + +[`VerifyPlatformAuthenticatorOptions`](./VerifyPlatformAuthenticatorOptions) + +Optional parameters for the verification process, +such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the verification attempt is submitted. + A successful operation typically results in a redirect. + +**Throws** + +Throws an error if `screen.publicKey` is missing, + if `navigator.credentials.get()` fails with an unexpected error not handled by `getPasskeyCredentials`, + or if the form submission to Auth0 fails. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformChallenge +try { + const remember = sdk.screen.showRememberDevice && userCheckedRememberDeviceBox; + await sdk.verify({ rememberDevice: remember }); + // On success, Auth0 handles redirection. +} catch (error) { + console.error("Platform authenticator verification failed:", error); + // If it's a WebAuthn API error, report it + if (error.name && error.message) { // Basic check for DOMException like error + await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + } + // Check sdk.transaction.errors for server-side validation messages if the page reloads. +} +``` + +</ParamField> + +<ParamField body='reportBrowserError()' type='unknown'> +> **reportBrowserError**(`options`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:141 + +Reports a specific WebAuthn API error (from `navigator.credentials.get()`) to Auth0. +This method should be used when `verify()` (or a manual `navigator.credentials.get()` call) fails due to +a browser-side WebAuthn issue (e.g., user cancellation `NotAllowedError`, timeout). +It submits the error details with `action: "showError::{errorDetailsJsonString}"` and an empty `response`. + +**Parameters** + +**options** + +[`MfaWebAuthnPlatformChallengeReportErrorOptions`](./MfaWebAuthnPlatformChallengeReportErrorOptions) + +Contains the `error` object (with `name` and `message` +from the WebAuthn API DOMException) and any other custom options. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the error report is submitted. + +**Throws** + +Throws an error if the form submission fails (e.g., network error, invalid state). + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformChallenge +// And webAuthnDomException is an error object from a failed navigator.credentials.get() call. +try { + await sdk.reportBrowserError({ + error: { name: webAuthnDomException.name, message: webAuthnDomException.message } + }); + // Auth0 will process this error and may re-render the page or redirect. +} catch (submitError) { + console.error("Failed to report WebAuthn browser error:", submitError); +} +``` + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`options?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:162 + +Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. +This action submits `action: "pick-authenticator"` to Auth0, which should navigate +the user to an MFA factor selection screen. + +**Parameters** + +**options?** + +[`MfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](./MfaWebAuthnPlatformChallengeTryAnotherMethodOptions) + +Optional custom parameters to be sent with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the 'pick-authenticator' action is submitted. + +**Throws** + +Throws an error if the form submission fails. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformChallenge +try { + await sdk.tryAnotherMethod(); + // On success, Auth0 handles redirection to MFA selection. +} catch (error) { + console.error("Failed to switch MFA method:", error); +} +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx new file mode 100644 index 000000000..347fb5b09 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx @@ -0,0 +1,17 @@ +--- +title: "MfaWebAuthnPlatformChallengeReportErrorOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:52 + +ReportBrowserErrorOptions + +## Properties + +<ParamField body='error' type='[WebAuthnErrorDetails](./WebAuthnErrorDetails)'> +> **error**: [`WebAuthnErrorDetails`](./WebAuthnErrorDetails) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:58 + +The error object from the WebAuthn API (`navigator.credentials.get()`) to be reported. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..f65802fd8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,15 @@ +--- +title: "MfaWebAuthnPlatformChallengeTryAnotherMethodOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:67 + +TryAnotherMethodOptions + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx new file mode 100644 index 000000000..f125e140f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx @@ -0,0 +1,275 @@ +--- +title: "MfaWebAuthnPlatformEnrollmentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:51 + +MfaWebAuthnPlatformEnrollmentMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaWebAuthnPlatformEnrollment](./ScreenMembersOnMfaWebAuthnPlatformEnrollment)'> +> **screen**: [`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](./ScreenMembersOnMfaWebAuthnPlatformEnrollment) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:55 + +The screen object with MFA WebAuthn Platform Enrollment specific data structure. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='submitPasskeyCredential()' type='unknown'> +> **submitPasskeyCredential**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:84 + +Initiates the WebAuthn platform credential creation process using the public key options +available on `this.screen.publicKey` and submits the resulting credential to the server. +This method internally calls `createPasskeyCredentials` (which wraps `navigator.credentials.create()`). + +**Parameters** + +**payload?** + +[`SubmitPasskeyCredentialOptions`](./SubmitPasskeyCredentialOptions) + +Optional custom parameters to be sent to the server +along with the created credential. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the credential is successfully created and submitted. + +**Throws** + +Throws an error if `this.screen.publicKey` is not available, if `createPasskeyCredentials` fails +(e.g., user cancellation, hardware issues), or if the submission to the server fails. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment +try { + if (!sdk.screen.publicKey) { // Check if options are available + throw new Error("Public key creation options are not available on the screen context."); + } + await sdk.submitPasskeyCredential(); // No need to pass publicKey explicitly + // On success, Auth0 handles redirection. +} catch (error) { + console.error('Passkey enrollment failed:', error); + // Handle error, potentially by calling reportBrowserError if it's a WebAuthn API error + if (error.name && error.message) { // Check if it looks like a WebAuthn error + await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + } +} +``` + +</ParamField> + +<ParamField body='reportBrowserError()' type='unknown'> +> **reportBrowserError**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:104 + +Reports a browser-side error encountered during the WebAuthn `navigator.credentials.create()` operation. +This method sends the error details to the server. + +**Parameters** + +**payload** + +[`ReportBrowserErrorOptions`](./ReportBrowserErrorOptions) + +The browser error details and any custom options. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the error report is successfully submitted. + +**Throws** + +Throws an error if the submission fails. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment +// In the catch block of an attempted passkey creation (e.g. from submitPasskeyCredential): +} catch (webAuthnError) { + if (webAuthnError.name) { // Check if it's likely a WebAuthn API error + await sdk.reportBrowserError({ error: { name: webAuthnError.name, message: webAuthnError.message } }); + } + // Update UI to show error message to the user +} +``` + +</ParamField> + +<ParamField body='snoozeEnrollment()' type='unknown'> +> **snoozeEnrollment**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:118 + +Allows the user to snooze or postpone the WebAuthn platform enrollment. +This action typically means the user will be reminded to enroll at a later time. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the snooze action is successfully submitted. + +**Throws** + +Throws an error if the submission fails. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment +await sdk.snoozeEnrollment(); +``` + +</ParamField> + +<ParamField body='refuseEnrollmentOnThisDevice()' type='unknown'> +> **refuseEnrollmentOnThisDevice**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:132 + +Allows the user to refuse WebAuthn platform enrollment on the current device. +This action indicates the user does not want to use a platform authenticator on this specific device. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the refusal action is successfully submitted. + +**Throws** + +Throws an error if the submission fails. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment +await sdk.refuseEnrollmentOnThisDevice(); +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx new file mode 100644 index 000000000..bcfc0b5ab --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx @@ -0,0 +1,249 @@ +--- +title: "MfaWebAuthnRoamingChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:56 + +MfaWebAuthnRoamingChallengeMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaWebAuthnRoamingChallenge](./ScreenMembersOnMfaWebAuthnRoamingChallenge)'> +> **screen**: [`ScreenMembersOnMfaWebAuthnRoamingChallenge`](./ScreenMembersOnMfaWebAuthnRoamingChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:61 + +Screen-specific properties and data, including WebAuthn challenge options. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='verify()' type='unknown'> +> **verify**(`options?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:89 + +Initiates the WebAuthn challenge by calling `navigator.credentials.get()` with the +options provided in `screen.data.publicKeyChallengeOptions`. +If successful, it submits the resulting credential to Auth0 with `action: "default"`. +If `navigator.credentials.get()` fails with a known WebAuthn API error (like `NotAllowedError`), +this method will internally call `reportWebAuthnError` to inform Auth0. + +**Parameters** + +**options?** + +[`VerifySecurityKeyOptions`](./VerifySecurityKeyOptions) + +Optional parameters for the verification process, +such as `rememberDevice` and other custom options. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the verification attempt is submitted. + It does not directly return data as a successful operation typically results in a redirect. + +**Throws** + +Throws an error if `screen.data.publicKeyChallengeOptions` is missing, + if `navigator.credentials.get()` fails with an unexpected error, + or if the form submission to Auth0 fails. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge +try { + await sdk.verify({ rememberDevice: true }); + // On success, Auth0 handles redirection. +} catch (error) { + console.error("Security key verification failed:", error); + // Check sdk.transaction.errors for server-side validation messages if the page reloads. +} +``` + +</ParamField> + +<ParamField body='reportWebAuthnError()' type='unknown'> +> **reportWebAuthnError**(`options`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:115 + +Reports a specific WebAuthn API error to Auth0. +This method should be used if `navigator.credentials.get()` fails in a way that +`verify()` doesn't automatically handle, or if the developer wants to explicitly +report an error before trying another action. +It submits the error details with `action: "showError::{errorDetails}"`. + +**Parameters** + +**options** + +[`MfaWebAuthnRoamingChallengeReportErrorOptions`](./MfaWebAuthnRoamingChallengeReportErrorOptions) + +Contains the `error` object with `name` and `message` +from the WebAuthn API, and any other custom options. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the error report is submitted. + +**Throws** + +Throws an error if the form submission fails. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge +// And webAuthnError is an error object from a failed navigator.credentials.get() call. +try { + await sdk.reportWebAuthnError({ + error: { name: webAuthnError.name, message: webAuthnError.message } + }); +} catch (submitError) { + console.error("Failed to report WebAuthn error:", submitError); +} +``` + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`options?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:136 + +Allows the user to opt-out of the WebAuthn challenge and select a different MFA method. +This action submits `action: "pick-authenticator"` to Auth0, which should navigate +the user to an MFA factor selection screen. + +**Parameters** + +**options?** + +[`MfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](./MfaWebAuthnRoamingChallengeTryAnotherMethodOptions) + +Optional custom parameters for the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the action is submitted. + +**Throws** + +Throws an error if the form submission fails. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge +try { + await sdk.tryAnotherMethod(); + // On success, Auth0 handles redirection to MFA selection. +} catch (error) { + console.error("Failed to switch MFA method:", error); +} +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx new file mode 100644 index 000000000..1182954fd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx @@ -0,0 +1,17 @@ +--- +title: "MfaWebAuthnRoamingChallengeReportErrorOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:39 + +ReportWebAuthnErrorOptions + +## Properties + +<ParamField body='error' type='[WebAuthnErrorDetails](./WebAuthnErrorDetails)'> +> **error**: [`WebAuthnErrorDetails`](./WebAuthnErrorDetails) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:40 + +The error object from the WebAuthn API to be reported. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..72dd5b27e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,15 @@ +--- +title: "MfaWebAuthnRoamingChallengeTryAnotherMethodOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:48 + +TryAnotherMethodOptions + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx new file mode 100644 index 000000000..a63892587 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx @@ -0,0 +1,226 @@ +--- +title: "MfaWebAuthnRoamingEnrollmentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:36 + +Interface defining the available methods and properties for the mfa-webauthn-roaming-enrollment screen. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnMfaWebAuthnRoamingEnrollment](./ScreenMembersOnMfaWebAuthnRoamingEnrollment)'> +> **screen**: [`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](./ScreenMembersOnMfaWebAuthnRoamingEnrollment) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:37 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='enroll()' type='unknown'> +> **enroll**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:60 + +Initiates the WebAuthn credential creation and submits the result to the server. +This corresponds to the user interacting with the FIDO Security Keys prompt. + +**Parameters** + +**payload** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +**Example** + +```typescript +import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + +const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); +try { + // This will trigger the browser's WebAuthn prompt + const credential = await navigator.credentials.create({ publicKey: webauthnEnrollment.screen.data.passkey.public_key }); + // You would typically serialize the credential response here + const response = JSON.stringify(credential); + await webauthnEnrollment.enroll({ response }); +} catch (error) { + console.error('WebAuthn enrollment failed:', error); + // Handle the error, e.g., show an error message to the user or submit the error details + // await webauthnEnrollment.showError({ error: { name: error.name, message: error.message } }); +} +``` + +</ParamField> + +<ParamField body='showError()' type='unknown'> +> **showError**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:84 + +Submits details about a WebAuthn browser error to the server. +This is used when the browser's WebAuthn API encounters an error. + +**Parameters** + +**payload** + +[`ShowErrorOptions`](./ShowErrorOptions) + +The options containing the error details. + +**Returns** + +`Promise`\<`void`\> + +**Example** + +```typescript +import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + +const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); +// Example error handler for the browser's WebAuthn API call +const handleError = async (error: any) => { + console.error('WebAuthn error:', error); + await webauthnEnrollment.showError({ + error: { + name: error.name, + message: error.message, + // Include other relevant error properties if available + }, + }); +}; +// ... use handleError in your WebAuthn API call's catch block +``` + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:97 + +Allows the user to try another MFA method. +This corresponds to the "Try Another Method" button. + +**Parameters** + +**payload?** + +[`MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions`](./MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +**Example** + +```typescript +import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + +const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); +await webauthnEnrollment.tryAnotherMethod(); +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..96b95f220 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx @@ -0,0 +1,13 @@ +--- +title: "MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:27 + +Options for trying another MFA method. + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options. \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers.mdx new file mode 100644 index 000000000..a15dcd6b0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers.mdx @@ -0,0 +1,48 @@ +--- +title: "OrganizationMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:24 + +## Properties + +<ParamField body='id' type='string '> +> **id**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:25 + +</ParamField> + +<ParamField body='name' type='string '> +> **name**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:26 + +</ParamField> + +<ParamField body='usage' type='string '> +> **usage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:27 + +</ParamField> + +<ParamField body='displayName' type='string '> +> **displayName**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:28 + +</ParamField> + +<ParamField body='branding' type='[Branding](./Branding) '> +> **branding**: [`Branding`](./Branding) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:29 + +</ParamField> + +<ParamField body='metadata' type='{[key: string]: string; } '> +> **metadata**: \{\[`key`: `string`\]: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:30 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers.mdx new file mode 100644 index 000000000..b5450e5a1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers.mdx @@ -0,0 +1,160 @@ +--- +title: "OrganizationPickerMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-picker.d.ts:10 + +Interface defining the available methods and properties for the organization-picker screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +**Methods** +</ParamField> + +<ParamField body='selectOrganization()' type='unknown'> +> **selectOrganization**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-picker.d.ts:15 + +Selects an organization for the user. + +**Parameters** + +**payload** + +The options containing the organization ID. + +**organization** + +`string` + +**state** + +`string` + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='skipOrganizationSelection()' type='unknown'> +> **skipOrganizationSelection**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-picker.d.ts:23 + +Skips the organization selection, proceeding with the user's personal account. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers.mdx new file mode 100644 index 000000000..d2b3ae2b7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers.mdx @@ -0,0 +1,135 @@ +--- +title: "OrganizationSelectionMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:35 + +Interface defining the available methods and properties for the organization-selection screen. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnOrganizationSelection](./ScreenMembersOnOrganizationSelection)'> +> **screen**: [`ScreenMembersOnOrganizationSelection`](./ScreenMembersOnOrganizationSelection) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:39 + +The screen properties. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='continueWithOrganizationName()' type='unknown'> +> **continueWithOrganizationName**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:44 + +Continues with the selected organization name. + +**Parameters** + +**payload** + +[`ContinueWithOrganizationNameOptions`](./ContinueWithOrganizationNameOptions) + +The options containing the organization name. + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations.mdx new file mode 100644 index 000000000..737d068ec --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations.mdx @@ -0,0 +1,34 @@ +--- +title: "Organizations" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:28 + +## Properties + +<ParamField body='organizationId' type='string '> +> **organizationId**: `string` \| `undefined` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:29 + +</ParamField> + +<ParamField body='organizationName' type='string '> +> **organizationName**: `string` \| `undefined` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:30 + +</ParamField> + +<ParamField body='displayName' type='string '> +> **displayName**: `string` \| `undefined` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:31 + +</ParamField> + +<ParamField body='branding' type='[Branding](./Branding)'> +> **branding**: [`Branding`](./Branding) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:32 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions.mdx new file mode 100644 index 000000000..884df05ed --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "OtpCodeOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-otp-challenge.d.ts:11 + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-otp-challenge.d.ts:15 + +The OTP code that the user enters to submit. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate.mdx new file mode 100644 index 000000000..6ff0639a6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate.mdx @@ -0,0 +1,65 @@ +--- +title: "PasskeyCreate" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:19 + +## Properties + +<ParamField body='public\_key' type='object'> +> **public\_key**: `object` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:20 + +**user** + +> **user**: `object` + +**user.id** + +> **id**: `string` + +**user.name** + +> **name**: `string` + +**user.displayName** + +> **displayName**: `string` + +**rp** + +> **rp**: `object` + +**rp.id** + +> **id**: `string` + +**rp.name** + +> **name**: `string` + +**challenge** + +> **challenge**: `string` + +**pubKeyCredParams** + +> **pubKeyCredParams**: \[\{ `type`: `string`; `alg`: `number`; \}\] + +**authenticatorSelection** + +> **authenticatorSelection**: `object` + +**authenticatorSelection.residentKey** + +> **residentKey**: `string` + +**authenticatorSelection.userVerification** + +> **userVerification**: `string` + +**authenticatorSelection.authenticatorAttachment?** + +> `optional` **authenticatorAttachment**: `string` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse.mdx new file mode 100644 index 000000000..8356973c6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse.mdx @@ -0,0 +1,41 @@ +--- +title: "PasskeyCreateResponse" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:19 + +## Properties + +<ParamField body='id' type='string'> +> **id**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:20 + +</ParamField> + +<ParamField body='rawId' type='string '> +> **rawId**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:21 + +</ParamField> + +<ParamField body='type' type='string'> +> **type**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:22 + +</ParamField> + +<ParamField body='authenticatorAttachment' type='string '> +> **authenticatorAttachment**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:23 + +</ParamField> + +<ParamField body='response' type='[CredentialResponse](./CredentialResponse)'> +> **response**: [`CredentialResponse`](./CredentialResponse) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:24 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers.mdx new file mode 100644 index 000000000..9ed4fe200 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers.mdx @@ -0,0 +1,144 @@ +--- +title: "PasskeyEnrollmentLocalMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment-local.d.ts:22 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnPasskeyEnrollmentLocal](./ScreenMembersOnPasskeyEnrollmentLocal)'> +> **screen**: [`ScreenMembersOnPasskeyEnrollmentLocal`](./ScreenMembersOnPasskeyEnrollmentLocal) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment-local.d.ts:23 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='continuePasskeyEnrollment()' type='unknown'> +> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment-local.d.ts:24 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='abortPasskeyEnrollment()' type='unknown'> +> **abortPasskeyEnrollment**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment-local.d.ts:25 + +**Parameters** + +**payload** + +[`AbortEnrollmentOptions`](./AbortEnrollmentOptions) + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers.mdx new file mode 100644 index 000000000..e99fbc12e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers.mdx @@ -0,0 +1,144 @@ +--- +title: "PasskeyEnrollmentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:20 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnPasskeyEnrollment](./ScreenMembersOnPasskeyEnrollment)'> +> **screen**: [`ScreenMembersOnPasskeyEnrollment`](./ScreenMembersOnPasskeyEnrollment) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:21 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='continuePasskeyEnrollment()' type='unknown'> +> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:22 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='abortPasskeyEnrollment()' type='unknown'> +> **abortPasskeyEnrollment**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:23 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule.mdx new file mode 100644 index 000000000..c62bbc38d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule.mdx @@ -0,0 +1,60 @@ +--- +title: "PasswordComplexityRule" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:125 + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:126 + +</ParamField> + +<ParamField body='label' type='string'> +> **label**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:127 + +</ParamField> + +<ParamField body='status' type='"valid" '> +> **status**: `"valid"` \| `"error"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:128 + +</ParamField> + +<ParamField body='isValid' type='boolean'> +> **isValid**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:129 + +</ParamField> + +<ParamField body='args?' type='object'> +> `optional` **args**: `object` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:130 + +**count** + +> **count**: `number` + +**total?** + +> `optional` **total**: `number` + +**example?** + +> `optional` **example**: `string` + +</ParamField> + +<ParamField body='items?' type='PasswordComplexityRule[]'> +> `optional` **items**: `PasswordComplexityRule`[] + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:135 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy.mdx new file mode 100644 index 000000000..3c1681902 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy.mdx @@ -0,0 +1,34 @@ +--- +title: "PasswordPolicy" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:51 + +## Properties + +<ParamField body='enabled?' type='boolean'> +> `optional` **enabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:52 + +</ParamField> + +<ParamField body='minLength?' type='number'> +> `optional` **minLength**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:53 + +</ParamField> + +<ParamField body='policy' type='"none" '> +> **policy**: `"none"` \| `"low"` \| `"fair"` \| `"good"` \| `"excellent"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:54 + +</ParamField> + +<ParamField body='passwordSecurityInfo?' type='[PasswordComplexityRule](./PasswordComplexityRule)[]'> +> `optional` **passwordSecurityInfo**: [`PasswordComplexityRule`](./PasswordComplexityRule)[] + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:55 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult.mdx new file mode 100644 index 000000000..d5e7e8375 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult.mdx @@ -0,0 +1,30 @@ +--- +title: "PasswordValidationResult" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/validate-password.d.ts:2 + +## Properties + +<ParamField body='isValid' type='boolean'> +> **isValid**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/validate-password.d.ts:8 + +Overall outcome of all password policy checks. + +`true` only if every rule in [PasswordComplexityRule](./PasswordComplexityRule) has `status` equal to `"valid"`. + +</ParamField> + +<ParamField body='results' type='[PasswordComplexityRule](./PasswordComplexityRule)[]'> +> **results**: [`PasswordComplexityRule`](./PasswordComplexityRule)[] + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/validate-password.d.ts:16 + +Array of evaluated password rules. + +Each item is a [PasswordComplexityRule](./PasswordComplexityRule) whose +[status](./PasswordComplexityRule.md#status) field reflects the +computed validation result for that rule. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneChallengeOptions.mdx new file mode 100644 index 000000000..273785129 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneChallengeOptions.mdx @@ -0,0 +1,24 @@ +--- +title: "PhoneChallengeOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:5 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:6 + +</ParamField> + +<ParamField body='captcha?' type='string'> +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:7 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions.mdx new file mode 100644 index 000000000..b1cac9b29 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions.mdx @@ -0,0 +1,17 @@ +--- +title: "PhoneEnrollmentOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:15 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + +<ParamField body='type' type='"text" '> +> **type**: `"text"` \| `"voice"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:16 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers.mdx new file mode 100644 index 000000000..3dcc04829 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers.mdx @@ -0,0 +1,212 @@ +--- +title: "PhoneIdentifierChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:31 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnPhoneIdentifierChallenge](./ScreenMembersOnPhoneIdentifierChallenge)'> +> **screen**: [`ScreenMembersOnPhoneIdentifierChallenge`](./ScreenMembersOnPhoneIdentifierChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:32 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='submitPhoneChallenge()' type='unknown'> +> **submitPhoneChallenge**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:33 + +**Parameters** + +**payload** + +[`PhoneChallengeOptions`](./PhoneChallengeOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendCode()' type='unknown'> +> **resendCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:34 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager()' type='unknown'> +> **resendManager**(`options?`): [`ResendControl`](./ResendControl) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:35 + +**Parameters** + +**options?** + +[`StartResendOptions`](./StartResendOptions) + +**Returns** + +[`ResendControl`](./ResendControl) + +</ParamField> + +<ParamField body='returnToPrevious()' type='unknown'> +> **returnToPrevious**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:36 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='switchToVoice()' type='unknown'> +> **switchToVoice**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:37 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='switchToText()' type='unknown'> +> **switchToText**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:38 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers.mdx new file mode 100644 index 000000000..11563d505 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers.mdx @@ -0,0 +1,144 @@ +--- +title: "PhoneIdentifierEnrollmentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:19 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnPhoneIdentifierEnrollment](./ScreenMembersOnPhoneIdentifierEnrollment)'> +> **screen**: [`ScreenMembersOnPhoneIdentifierEnrollment`](./ScreenMembersOnPhoneIdentifierEnrollment) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:20 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='continuePhoneEnrollment()' type='unknown'> +> **continuePhoneEnrollment**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:21 + +**Parameters** + +**payload** + +[`PhoneEnrollmentOptions`](./PhoneEnrollmentOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='returnToPrevious()' type='unknown'> +> **returnToPrevious**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:22 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix.mdx new file mode 100644 index 000000000..c5493db72 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix.mdx @@ -0,0 +1,33 @@ +--- +title: "PhonePrefix" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:44 + +## Properties + +<ParamField body='country' type='string'> +> **country**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:46 + +The country name + +</ParamField> + +<ParamField body='country\_code' type='string'> +> **country\_code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:48 + +The country code (e.g. 'US', 'GB') + +</ParamField> + +<ParamField body='phone\_prefix' type='string'> +> **phone\_prefix**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:50 + +The phone prefix (e.g. '+1', '+44') +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers.mdx new file mode 100644 index 000000000..fecc79b2e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers.mdx @@ -0,0 +1,13 @@ +--- +title: "PromptMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/prompt.d.ts:4 + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/prompt.d.ts:5 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers.mdx new file mode 100644 index 000000000..983ca728f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers.mdx @@ -0,0 +1,148 @@ +--- +title: "RedeemTicketMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/redeem-ticket.d.ts:11 + +Interface describing the data available on the Redeem Ticket screen. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/redeem-ticket.d.ts:12 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/redeem-ticket.d.ts:13 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/redeem-ticket.d.ts:14 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/redeem-ticket.d.ts:15 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/redeem-ticket.d.ts:16 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/redeem-ticket.d.ts:30 + +Performs the default action on the redeem-ticket screen, which usually involves continuing the flow. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the action is complete. + +**Throws** + +If the operation fails. + +**Example** + +```typescript +import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; + +const redeemTicket = new RedeemTicket(); +await redeemTicket.continue(); +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions.mdx new file mode 100644 index 000000000..f95add17d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "ReportBrowserErrorOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:34 + +ReportBrowserErrorOptions + +## Properties + +<ParamField body='error' type='object'> +> **error**: `object` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:40 + +**name** + +> **name**: `string` + +**message** + +> **message**: `string` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptions.mdx new file mode 100644 index 000000000..685eee75f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptions.mdx @@ -0,0 +1,13 @@ +--- +title: "ResendCodeOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:26 + +Options for resending the email code. + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload.mdx new file mode 100644 index 000000000..adf5c44d9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload.mdx @@ -0,0 +1,18 @@ +--- +title: "ResendCodeOptionsPayload" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-email-verification.d.ts:28 + +ResendCodeOptions +description Options for the `resendCode` method on the Login Email Verification screen. +This operation is used when the user requests a new verification code to be sent to their email, +for instance, if they did not receive the initial code or if it has expired. + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodePayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodePayloadOptions.mdx new file mode 100644 index 000000000..e40113358 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodePayloadOptions.mdx @@ -0,0 +1,13 @@ +--- +title: "ResendCodePayloadOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:37 + +Options for resending the email code + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl.mdx new file mode 100644 index 000000000..7ad05cd8f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl.mdx @@ -0,0 +1,19 @@ +--- +title: "ResendControl" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/resend-control.d.ts:18 + +Control object returned by resendManager method + +## Properties + +<ParamField body='startResend()' type='() => void'> +> **startResend**: () => `void` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/resend-control.d.ts:19 + +**Returns** + +`void` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers.mdx new file mode 100644 index 000000000..e7eb76db3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers.mdx @@ -0,0 +1,127 @@ +--- +title: "ResetPasswordEmailMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-email.d.ts:15 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnResetPasswordEmail](./ScreenMembersOnResetPasswordEmail)'> +> **screen**: [`ScreenMembersOnResetPasswordEmail`](./ScreenMembersOnResetPasswordEmail) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-email.d.ts:16 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='resendEmail()' type='unknown'> +> **resendEmail**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-email.d.ts:17 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailOptions.mdx new file mode 100644 index 000000000..4b09bd5b5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailOptions.mdx @@ -0,0 +1,9 @@ +--- +title: "ResetPasswordEmailOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-email.d.ts:4 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers.mdx new file mode 100644 index 000000000..e3f65ea73 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers.mdx @@ -0,0 +1,109 @@ +--- +title: "ResetPasswordErrorMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-error.d.ts:14 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnResetPasswordError](./ScreenMembersOnResetPasswordError)'> +> **screen**: [`ScreenMembersOnResetPasswordError`](./ScreenMembersOnResetPasswordError) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-error.d.ts:15 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers.mdx new file mode 100644 index 000000000..bd4920c6d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers.mdx @@ -0,0 +1,144 @@ +--- +title: "ResetPasswordMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:21 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnResetPassword](./ScreenMembersOnResetPassword)'> +> **screen**: [`ScreenMembersOnResetPassword`](./ScreenMembersOnResetPassword) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:22 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembersOnResetPassword](./TransactionMembersOnResetPassword)'> +> **transaction**: [`TransactionMembersOnResetPassword`](./TransactionMembersOnResetPassword) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:23 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='resetPassword()' type='unknown'> +> **resetPassword**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:24 + +**Parameters** + +**payload** + +[`ResetPasswordOptions`](./ResetPasswordOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='validatePassword()' type='unknown'> +> **validatePassword**(`password`): [`PasswordValidationResult`](./PasswordValidationResult) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:25 + +**Parameters** + +**password** + +`string` + +**Returns** + +[`PasswordValidationResult`](./PasswordValidationResult) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx new file mode 100644 index 000000000..09bb1750c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx @@ -0,0 +1,196 @@ +--- +title: "ResetPasswordMfaEmailChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:40 + +Interface defining the available methods and properties for the reset-password-mfa-email-challenge screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnResetPasswordMfaEmailChallenge](./ScreenMembersOnResetPasswordMfaEmailChallenge)'> +> **screen**: [`ScreenMembersOnResetPasswordMfaEmailChallenge`](./ScreenMembersOnResetPasswordMfaEmailChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:41 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:46 + +Continues with the email challenge using the provided code. + +**Parameters** + +**payload** + +[`ContinueOptions`](./ContinueOptions) + +The options containing the code and rememberDevice flag. + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendCode()' type='unknown'> +> **resendCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:51 + +Resends the email code. + +**Parameters** + +**payload?** + +[`ResendCodeOptions`](./ResendCodeOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:56 + +Allows the user to try another MFA method. + +**Parameters** + +**payload?** + +[`TryAnotherMethodOptions`](./TryAnotherMethodOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager()' type='unknown'> +> **resendManager**(`options?`): [`ResendControl`](./ResendControl) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:61 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](./StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](./ResendControl) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx new file mode 100644 index 000000000..edb6cacc7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "ResetPasswordMfaOtpChallengeContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-otp-challenge.d.ts:5 + +Options for continuing with the OTP challenge. + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-otp-challenge.d.ts:7 + +The code entered by the user. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx new file mode 100644 index 000000000..165a7664a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx @@ -0,0 +1,154 @@ +--- +title: "ResetPasswordMfaOtpChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-otp-challenge.d.ts:21 + +Interface defining the available methods and properties for the reset-password-mfa-otp-challenge screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-otp-challenge.d.ts:26 + +Continues with the OTP challenge using the provided code. + +**Parameters** + +**payload** + +[`ResetPasswordMfaOtpChallengeContinueOptions`](./ResetPasswordMfaOtpChallengeContinueOptions) + +The options containing the code. + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-otp-challenge.d.ts:31 + +Allows the user to try another MFA method. + +**Parameters** + +**payload?** + +[`ResetPasswordMfaOtpChallengeTryAnotherMethodOptions`](./ResetPasswordMfaOtpChallengeTryAnotherMethodOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..b7505af60 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,13 @@ +--- +title: "ResetPasswordMfaOtpChallengeTryAnotherMethodOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-otp-challenge.d.ts:14 + +Options for trying another method. + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx new file mode 100644 index 000000000..8fda6b068 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "ResetPasswordMfaPhoneChallengeContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:30 + +ContinueOptions + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='type' type='"voice" '> +> **type**: `"voice"` \| `"sms"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:37 + +The delivery method selected by the user for receiving the verification code. +- `sms`: Send the code via text message. +- `voice`: Send the code via a voice call. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx new file mode 100644 index 000000000..588aeb9d0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx @@ -0,0 +1,207 @@ +--- +title: "ResetPasswordMfaPhoneChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:63 + +ResetPasswordMfaPhoneChallengeMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:68 + +Access to client-specific information (e.g., client ID, name). + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:73 + +Access to organization-specific information, if applicable. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:78 + +Access to prompt details (e.g., prompt name). + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnResetPasswordMfaPhoneChallenge](./ScreenMembersOnResetPasswordMfaPhoneChallenge)'> +> **screen**: [`ScreenMembersOnResetPasswordMfaPhoneChallenge`](./ScreenMembersOnResetPasswordMfaPhoneChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:83 + +Access to the specific properties and data of the 'reset-password-mfa-phone-challenge' screen. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:88 + +Access to the current transaction details (e.g., state, errors). + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:110 + +Sends the verification code to the user's phone via the specified method (SMS or Voice). +This action corresponds to the user clicking the "Send Code via SMS" or "Send Code via Voice Call" button. +It triggers the Auth0 backend to initiate the code delivery process. + +**Parameters** + +**payload** + +[`ResetPasswordMfaPhoneChallengeContinueOptions`](./ResetPasswordMfaPhoneChallengeContinueOptions) + +The options specifying the delivery type ('sms' or 'voice') and any custom data. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted to the server. + +**Throws** + +Throws an error if the submission fails (e.g., network issue, invalid state). + +**Example** + +```typescript +import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; + +const screen = new ResetPasswordMfaPhoneChallenge(); + +// Send code via SMS +await screen.continue({ type: 'sms' }); + +// Send code via Voice Call +await screen.continue({ type: 'voice' }); +``` + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:131 + +Navigates the user to the screen where they can select an alternative MFA method. +This action corresponds to the user clicking a "Try Another Method" button. + +**Parameters** + +**payload** + +[`ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions`](./ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions) + +The options specifying the current challenge type (`sms` or `voice`) and any custom data. The `type` field is necessary to inform the backend which flow the user is navigating away from. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted to the server. + +**Throws** + +Throws an error if the submission fails. + +**Example** + +```typescript +import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; + +const screen = new ResetPasswordMfaPhoneChallenge(); + +// If the user was presented with SMS option initially: +await screen.tryAnotherMethod({ type: 'sms' }); + +// If the user was presented with Voice option initially: +await screen.tryAnotherMethod({ type: 'voice' }); +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..e0f666e9f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,28 @@ +--- +title: "ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:46 + +TryAnotherMethodOptions + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='type' type='"voice" '> +> **type**: `"voice"` \| `"sms"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:54 + +The delivery method that was initially presented or selected on the current screen. +This is required by the API endpoint to correctly process the 'pick-authenticator' action. +- `sms`: Indicates the current screen was for SMS challenge. +- `voice`: Indicates the current screen was for Voice challenge. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx new file mode 100644 index 000000000..48c32fc97 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx @@ -0,0 +1,217 @@ +--- +title: "ResetPasswordMfaPushChallengePushMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-push-challenge-push.d.ts:17 + +Interface defining the available methods and properties for the reset-password-mfa-push-challenge-push screen + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnResetPasswordMfaPushChallengePush](./ScreenMembersOnResetPasswordMfaPushChallengePush)'> +> **screen**: [`ScreenMembersOnResetPasswordMfaPushChallengePush`](./ScreenMembersOnResetPasswordMfaPushChallengePush) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-push-challenge-push.d.ts:18 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-push-challenge-push.d.ts:23 + +Continues with the push notification challenge + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendPushNotification()' type='unknown'> +> **resendPushNotification**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-push-challenge-push.d.ts:28 + +Resends the push notification + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='enterCodeManually()' type='unknown'> +> **enterCodeManually**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-push-challenge-push.d.ts:33 + +Switches to entering the verification code manually + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-push-challenge-push.d.ts:38 + +Allows trying another authentication method + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pollingManager()' type='unknown'> +> **pollingManager**(`options?`): [`MfaPushPollingControl`](./MfaPushPollingControl) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-push-challenge-push.d.ts:43 + +Allows polling for the push notification challenge to be approved. + +**Parameters** + +**options?** + +[`MfaPollingOptions`](../type-aliases/MfaPollingOptions) + +of type [MfaPollingOptions](../type-aliases/MfaPollingOptions) + +**Returns** + +[`MfaPushPollingControl`](./MfaPushPollingControl) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx new file mode 100644 index 000000000..299fb00c5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx @@ -0,0 +1,160 @@ +--- +title: "ResetPasswordMfaRecoveryCodeChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-recovery-code-challenge.d.ts:11 + +Interface describing the members of the Mfa Recovery Code Challenge screen. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-recovery-code-challenge.d.ts:12 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-recovery-code-challenge.d.ts:13 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-recovery-code-challenge.d.ts:14 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-recovery-code-challenge.d.ts:15 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-recovery-code-challenge.d.ts:16 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`code`, `payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-recovery-code-challenge.d.ts:23 + +Continues with the provided recovery code. + +**Parameters** + +**code** + +`string` + +The recovery code entered by the user. + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional payload. + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-recovery-code-challenge.d.ts:29 + +Navigates to the screen where the user can pick another MFA method. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional payload. + +**Returns** + +`Promise`\<`void`\> +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx new file mode 100644 index 000000000..fe84992ba --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx @@ -0,0 +1,199 @@ +--- +title: "ResetPasswordMfaSmsChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:18 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnResetPasswordMfaSmsChallenge](./ScreenMembersOnResetPasswordMfaSmsChallenge)'> +> **screen**: [`ScreenMembersOnResetPasswordMfaSmsChallenge`](./ScreenMembersOnResetPasswordMfaSmsChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:19 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='continueMfaSmsChallenge()' type='unknown'> +> **continueMfaSmsChallenge**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:20 + +**Parameters** + +**payload** + +[`ResetPasswordMfaSmsChallengeOptions`](./ResetPasswordMfaSmsChallengeOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendCode()' type='unknown'> +> **resendCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:21 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:22 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='getACall()' type='unknown'> +> **getACall**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:23 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager()' type='unknown'> +> **resendManager**(`options?`): [`ResendControl`](./ResendControl) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:28 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](./StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](./ResendControl) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx new file mode 100644 index 000000000..11b386881 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx @@ -0,0 +1,17 @@ +--- +title: "ResetPasswordMfaSmsChallengeOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:5 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:6 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx new file mode 100644 index 000000000..ca7a48829 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx @@ -0,0 +1,25 @@ +--- +title: "ResetPasswordMfaVoiceChallengeContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-voice-challenge.d.ts:23 + +Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers. + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-voice-challenge.d.ts:27 + +The OTP code entered by the user. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx new file mode 100644 index 000000000..b545dc105 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx @@ -0,0 +1,232 @@ +--- +title: "ResetPasswordMfaVoiceChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-voice-challenge.d.ts:32 + +Interface defining the available methods and properties for the reset-password-mfa-voice-challenge screen. + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnResetPasswordMfaVoiceChallenge](./ScreenMembersOnResetPasswordMfaVoiceChallenge)'> +> **screen**: [`ScreenMembersOnResetPasswordMfaVoiceChallenge`](./ScreenMembersOnResetPasswordMfaVoiceChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-voice-challenge.d.ts:33 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='continue()' type='unknown'> +> **continue**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-voice-challenge.d.ts:46 + +Continues with the voice challenge using the provided code. + +**Parameters** + +**payload** + +[`ResetPasswordMfaVoiceChallengeContinueOptions`](./ResetPasswordMfaVoiceChallengeContinueOptions) + +The options containing the code. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the challenge is submitted. + +**Example** + +```ts +const reset = new ResetPasswordMfaVoiceChallenge(); +await reset.continue({ code: '123456' }); +``` + +</ParamField> + +<ParamField body='switchToSms()' type='unknown'> +> **switchToSms**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-voice-challenge.d.ts:53 + +Switches to SMS verification. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the action completes. + +</ParamField> + +<ParamField body='resendCode()' type='unknown'> +> **resendCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-voice-challenge.d.ts:60 + +Re-sends the code via voice call. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the code is resent. + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-voice-challenge.d.ts:67 + +Allows the user to try another MFA method. + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the request is submitted. + +</ParamField> + +<ParamField body='resendManager()' type='unknown'> +> **resendManager**(`options?`): [`ResendControl`](./ResendControl) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-voice-challenge.d.ts:72 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](./StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](./ResendControl) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx new file mode 100644 index 000000000..7f17085a2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:54 + +ContinueWithPasskeyOptions + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='rememberDevice?' type='boolean'> +> `optional` **rememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:60 + +Optional. If `true` and `screen.showRememberDevice` is also `true`, + this indicates the user has opted to remember the current browser, + potentially skipping MFA for a period. Corresponds to the `rememberBrowser` form field. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx new file mode 100644 index 000000000..8ece057a9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx @@ -0,0 +1,253 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:106 + +ResetPasswordMfaWebAuthnPlatformChallengeMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge](./ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge)'> +> **screen**: [`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](./ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:111 + +Access to the specific properties and data of the 'reset-password-mfa-webauthn-platform-challenge' screen. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='continueWithPasskey()' type='unknown'> +> **continueWithPasskey**(`options?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:144 + +Initiates the WebAuthn platform authenticator challenge by calling `navigator.credentials.get()` +using the challenge options provided in `screen.publicKey`. +If successful, it submits the resulting credential assertion to Auth0 with `action: "default"`. + +**Parameters** + +**options?** + +[`ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions`](./ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions) + +Optional parameters for the verification process, +such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the verification attempt is submitted. + A successful operation typically results in a redirect. + +**Throws** + +Throws an error if `screen.publicKey` is missing, + if `navigator.credentials.get()` fails (e.g., user cancellation `NotAllowedError`), + or if the form submission to Auth0 fails. If `navigator.credentials.get()` fails + with a `DOMException`, it's recommended to catch that error and call `reportBrowserError`. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge +try { + await sdk.continueWithPasskey({ + rememberDevice: true // if user checked the box and sdk.screen.showRememberDevice is true + }); + // On success, Auth0 handles redirection. +} catch (error) { + console.error("Platform authenticator verification failed:", error); + // If it's a WebAuthn API error (DOMException), report it + if (error instanceof DOMException && error.name && error.message) { + await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + } + // Check sdk.transaction.errors for server-side validation messages if the page reloads. +} +``` + +</ParamField> + +<ParamField body='reportBrowserError()' type='unknown'> +> **reportBrowserError**(`options`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:169 + +Reports a browser-side error that occurred during the `navigator.credentials.get()` API call. +This is used to inform Auth0 about issues like user cancellation, timeout, or unsupported hardware. +It submits the error details with `action: "showError::{errorDetailsJsonString}"`. + +**Parameters** + +**options** + +[`ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions`](./ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions) + +Contains the `error` object (with `name` and `message` + from the WebAuthn API DOMException) and any custom options. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the error report is submitted. + +**Throws** + +If the form submission fails (e.g., network error). + +**Example** + +```typescript +// Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge +// and 'webAuthnError' is a DOMException from a failed navigator.credentials.get() call. +try { + await sdk.reportBrowserError({ + error: { name: webAuthnError.name, message: webAuthnError.message } + }); + // Auth0 may re-render the page or redirect based on the error. +} catch (submitError) { + console.error("Failed to report WebAuthn browser error:", submitError); +} +``` + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`options?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:190 + +Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. +This action submits `action: "pick-authenticator"` to Auth0, which should navigate +the user to an MFA factor selection screen for the password reset flow. + +**Parameters** + +**options?** + +[`ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](./ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions) + +Optional. Any custom parameters to be sent with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the 'pick-authenticator' action is submitted. + +**Throws** + +If the form submission fails. + +**Example** + +```typescript +// Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge +try { + await sdk.tryAnotherMethod(); + // On success, Auth0 handles redirection to MFA selection. +} catch (error) { + console.error("Failed to switch MFA method:", error); +} +``` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx new file mode 100644 index 000000000..45007ab21 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx @@ -0,0 +1,18 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:72 + +ReportBrowserErrorOptions + +## Properties + +<ParamField body='error' type='[WebAuthnErrorDetails](./WebAuthnErrorDetails)'> +> **error**: [`WebAuthnErrorDetails`](./WebAuthnErrorDetails) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:79 + +The error object from the WebAuthn API (`navigator.credentials.get()`) + to be reported. Must include `name` and `message`. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..8e61a5099 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,15 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:88 + +TryAnotherMethodOptions + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx new file mode 100644 index 000000000..7a8d82e12 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx @@ -0,0 +1,214 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:137 + +ResetPasswordMfaWebAuthnRoamingChallengeMembers + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge](./ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge)'> +> **screen**: [`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](./ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:143 + +Access to the specific properties and data of the `reset-password-mfa-webauthn-roaming-challenge` screen, +including WebAuthn `publicKey` challenge options and the `showRememberDevice` flag. + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +**Methods** +</ParamField> + +<ParamField body='useSecurityKey()' type='unknown'> +> **useSecurityKey**(`options?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:160 + +Initiates the WebAuthn assertion process (security key challenge). +This method will internally call `navigator.credentials.get()` using the challenge +provided in `screen.publicKey`. +On successful interaction with the security key, it submits the resulting +`PublicKeyCredential` to Auth0 with `action: "default"`. + +**Parameters** + +**options?** + +[`ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions`](./ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions) + +Optional. Parameters for the operation, +such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. +The `response` field (the WebAuthn credential) is handled internally by the SDK. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the verification attempt is submitted. +A successful operation typically results in a redirect by Auth0. + +**Throws** + +Throws an error if `screen.publicKey` is missing, if `navigator.credentials.get()` +fails (e.g., user cancellation, no authenticator found), or if the form submission to Auth0 fails. +It's recommended to catch these errors and potentially use `showError()` to report WebAuthn API specific issues. + +</ParamField> + +<ParamField body='showError()' type='unknown'> +> **showError**(`options`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:174 + +Reports a client-side WebAuthn API error (from `navigator.credentials.get()`) to Auth0. +This method should be used when `useSecurityKey()` (or a manual `navigator.credentials.get()` call) +fails due to a browser-side WebAuthn issue (e.g., `NotAllowedError` if the user cancels the prompt, +`NotFoundError` if no matching authenticator is found, or a timeout). +It submits the error details with `action: "showError::{errorDetailsJsonString}"` and an empty `response`. + +**Parameters** + +**options** + +[`ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions`](./ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions) + +Contains the `error` object (with `name` and `message` +from the WebAuthn API DOMException), an optional `rememberDevice` flag, and any other custom options. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the error report is submitted. +Auth0 may re-render the page with error information or redirect. + +**Throws** + +Throws an error if the form submission fails (e.g., network error, invalid state). + +</ParamField> + +<ParamField body='tryAnotherMethod()' type='unknown'> +> **tryAnotherMethod**(`options?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:185 + +Allows the user to opt-out of the WebAuthn roaming challenge and select a different MFA method. +This action submits `action: "pick-authenticator"` to Auth0, which should navigate +the user to an MFA factor selection screen. + +**Parameters** + +**options?** + +[`ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](./ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions) + +Optional. Parameters for the operation, +such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the 'pick-authenticator' action is submitted. + +**Throws** + +Throws an error if the form submission fails. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx new file mode 100644 index 000000000..9250276a1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx @@ -0,0 +1,28 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:91 + +ShowErrorOptions + +## Properties + +<ParamField body='error' type='[WebAuthnErrorDetails](./WebAuthnErrorDetails)'> +> **error**: [`WebAuthnErrorDetails`](./WebAuthnErrorDetails) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:98 + +The error object from the WebAuthn API (`navigator.credentials.get()`) +containing `name` and `message` of the DOMException. + +</ParamField> + +<ParamField body='rememberDevice?' type='boolean'> +> `optional` **rememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:105 + +Optional. If `true` and `screen.showRememberDevice` is also `true`, +the SDK will include `rememberBrowser=true` in the form submission. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..195298bda --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,26 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:116 + +TryAnotherMethodOptions + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='rememberDevice?' type='boolean'> +> `optional` **rememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:123 + +Optional. If `true` and `screen.showRememberDevice` is also `true`, +the SDK will include `rememberBrowser=true` in the form submission. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx new file mode 100644 index 000000000..e8e753f6f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:70 + +UseSecurityKeyOptions + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='rememberDevice?' type='boolean'> +> `optional` **rememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:78 + +Optional. If `true` and `screen.showRememberDevice` is also `true`, +the SDK will include `rememberBrowser=true` in the form submission, indicating the user's +choice to remember this device. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordOptions.mdx new file mode 100644 index 000000000..ce96f7b36 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordOptions.mdx @@ -0,0 +1,24 @@ +--- +title: "ResetPasswordOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:5 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='password-reset' type='string'> +> **password-reset**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:6 + +</ParamField> + +<ParamField body='re-enter-password' type='string'> +> **re-enter-password**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:7 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers.mdx new file mode 100644 index 000000000..f98c1ff6e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers.mdx @@ -0,0 +1,155 @@ +--- +title: "ResetPasswordRequestMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:23 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnResetPasswordRequest](./ScreenMembersOnResetPasswordRequest)'> +> **screen**: [`ScreenMembersOnResetPasswordRequest`](./ScreenMembersOnResetPasswordRequest) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:24 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembersOnResetPasswordRequest](./TransactionMembersOnResetPasswordRequest)'> +> **transaction**: [`TransactionMembersOnResetPasswordRequest`](./TransactionMembersOnResetPasswordRequest) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:25 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='resetPassword()' type='unknown'> +> **resetPassword**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:26 + +**Parameters** + +**payload** + +[`ResetPasswordRequestOptions`](./ResetPasswordRequestOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='backToLogin()' type='unknown'> +> **backToLogin**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:27 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='getLoginIdentifiers()' type='unknown'> +> **getLoginIdentifiers**(): [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:28 + +**Returns** + +[`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestOptions.mdx new file mode 100644 index 000000000..d095cb0fc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestOptions.mdx @@ -0,0 +1,24 @@ +--- +title: "ResetPasswordRequestOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:6 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='username' type='string'> +> **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:7 + +</ParamField> + +<ParamField body='captcha?' type='string'> +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:8 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers.mdx new file mode 100644 index 000000000..0e6b4816a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers.mdx @@ -0,0 +1,109 @@ +--- +title: "ResetPasswordSuccessMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-success.d.ts:11 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnResetPasswordSuccess](./ScreenMembersOnResetPasswordSuccess)'> +> **screen**: [`ScreenMembersOnResetPasswordSuccess`](./ScreenMembersOnResetPasswordSuccess) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-success.d.ts:12 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope.mdx new file mode 100644 index 000000000..c6bcdd246 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope.mdx @@ -0,0 +1,20 @@ +--- +title: "Scope" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:52 + +## Properties + +<ParamField body='value' type='string'> +> **value**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:53 + +</ParamField> + +<ParamField body='description?' type='string'> +> `optional` **description**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:54 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.mdx new file mode 100644 index 000000000..5cbc199fc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.mdx @@ -0,0 +1,128 @@ +--- +title: "ScreenMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:70 + +## Extended by + +- [`ScreenMembersOnLoginId`](./ScreenMembersOnLoginId) +- [`ScreenMembersOnLoginPassword`](./ScreenMembersOnLoginPassword) +- [`ScreenMembersOnLoginPasswordlessEmailCode`](./ScreenMembersOnLoginPasswordlessEmailCode) +- [`ScreenMembersOnLoginPasswordlessSmsOtp`](./ScreenMembersOnLoginPasswordlessSmsOtp) +- [`ScreenMembersOnPasskeyEnrollment`](./ScreenMembersOnPasskeyEnrollment) +- [`ScreenMembersOnPasskeyEnrollmentLocal`](./ScreenMembersOnPasskeyEnrollmentLocal) +- [`ScreenMembersOnEmailIdentifierChallenge`](./ScreenMembersOnEmailIdentifierChallenge) +- [`ScreenMembersOnPhoneIdentifierChallenge`](./ScreenMembersOnPhoneIdentifierChallenge) +- [`ScreenMembersOnPhoneIdentifierEnrollment`](./ScreenMembersOnPhoneIdentifierEnrollment) +- [`ScreenMembersOnSignupId`](./ScreenMembersOnSignupId) +- [`ScreenMembersOnSignupPassword`](./ScreenMembersOnSignupPassword) +- [`ScreenMembersOnSignup`](./ScreenMembersOnSignup) +- [`ScreenMembersOnResetPasswordEmail`](./ScreenMembersOnResetPasswordEmail) +- [`ScreenMembersOnResetPasswordRequest`](./ScreenMembersOnResetPasswordRequest) +- [`ScreenMembersOnResetPassword`](./ScreenMembersOnResetPassword) +- [`ScreenMembersOnResetPasswordError`](./ScreenMembersOnResetPasswordError) +- [`ScreenMembersOnResetPasswordSuccess`](./ScreenMembersOnResetPasswordSuccess) +- [`ScreenMembersOnLogin`](./ScreenMembersOnLogin) +- [`ScreenMembersOnMfaPushEnrollmentQr`](./ScreenMembersOnMfaPushEnrollmentQr) +- [`ScreenMembersOnMfaPushWelcome`](./ScreenMembersOnMfaPushWelcome) +- [`ScreenMembersOnMfaEnrollResult`](./ScreenMembersOnMfaEnrollResult) +- [`ScreenMembersOnMfaSmsEnrollment`](./ScreenMembersOnMfaSmsEnrollment) +- [`ScreenMembersOnMfaSmsChallenge`](./ScreenMembersOnMfaSmsChallenge) +- [`ScreenMembersOnMfaCountryCodes`](./ScreenMembersOnMfaCountryCodes) +- [`ScreenMembersOnResetPasswordMfaPushChallengePush`](./ScreenMembersOnResetPasswordMfaPushChallengePush) +- [`ScreenMembersOnResetPasswordMfaEmailChallenge`](./ScreenMembersOnResetPasswordMfaEmailChallenge) +- [`ScreenMembersOnResetPasswordMfaSmsChallenge`](./ScreenMembersOnResetPasswordMfaSmsChallenge) +- [`ScreenMembersOnMfaEmailChallenge`](./ScreenMembersOnMfaEmailChallenge) +- [`ScreenMembersOnMfaEmailList`](./ScreenMembersOnMfaEmailList) +- [`ScreenMembersOnMfaLoginOptions`](./ScreenMembersOnMfaLoginOptions) +- [`ScreenMembersOnMfaPushChallengePush`](./ScreenMembersOnMfaPushChallengePush) +- [`ScreenMembersOnMfaOtpChallenge`](./ScreenMembersOnMfaOtpChallenge) +- [`ScreenMembersOnMfaOtpEnrollmentQr`](./ScreenMembersOnMfaOtpEnrollmentQr) +- [`ScreenMembersOnMfaOtpEnrollmentCode`](./ScreenMembersOnMfaOtpEnrollmentCode) +- [`ScreenMembersOnOrganizationSelection`](./ScreenMembersOnOrganizationSelection) +- [`ScreenMembersOnAcceptInvitation`](./ScreenMembersOnAcceptInvitation) +- [`ScreenMembersOnCustomizedConsent`](./ScreenMembersOnCustomizedConsent) +- [`ScreenMembersOnMfaVoiceChallenge`](./ScreenMembersOnMfaVoiceChallenge) +- [`ScreenMembersOnResetPasswordMfaVoiceChallenge`](./ScreenMembersOnResetPasswordMfaVoiceChallenge) +- [`ScreenMembersOnDeviceCodeConfirmation`](./ScreenMembersOnDeviceCodeConfirmation) +- [`ScreenMembersOnMfaPhoneChallenge`](./ScreenMembersOnMfaPhoneChallenge) +- [`ScreenMembersOnMfaRecoveryCodeEnrollment`](./ScreenMembersOnMfaRecoveryCodeEnrollment) +- [`ScreenMembersOnResetPasswordMfaPhoneChallenge`](./ScreenMembersOnResetPasswordMfaPhoneChallenge) +- [`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](./ScreenMembersOnMfaRecoveryCodeChallengeNewCode) +- [`ScreenMembersOnEmailOTPChallenge`](./ScreenMembersOnEmailOTPChallenge) +- [`ScreenMembersOnEmailVerificationResult`](./ScreenMembersOnEmailVerificationResult) +- [`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](./ScreenMembersOnMfaWebAuthnPlatformEnrollment) +- [`ScreenMembersOnMfaWebAuthnError`](./ScreenMembersOnMfaWebAuthnError) +- [`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](./ScreenMembersOnMfaWebAuthnRoamingEnrollment) +- [`ScreenMembersOnMfaWebAuthnRoamingChallenge`](./ScreenMembersOnMfaWebAuthnRoamingChallenge) +- [`ScreenMembersOnMfaWebAuthnPlatformChallenge`](./ScreenMembersOnMfaWebAuthnPlatformChallenge) +- [`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](./ScreenMembersOnMfaWebAuthnEnrollmentSuccess) +- [`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](./ScreenMembersOnMfaWebAuthnChangeKeyNickname) +- [`ScreenMembersOnConsent`](./ScreenMembersOnConsent) +- [`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](./ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge) +- [`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](./ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation.mdx new file mode 100644 index 000000000..f8496a84d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation.mdx @@ -0,0 +1,109 @@ +--- +title: "ScreenMembersOnAcceptInvitation" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:8 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ inviter: string; email: string; } '> +> **data**: \{ `inviter`: `string`; `email`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:9 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent.mdx new file mode 100644 index 000000000..fb47952d2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent.mdx @@ -0,0 +1,127 @@ +--- +title: "ScreenMembersOnConsent" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/consent.d.ts:19 + +ScreenMembersOnConsent + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +Screen-specific data. + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='scopes' type='[Scope](./Scope)[]'> +> **scopes**: [`Scope`](./Scope)[] + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/consent.d.ts:20 + +</ParamField> + +<ParamField body='hideScopes' type='boolean'> +> **hideScopes**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/consent.d.ts:21 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent.mdx new file mode 100644 index 000000000..954dcbe9c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent.mdx @@ -0,0 +1,137 @@ +--- +title: "ScreenMembersOnCustomizedConsent" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/customized-consent.d.ts:18 + +ScreenMembersOnCustomizedConsent + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +Screen-specific data. + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='scopes' type='[Scope](./Scope)[]'> +> **scopes**: [`Scope`](./Scope)[] + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/customized-consent.d.ts:24 + +An array of `Scope` objects detailing each permission (scope) being requested. +These are typically high-level permissions like 'read:profile' or 'openid'. +This list should be displayed to the user for their review. + +</ParamField> + +<ParamField body='authorizationDetails' type='[AuthorizationDetail](./AuthorizationDetail)[]'> +> **authorizationDetails**: [`AuthorizationDetail`](./AuthorizationDetail)[] + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/customized-consent.d.ts:32 + +An array of `AuthorizationDetail` objects. +Each object provides granular details about specific data or +actions the application wants to perform, potentially related to +Rich Authorization Requests (RAR) or other fine-grained permission models. +This list should be displayed to the user for their review. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx new file mode 100644 index 000000000..3c63c891f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx @@ -0,0 +1,111 @@ +--- +title: "ScreenMembersOnDeviceCodeConfirmation" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-confirmation.d.ts:7 + +Interface describing the data available on the Device Code Confirmation screen. + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ textCode: string; } '> +> **data**: \{ `textCode`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-confirmation.d.ts:8 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx new file mode 100644 index 000000000..3c2b0c43f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx @@ -0,0 +1,109 @@ +--- +title: "ScreenMembersOnEmailIdentifierChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:10 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ messageType?: string; email?: string; resendLimitReached?: boolean; } '> +> **data**: \{ `messageType?`: `string`; `email?`: `string`; `resendLimitReached?`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:11 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge.mdx new file mode 100644 index 000000000..e60676d32 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge.mdx @@ -0,0 +1,112 @@ +--- +title: "ScreenMembersOnEmailOTPChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-otp-challenge.d.ts:9 + +Represents the members of the Email OTP Challenge screen. +Extends the base ScreenMembers interface. + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult.mdx new file mode 100644 index 000000000..19e6587ea --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult.mdx @@ -0,0 +1,138 @@ +--- +title: "ScreenMembersOnEmailVerificationResult" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-verification-result.d.ts:15 + +ScreenMembersOnEmailVerificationResult + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +Navigation links available on this screen. + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ status: string; } '> +> **data**: \{ `status`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-verification-result.d.ts:20 + +Screen-specific data. + +**Type Declaration** + +\{ `status`: `string`; \} + +**status** + +> **status**: `string` + +The status of the email verification process. +Possible values might include "success", "failure", "already_verified", etc. +This status should be displayed to the user to inform them of the outcome. + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='loginLink' type='string '> +> **loginLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-verification-result.d.ts:32 + +Navigation links available on this screen. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin.mdx new file mode 100644 index 000000000..aedfb7353 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin.mdx @@ -0,0 +1,125 @@ +--- +title: "ScreenMembersOnLogin" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:18 + +Extended screen members interface for the login screen + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='signupLink' type='string '> +> **signupLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:19 + +</ParamField> + +<ParamField body='resetPasswordLink' type='string '> +> **resetPasswordLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:20 + +</ParamField> + +<ParamField body='data' type='{ username?: string; } '> +> **data**: \{ `username?`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:21 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId.mdx new file mode 100644 index 000000000..e3653de0e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId.mdx @@ -0,0 +1,130 @@ +--- +title: "ScreenMembersOnLoginId" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:26 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='signupLink' type='string '> +> **signupLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:27 + +</ParamField> + +<ParamField body='resetPasswordLink' type='string '> +> **resetPasswordLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:28 + +</ParamField> + +<ParamField body='publicKey' type='{ challenge: string; allowCredentials?: [AllowCredential](./AllowCredential)[]; } '> +> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](./AllowCredential)[]; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:29 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword.mdx new file mode 100644 index 000000000..f720a4231 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword.mdx @@ -0,0 +1,130 @@ +--- +title: "ScreenMembersOnLoginPassword" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:12 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='signupLink' type='string '> +> **signupLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:13 + +</ParamField> + +<ParamField body='resetPasswordLink' type='string '> +> **resetPasswordLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:14 + +</ParamField> + +<ParamField body='editIdentifierLink' type='string '> +> **editIdentifierLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:15 + +</ParamField> + +<ParamField body='data' type='{ username: string; } '> +> **data**: \{ `username`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:16 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx new file mode 100644 index 000000000..6cee54fe9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx @@ -0,0 +1,130 @@ +--- +title: "ScreenMembersOnLoginPasswordlessEmailCode" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:6 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='editIdentifierLink' type='string '> +> **editIdentifierLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:7 + +</ParamField> + +<ParamField body='resetPasswordLink' type='string '> +> **resetPasswordLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:8 + +</ParamField> + +<ParamField body='signupLink' type='string '> +> **signupLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:9 + +</ParamField> + +<ParamField body='data' type='{ email?: string; username?: string; } '> +> **data**: \{ `email?`: `string`; `username?`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:10 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx new file mode 100644 index 000000000..6ae468fc3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx @@ -0,0 +1,138 @@ +--- +title: "ScreenMembersOnLoginPasswordlessSmsOtp" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:13 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='signupLink' type='string '> +> **signupLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:14 + +</ParamField> + +<ParamField body='resetPasswordLink' type='string '> +> **resetPasswordLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:15 + +</ParamField> + +<ParamField body='backLink' type='string '> +> **backLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:16 + +</ParamField> + +<ParamField body='data' type='object'> +> **data**: `object` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:17 + +**username** + +> **username**: `string` + +**phone\_number** + +> **phone\_number**: `string` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes.mdx new file mode 100644 index 000000000..42937c8ad --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes.mdx @@ -0,0 +1,123 @@ +--- +title: "ScreenMembersOnMfaCountryCodes" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-country-codes.d.ts:7 + +Interface for screen data specific to mfa-country-codes screen + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ phone_prefixes: [PhonePrefix](./PhonePrefix)[]; } '> +> **data**: \{ `phone_prefixes`: [`PhonePrefix`](./PhonePrefix)[]; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-country-codes.d.ts:8 + +**Type Declaration** + +\{ `phone_prefixes`: [`PhonePrefix`](./PhonePrefix)[]; \} + +**phone\_prefixes** + +> **phone\_prefixes**: [`PhonePrefix`](./PhonePrefix)[] + +List of available phone prefixes + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge.mdx new file mode 100644 index 000000000..e5dad8f99 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge.mdx @@ -0,0 +1,111 @@ +--- +title: "ScreenMembersOnMfaEmailChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:9 + +Interface for the screen data specific to mfa-email-challenge screen + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ email: string; showRememberDevice?: boolean; } '> +> **data**: \{ `email`: `string`; `showRememberDevice?`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:10 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList.mdx new file mode 100644 index 000000000..d913bd03d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList.mdx @@ -0,0 +1,123 @@ +--- +title: "ScreenMembersOnMfaEmailList" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-list.d.ts:7 + +Interface for the screen data specific to mfa-email-list screen + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ enrolled_emails: string[]; } '> +> **data**: \{ `enrolled_emails`: `string`[]; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-list.d.ts:8 + +**Type Declaration** + +\{ `enrolled_emails`: `string`[]; \} + +**enrolled\_emails** + +> **enrolled\_emails**: `string`[] + +List of enrolled email addresses + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult.mdx new file mode 100644 index 000000000..a928e1082 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult.mdx @@ -0,0 +1,127 @@ +--- +title: "ScreenMembersOnMfaEnrollResult" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-enroll-result.d.ts:12 + +ScreenMembersOnMfaEnrollResult + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ status: string; } '> +> **data**: \{ `status`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-enroll-result.d.ts:17 + +Screen-specific data. + +**Type Declaration** + +\{ `status`: `string`; \} + +**status** + +> **status**: `string` + +The status of the MFA enrollment process. +Possible values might include "success", "failure", or other specific status codes. +This status can be used to display an appropriate message to the user. + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions.mdx new file mode 100644 index 000000000..99d0ac027 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions.mdx @@ -0,0 +1,123 @@ +--- +title: "ScreenMembersOnMfaLoginOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-login-options.d.ts:8 + +Interface for the screen data specific to mfa-login-options screen + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ enrolled_factors: string[]; } '> +> **data**: \{ `enrolled_factors`: `string`[]; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-login-options.d.ts:9 + +**Type Declaration** + +\{ `enrolled_factors`: `string`[]; \} + +**enrolled\_factors** + +> **enrolled\_factors**: `string`[] + +List of enrolled MFA factors for the user + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge.mdx new file mode 100644 index 000000000..96f110aad --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge.mdx @@ -0,0 +1,111 @@ +--- +title: "ScreenMembersOnMfaOtpChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:7 + +Interface for the screen data specific to mfa-otp-challenge screen + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ showRememberDevice?: boolean; } '> +> **data**: \{ `showRememberDevice?`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:8 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx new file mode 100644 index 000000000..e7f8552a4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx @@ -0,0 +1,123 @@ +--- +title: "ScreenMembersOnMfaOtpEnrollmentCode" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-code.d.ts:28 + +Interface for the screen data specific to the mfa-otp-enrollment-code screen. + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ text_code: string; } '> +> **data**: \{ `text_code`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-code.d.ts:29 + +**Type Declaration** + +\{ `text_code`: `string`; \} + +**text\_code** + +> **text\_code**: `string` + +The text code to display to the user. + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx new file mode 100644 index 000000000..c0237e845 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx @@ -0,0 +1,111 @@ +--- +title: "ScreenMembersOnMfaOtpEnrollmentQr" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-qr.d.ts:7 + +Interface for the screen data specific to mfa-otp-enrollment-qr screen + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ qr_code: string; } '> +> **data**: \{ `qr_code`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-qr.d.ts:8 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx new file mode 100644 index 000000000..bf9e033ef --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx @@ -0,0 +1,123 @@ +--- +title: "ScreenMembersOnMfaPhoneChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:14 + +ScreenMembersOnMfaPhoneChallenge + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ phoneNumber: string; } '> +> **data**: \{ `phoneNumber`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:19 + +**Type Declaration** + +\{ `phoneNumber`: `string`; \} + +**phoneNumber** + +> **phoneNumber**: `string` + +The phone number (often masked) associated with this MFA challenge. + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush.mdx new file mode 100644 index 000000000..89af22db5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush.mdx @@ -0,0 +1,129 @@ +--- +title: "ScreenMembersOnMfaPushChallengePush" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:9 + +Interface for the screen data specific to mfa-push-challenge-push screen + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ deviceName: string; showRememberDevice?: boolean; } '> +> **data**: \{ `deviceName`: `string`; `showRememberDevice?`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:10 + +**Type Declaration** + +\{ `deviceName`: `string`; `showRememberDevice?`: `boolean`; \} + +**deviceName** + +> **deviceName**: `string` + +The name of the device receiving the push notification + +**showRememberDevice?** + +> `optional` **showRememberDevice**: `boolean` + +Whether to show the remember device option + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx new file mode 100644 index 000000000..40071adf3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx @@ -0,0 +1,111 @@ +--- +title: "ScreenMembersOnMfaPushEnrollmentQr" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-enrollment-qr.d.ts:8 + +Interface for the screen data specific to mfa-push-enrollment-qr screen + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ qrCode: string; qrUri: string; showCodeCopy: boolean; } '> +> **data**: \{ `qrCode`: `string`; `qrUri`: `string`; `showCodeCopy`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-enrollment-qr.d.ts:9 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome.mdx new file mode 100644 index 000000000..906c08112 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome.mdx @@ -0,0 +1,132 @@ +--- +title: "ScreenMembersOnMfaPushWelcome" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcome.d.ts:7 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='screen' type='object'> +> **screen**: `object` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcome.d.ts:8 + +**name** + +> **name**: `string` + +**links** + +> **links**: `object` + +**links.ios** + +> **ios**: `string` + +**links.android** + +> **android**: `string` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx new file mode 100644 index 000000000..3045cfb7e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx @@ -0,0 +1,124 @@ +--- +title: "ScreenMembersOnMfaRecoveryCodeChallengeNewCode" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge-new-code.d.ts:10 + +ScreenMembersOnMfaRecoveryCodeChallengeNewCode + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ textCode: string; } '> +> **data**: \{ `textCode`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge-new-code.d.ts:15 + +**Type Declaration** + +\{ `textCode`: `string`; \} + +**textCode** + +> **textCode**: `string` + +The newly generated recovery code to display to the user. +It is crucial that the user saves this code securely as it will be needed for future logins if other MFA factors are unavailable. + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx new file mode 100644 index 000000000..b76b06e89 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx @@ -0,0 +1,123 @@ +--- +title: "ScreenMembersOnMfaRecoveryCodeEnrollment" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-enrollment.d.ts:7 + +Interface describing the data available on the Mfa Recovery Code Enrollment screen. + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ textCode: string; } '> +> **data**: \{ `textCode`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-enrollment.d.ts:8 + +**Type Declaration** + +\{ `textCode`: `string`; \} + +**textCode** + +> **textCode**: `string` + +The recovery code to display to the user. + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge.mdx new file mode 100644 index 000000000..c5a4f8dee --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge.mdx @@ -0,0 +1,135 @@ +--- +title: "ScreenMembersOnMfaSmsChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:14 + +Interface for the screen data specific to mfa-sms-challenge screen + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ phoneNumber?: string; showRememberDevice?: boolean; showLinkVoice?: boolean; } '> +> **data**: \{ `phoneNumber?`: `string`; `showRememberDevice?`: `boolean`; `showLinkVoice?`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:15 + +**Type Declaration** + +\{ `phoneNumber?`: `string`; `showRememberDevice?`: `boolean`; `showLinkVoice?`: `boolean`; \} + +**phoneNumber?** + +> `optional` **phoneNumber**: `string` + +The phone number where the SMS was sent + +**showRememberDevice?** + +> `optional` **showRememberDevice**: `boolean` + +Whether to show the remember device option + +**showLinkVoice?** + +> `optional` **showLinkVoice**: `boolean` + +Whether to show the link to switch to voice call verification + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx new file mode 100644 index 000000000..9b950d939 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx @@ -0,0 +1,109 @@ +--- +title: "ScreenMembersOnMfaSmsEnrollment" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:9 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ phone?: string; } '> +> **data**: \{ `phone?`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:10 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx new file mode 100644 index 000000000..4705732cd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx @@ -0,0 +1,137 @@ +--- +title: "ScreenMembersOnMfaVoiceChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:26 + +Extended screen members interface for the MFA Voice Challenge screen. + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ phoneNumber?: string; showRememberDevice?: boolean; showLinkSms?: boolean; } '> +> **data**: \{ `phoneNumber?`: `string`; `showRememberDevice?`: `boolean`; `showLinkSms?`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:30 + +Additional screen data specific to MFA voice challenge. + +**Type Declaration** + +\{ `phoneNumber?`: `string`; `showRememberDevice?`: `boolean`; `showLinkSms?`: `boolean`; \} + +**phoneNumber?** + +> `optional` **phoneNumber**: `string` + +The phone number where the voice code was sent. + +**showRememberDevice?** + +> `optional` **showRememberDevice**: `boolean` + +Whether to show the remember device option. + +**showLinkSms?** + +> `optional` **showLinkSms**: `boolean` + +Whether to show the link to switch to SMS verification. + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx new file mode 100644 index 000000000..e6d7abf83 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx @@ -0,0 +1,136 @@ +--- +title: "ScreenMembersOnMfaWebAuthnChangeKeyNickname" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-change-key-nickname.d.ts:14 + +ScreenMembersOnMfaWebAuthnChangeKeyNickname + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ nickname: string; } '> +> **data**: \{ `nickname`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-change-key-nickname.d.ts:19 + +Screen-specific data. + +**Type Declaration** + +\{ `nickname`: `string`; \} + +**nickname** + +> **nickname**: `string` + +The current nickname of the WebAuthn security key that the user is about to change. +This value should be displayed to the user for context. + +**Examples** + +```ts +"My YubiKey" +``` + +```ts +"Work Security Key" +``` + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx new file mode 100644 index 000000000..b5d8af987 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx @@ -0,0 +1,144 @@ +--- +title: "ScreenMembersOnMfaWebAuthnEnrollmentSuccess" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-enrollment-success.d.ts:16 + +ScreenMembersOnMfaWebAuthnEnrollmentSuccess + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ nickname: string; webauthnType: [WebAuthnType](../type-aliases/WebAuthnType); } '> +> **data**: \{ `nickname`: `string`; `webauthnType`: [`WebAuthnType`](../type-aliases/WebAuthnType); \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-enrollment-success.d.ts:21 + +Screen-specific data. + +**Type Declaration** + +\{ `nickname`: `string`; `webauthnType`: [`WebAuthnType`](../type-aliases/WebAuthnType); \} + +**nickname** + +> **nickname**: `string` + +The nickname that the user (or system) assigned to the newly enrolled WebAuthn authenticator. +This helps the user identify the authenticator later. + +**Examples** + +```ts +"YubiKey 5" +``` + +```ts +"My Laptop's Touch ID" +``` + +**webauthnType** + +> **webauthnType**: [`WebAuthnType`](../type-aliases/WebAuthnType) + +The type of WebAuthn authenticator that was successfully enrolled. +- `'webauthn-roaming'`: Indicates a roaming authenticator like a USB security key. +- `'webauthn-platform'`: Indicates a platform authenticator like Touch ID or Windows Hello. + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError.mdx new file mode 100644 index 000000000..a4cdeff8f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError.mdx @@ -0,0 +1,129 @@ +--- +title: "ScreenMembersOnMfaWebAuthnError" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-error.d.ts:18 + +ScreenMembersOnMfaWebAuthnError + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ errorType: string; webauthnType: [WebAuthnType](../type-aliases/WebAuthnType); } '> +> **data**: \{ `errorType`: `string`; `webauthnType`: [`WebAuthnType`](../type-aliases/WebAuthnType); \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-error.d.ts:26 + +**Type Declaration** + +\{ `errorType`: `string`; `webauthnType`: [`WebAuthnType`](../type-aliases/WebAuthnType); \} + +**errorType** + +> **errorType**: `string` + +A code or message describing the WebAuthn error. + +**webauthnType** + +> **webauthnType**: [`WebAuthnType`](../type-aliases/WebAuthnType) + +The type of WebAuthn authenticator involved. + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx new file mode 100644 index 000000000..54c733415 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,132 @@ +--- +title: "ScreenMembersOnMfaWebAuthnPlatformChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:15 + +ScreenMembersOnMfaWebAuthnPlatformChallenge + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +Screen-specific data. + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='publicKey' type='{ challenge: string; allowCredentials?: [AllowCredential](./AllowCredential)[]; } '> +> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](./AllowCredential)[]; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:22 + +The public key credential request options (specifically the challenge) +needed to call `navigator.credentials.get()`. This is derived from `universal_login_context.screen.data.passkey.public_key`. + +</ParamField> + +<ParamField body='showRememberDevice' type='boolean'> +> **showRememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:27 + +Indicates whether the "Remember this device" checkbox should be displayed. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx new file mode 100644 index 000000000..393540ed9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx @@ -0,0 +1,118 @@ +--- +title: "ScreenMembersOnMfaWebAuthnPlatformEnrollment" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:11 + +ScreenMembersOnMfaWebAuthnPlatformEnrollment + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='publicKey' type='{ user: { id: string; name: string; displayName: string; }; rp: { id: string; name: string; }; challenge: string; pubKeyCredParams: [{ type: string; alg: number; }]; authenticatorSelection: { residentKey: string; userVerification: string; authenticatorAttachment?: string; }; } '> +> **publicKey**: \{ `user`: \{ `id`: `string`; `name`: `string`; `displayName`: `string`; \}; `rp`: \{ `id`: `string`; `name`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `type`: `string`; `alg`: `number`; \}\]; `authenticatorSelection`: \{ `residentKey`: `string`; `userVerification`: `string`; `authenticatorAttachment?`: `string`; \}; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:17 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx new file mode 100644 index 000000000..7c110b452 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,134 @@ +--- +title: "ScreenMembersOnMfaWebAuthnRoamingChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:16 + +ScreenMembersOnMfaWebAuthnRoamingChallenge + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +Screen-specific data. + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='showRememberDevice?' type='boolean'> +> `optional` **showRememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:17 + +</ParamField> + +<ParamField body='webauthnType' type='string '> +> **webauthnType**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:18 + +</ParamField> + +<ParamField body='publicKey' type='{ challenge: string; allowCredentials?: [AllowCredential](./AllowCredential)[]; } '> +> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](./AllowCredential)[]; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:19 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx new file mode 100644 index 000000000..29bd555c9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx @@ -0,0 +1,125 @@ +--- +title: "ScreenMembersOnMfaWebAuthnRoamingEnrollment" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:7 + +Interface for screen data specific to mfa-webauthn-roaming-enrollment screen. + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='webauthnType' type='string '> +> **webauthnType**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:8 + +</ParamField> + +<ParamField body='publicKey' type='{ user: { id: string; name: string; displayName: string; }; rp: { id: string; name: string; }; challenge: string; pubKeyCredParams: [{ type: string; alg: number; }]; authenticatorSelection: { residentKey: string; userVerification: string; authenticatorAttachment?: string; }; } '> +> **publicKey**: \{ `user`: \{ `id`: `string`; `name`: `string`; `displayName`: `string`; \}; `rp`: \{ `id`: `string`; `name`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `type`: `string`; `alg`: `number`; \}\]; `authenticatorSelection`: \{ `residentKey`: `string`; `userVerification`: `string`; `authenticatorAttachment?`: `string`; \}; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:9 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection.mdx new file mode 100644 index 000000000..9480886d5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection.mdx @@ -0,0 +1,153 @@ +--- +title: "ScreenMembersOnOrganizationSelection" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:24 + +Interface for the screen data specific to organization-selection screen. + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:25 + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:26 + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:27 + +</ParamField> + +<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> +> **screen**: [`ScreenMembers`](./ScreenMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:28 + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> +> **transaction**: [`TransactionMembers`](./TransactionMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:29 + +</ParamField> + +<ParamField body='User' type='[UserMembers](./UserMembers)'> +> **User**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:30 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment.mdx new file mode 100644 index 000000000..27737738d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment.mdx @@ -0,0 +1,130 @@ +--- +title: "ScreenMembersOnPasskeyEnrollment" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:15 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='backLink' type='string '> +> **backLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:16 + +</ParamField> + +<ParamField body='loginLink' type='string '> +> **loginLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:17 + +</ParamField> + +<ParamField body='publicKey' type='{ user: { id: string; name: string; displayName: string; }; rp: { id: string; name: string; }; challenge: string; pubKeyCredParams: [{ type: string; alg: number; }]; authenticatorSelection: { residentKey: string; userVerification: string; authenticatorAttachment?: string; }; } '> +> **publicKey**: \{ `user`: \{ `id`: `string`; `name`: `string`; `displayName`: `string`; \}; `rp`: \{ `id`: `string`; `name`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `type`: `string`; `alg`: `number`; \}\]; `authenticatorSelection`: \{ `residentKey`: `string`; `userVerification`: `string`; `authenticatorAttachment?`: `string`; \}; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:18 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx new file mode 100644 index 000000000..bec471e81 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx @@ -0,0 +1,116 @@ +--- +title: "ScreenMembersOnPasskeyEnrollmentLocal" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment-local.d.ts:19 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='publicKey' type='{ user: { id: string; name: string; displayName: string; }; rp: { id: string; name: string; }; challenge: string; pubKeyCredParams: [{ type: string; alg: number; }]; authenticatorSelection: { residentKey: string; userVerification: string; authenticatorAttachment?: string; }; } '> +> **publicKey**: \{ `user`: \{ `id`: `string`; `name`: `string`; `displayName`: `string`; \}; `rp`: \{ `id`: `string`; `name`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `type`: `string`; `alg`: `number`; \}\]; `authenticatorSelection`: \{ `residentKey`: `string`; `userVerification`: `string`; `authenticatorAttachment?`: `string`; \}; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment-local.d.ts:20 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx new file mode 100644 index 000000000..d8c0f16b9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx @@ -0,0 +1,109 @@ +--- +title: "ScreenMembersOnPhoneIdentifierChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:22 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ messageType?: "text" '> +> **data**: \{ `messageType?`: `"text"` \| `"voice"`; `phone?`: `string`; `resendLimitReached?`: `boolean`; `showLinkSms?`: `boolean`; `showLinkVoice?`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:23 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx new file mode 100644 index 000000000..c0b3949d6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx @@ -0,0 +1,116 @@ +--- +title: "ScreenMembersOnPhoneIdentifierEnrollment" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:8 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ phone?: "string"; messageType?: "text" '> +> **data**: \{ `phone?`: `"string"`; `messageType?`: `"text"` \| `"voice"`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:9 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='editIdentifierLink' type='string '> +> **editIdentifierLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:13 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword.mdx new file mode 100644 index 000000000..1df488fbf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword.mdx @@ -0,0 +1,109 @@ +--- +title: "ScreenMembersOnResetPassword" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:13 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ username?: string; } '> +> **data**: \{ `username?`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:14 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail.mdx new file mode 100644 index 000000000..48a44b713 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail.mdx @@ -0,0 +1,109 @@ +--- +title: "ScreenMembersOnResetPasswordEmail" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-email.d.ts:10 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ username?: string; } '> +> **data**: \{ `username?`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-email.d.ts:11 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError.mdx new file mode 100644 index 000000000..512ad8517 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError.mdx @@ -0,0 +1,109 @@ +--- +title: "ScreenMembersOnResetPasswordError" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-error.d.ts:9 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ username?: string; } '> +> **data**: \{ `username?`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-error.d.ts:10 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx new file mode 100644 index 000000000..6145d9ba1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx @@ -0,0 +1,111 @@ +--- +title: "ScreenMembersOnResetPasswordMfaEmailChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:7 + +Interface for the screen data specific to reset-password-mfa-email-challenge screen + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ email: string; } '> +> **data**: \{ `email`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:8 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx new file mode 100644 index 000000000..852b1dabe --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx @@ -0,0 +1,123 @@ +--- +title: "ScreenMembersOnResetPasswordMfaPhoneChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:14 + +ScreenMembersOnResetPasswordMfaPhoneChallenge + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ phoneNumber: string; } '> +> **data**: \{ `phoneNumber`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:19 + +**Type Declaration** + +\{ `phoneNumber`: `string`; \} + +**phoneNumber** + +> **phoneNumber**: `string` + +The phone number (often masked) associated with this MFA challenge. + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx new file mode 100644 index 000000000..5699f4efc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx @@ -0,0 +1,111 @@ +--- +title: "ScreenMembersOnResetPasswordMfaPushChallengePush" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-push-challenge-push.d.ts:8 + +Interface for the screen data specific to reset-password-mfa-push-challenge-push screen + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ deviceName: string; rememberDevice?: boolean; } '> +> **data**: \{ `deviceName`: `string`; `rememberDevice?`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-push-challenge-push.d.ts:9 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx new file mode 100644 index 000000000..fc4237b8c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx @@ -0,0 +1,125 @@ +--- +title: "ScreenMembersOnResetPasswordMfaSmsChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:9 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ phoneNumber: string; showLinkVoice?: boolean; } '> +> **data**: \{ `phoneNumber`: `string`; `showLinkVoice?`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:10 + +**Type Declaration** + +\{ `phoneNumber`: `string`; `showLinkVoice?`: `boolean`; \} + +**phoneNumber** + +> **phoneNumber**: `string` + +**showLinkVoice?** + +> `optional` **showLinkVoice**: `boolean` + +Whether to show the link to switch to voice call verification + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx new file mode 100644 index 000000000..bfd35226a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx @@ -0,0 +1,129 @@ +--- +title: "ScreenMembersOnResetPasswordMfaVoiceChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-voice-challenge.d.ts:8 + +Interface for the screen data specific to reset-password-mfa-voice-challenge screen. + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ phoneNumber: string; showLinkSms?: boolean; } '> +> **data**: \{ `phoneNumber`: `string`; `showLinkSms?`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-voice-challenge.d.ts:9 + +**Type Declaration** + +\{ `phoneNumber`: `string`; `showLinkSms?`: `boolean`; \} + +**phoneNumber** + +> **phoneNumber**: `string` + +The phone number to send the voice call to. + +**showLinkSms?** + +> `optional` **showLinkSms**: `boolean` + +Whether to show the link to switch to SMS verification. + +`null` + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx new file mode 100644 index 000000000..42b270462 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,135 @@ +--- +title: "ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:28 + +ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +Screen-specific data. + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='publicKey' type='{ challenge: string; allowCredentials?: [AllowCredential](./AllowCredential)[]; } '> +> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](./AllowCredential)[]; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:35 + +A convenience accessor for `data.passkey.public_key`. + Provides the challenge and other parameters for the + WebAuthn `navigator.credentials.get()` API call. + +</ParamField> + +<ParamField body='showRememberDevice' type='boolean'> +> **showRememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:41 + +A convenience accessor for `data.show_remember_device`. + Indicates if the "Remember this device" option should be displayed. + Defaults to `false` if not present in the context. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx new file mode 100644 index 000000000..f829f68f1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,134 @@ +--- +title: "ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:41 + +ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +Screen-specific data, +including WebAuthn challenge options and the "show remember device" flag. + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='publicKey' type='{ challenge: string; allowCredentials?: [AllowCredential](./AllowCredential)[]; } '> +> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](./AllowCredential)[]; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:50 + +A convenience accessor for `screen.data.passkey.public_key`. +Provides the challenge and related options for `navigator.credentials.get()`. + +</ParamField> + +<ParamField body='showRememberDevice' type='boolean'> +> **showRememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:58 + +A convenience accessor for `screen.data.show_remember_device`. +Indicates if the "Remember this device" option should be displayed. Defaults to `false` if not present. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest.mdx new file mode 100644 index 000000000..22dbf87ce --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest.mdx @@ -0,0 +1,109 @@ +--- +title: "ScreenMembersOnResetPasswordRequest" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:16 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='data' type='{ phone?: string; email?: string; username?: string; } '> +> **data**: \{ `phone?`: `string`; `email?`: `string`; `username?`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:17 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess.mdx new file mode 100644 index 000000000..ef04bbd1c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess.mdx @@ -0,0 +1,109 @@ +--- +title: "ScreenMembersOnResetPasswordSuccess" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-success.d.ts:9 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup.mdx new file mode 100644 index 000000000..66f9d6c2a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup.mdx @@ -0,0 +1,116 @@ +--- +title: "ScreenMembersOnSignup" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:21 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='loginLink' type='string '> +> **loginLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:22 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId.mdx new file mode 100644 index 000000000..39f6ad078 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId.mdx @@ -0,0 +1,116 @@ +--- +title: "ScreenMembersOnSignupId" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:22 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='data' type='Record<string, string '> +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='loginLink' type='string '> +> **loginLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:23 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword.mdx new file mode 100644 index 000000000..4385eca4f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword.mdx @@ -0,0 +1,123 @@ +--- +title: "ScreenMembersOnSignupPassword" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:24 + +## Extends + +- [`ScreenMembers`](./ScreenMembers) + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) + +</ParamField> + +<ParamField body='captchaImage' type='string '> +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string '> +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='captchaProvider' type='string '> +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record<string, string> '> +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) + +</ParamField> + +<ParamField body='texts' type='Record<string, string> '> +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> +> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 + +**Inherited from** + +[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='loginLink' type='string '> +> **loginLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:25 + +</ParamField> + +<ParamField body='editLink' type='string '> +> **editLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:26 + +</ParamField> + +<ParamField body='data' type='{ email?: string; phoneNumber?: string; username?: string; } '> +> **data**: \{ `email?`: `string`; `phoneNumber?`: `string`; `username?`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:27 + +**Overrides** + +[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectCountryCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectCountryCodeOptions.mdx new file mode 100644 index 000000000..3bfe03031 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectCountryCodeOptions.mdx @@ -0,0 +1,32 @@ +--- +title: "SelectCountryCodeOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-country-codes.d.ts:16 + +Options for selecting a country code + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='country\_code' type='string'> +> **country\_code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-country-codes.d.ts:18 + +The country code (e.g. 'US', 'GB') + +</ParamField> + +<ParamField body='phone\_prefix' type='string'> +> **phone\_prefix**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-country-codes.d.ts:20 + +The phone prefix (e.g. '+1', '+44') +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaEmailOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaEmailOptions.mdx new file mode 100644 index 000000000..7008a4bca --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaEmailOptions.mdx @@ -0,0 +1,25 @@ +--- +title: "SelectMfaEmailOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-list.d.ts:16 + +Options for selecting an email address + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='index' type='number'> +> **index**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-list.d.ts:21 + +**Param** + +The index of the phone number to select. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaPushDeviceOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaPushDeviceOptions.mdx new file mode 100644 index 000000000..121ac3c2e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaPushDeviceOptions.mdx @@ -0,0 +1,22 @@ +--- +title: "SelectMfaPushDeviceOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-list.d.ts:6 + +Options for selecting an MFA push device. + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='deviceIndex' type='number'> +> **deviceIndex**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-list.d.ts:11 + +The index of the device to select from the list of enrolled devices. +The index is 0-based. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectOrganizationOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectOrganizationOptions.mdx new file mode 100644 index 000000000..5a16d7f21 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectOrganizationOptions.mdx @@ -0,0 +1,20 @@ +--- +title: "SelectOrganizationOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-picker.d.ts:3 + +## Properties + +<ParamField body='organization' type='string'> +> **organization**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-picker.d.ts:4 + +</ParamField> + +<ParamField body='state' type='string'> +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-picker.d.ts:5 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions.mdx new file mode 100644 index 000000000..3a9bae5b0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "ShowErrorOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:14 + +Options for submitting a WebAuthn browser error. + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| [`WebAuthnErrorDetails`](./WebAuthnErrorDetails) \| `undefined` + +Any additional custom options. + +## Properties + +<ParamField body='error' type='[WebAuthnErrorDetails](./WebAuthnErrorDetails)'> +> **error**: [`WebAuthnErrorDetails`](./WebAuthnErrorDetails) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:18 + +The details of the WebAuthn error. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers.mdx new file mode 100644 index 000000000..fd9cc540f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers.mdx @@ -0,0 +1,189 @@ +--- +title: "SignupIdMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:46 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnSignupId](./ScreenMembersOnSignupId)'> +> **screen**: [`ScreenMembersOnSignupId`](./ScreenMembersOnSignupId) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:47 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembersOnSignupId](./TransactionMembersOnSignupId)'> +> **transaction**: [`TransactionMembersOnSignupId`](./TransactionMembersOnSignupId) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:48 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='signup()' type='unknown'> +> **signup**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:49 + +**Parameters** + +**payload** + +[`SignupOptions`](./SignupOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='federatedSignup()' type='unknown'> +> **federatedSignup**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:50 + +**Parameters** + +**payload** + +[`FederatedSignupOptions`](./FederatedSignupOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='getSignupIdentifiers()' type='unknown'> +> **getSignupIdentifiers**(): [`Identifier`](./Identifier)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:51 + +**Returns** + +[`Identifier`](./Identifier)[] \| `null` + +</ParamField> + +<ParamField body='pickCountryCode()' type='unknown'> +> **pickCountryCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:52 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='validateUsername()' type='unknown'> +> **validateUsername**(`username`): [`UsernameValidationResult`](./UsernameValidationResult) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:53 + +**Parameters** + +**username** + +`string` + +**Returns** + +[`UsernameValidationResult`](./UsernameValidationResult) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers.mdx new file mode 100644 index 000000000..e5143fbe8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers.mdx @@ -0,0 +1,231 @@ +--- +title: "SignupMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:31 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnSignup](./ScreenMembersOnSignup)'> +> **screen**: [`ScreenMembersOnSignup`](./ScreenMembersOnSignup) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:32 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembersOnSignup](./TransactionMembersOnSignup)'> +> **transaction**: [`TransactionMembersOnSignup`](./TransactionMembersOnSignup) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:33 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='signup()' type='unknown'> +> **signup**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:34 + +**Parameters** + +**payload** + +[`SignupPayloadOptions`](./SignupPayloadOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='federatedSignup()' type='unknown'> +> **federatedSignup**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:35 + +**Parameters** + +**payload** + +[`FederatedSignupPayloadOptions`](./FederatedSignupPayloadOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pickCountryCode()' type='unknown'> +> **pickCountryCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:36 + +**Parameters** + +**payload?** + +[`CustomOptions`](./CustomOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='validatePassword()' type='unknown'> +> **validatePassword**(`password`): [`PasswordValidationResult`](./PasswordValidationResult) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:37 + +**Parameters** + +**password** + +`string` + +**Returns** + +[`PasswordValidationResult`](./PasswordValidationResult) + +</ParamField> + +<ParamField body='getSignupIdentifiers()' type='unknown'> +> **getSignupIdentifiers**(): [`Identifier`](./Identifier)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:59 + +Returns a list of enabled identifiers (e.g. email, phone, username) +based on the current transaction state. + +Identifiers may be required or optional depending on the connection strategy +and configuration provided during the authentication or signup flow. + +**Returns** + +[`Identifier`](./Identifier)[] \| `null` + +An array of enabled [Identifier](./Identifier) objects, or `null` if the transaction is not initialized. + +**Example** + +```ts +const identifiers = authClient.getSignupIdentifiers(); +if (identifiers) { + identifiers.forEach(({ type, required }) => { + console.log(`${type} is ${required ? 'required' : 'optional'}`); + }); +} +``` + +**Utility Feature** + +**See** + +Identifier + +</ParamField> + +<ParamField body='validateUsername()' type='unknown'> +> **validateUsername**(`username`): [`UsernameValidationResult`](./UsernameValidationResult) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:60 + +**Parameters** + +**username** + +`string` + +**Returns** + +[`UsernameValidationResult`](./UsernameValidationResult) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupOptions.mdx new file mode 100644 index 000000000..f61501c47 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupOptions.mdx @@ -0,0 +1,38 @@ +--- +title: "SignupOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:39 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='email?' type='string'> +> `optional` **email**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:40 + +</ParamField> + +<ParamField body='username?' type='string'> +> `optional` **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:41 + +</ParamField> + +<ParamField body='phone?' type='string'> +> `optional` **phone**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:42 + +</ParamField> + +<ParamField body='captcha?' type='string'> +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:43 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers.mdx new file mode 100644 index 000000000..fdbebf74d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers.mdx @@ -0,0 +1,161 @@ +--- +title: "SignupPasswordMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:47 + +## Extends + +- [`BaseMembers`](./BaseMembers) + +## Properties + +<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> +> **branding**: [`BrandingMembers`](./BrandingMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type='[ClientMembers](./ClientMembers)'> +> **client**: [`ClientMembers`](./ClientMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> +> **organization**: [`OrganizationMembers`](./OrganizationMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> +> **prompt**: [`PromptMembers`](./PromptMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> +> **tenant**: [`TenantMembers`](./TenantMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='user' type='[UserMembers](./UserMembers)'> +> **user**: [`UserMembers`](./UserMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) + +</ParamField> + +<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> +> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 + +**Inherited from** + +[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='screen' type='[ScreenMembersOnSignupPassword](./ScreenMembersOnSignupPassword)'> +> **screen**: [`ScreenMembersOnSignupPassword`](./ScreenMembersOnSignupPassword) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:48 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) + +</ParamField> + +<ParamField body='transaction' type='[TransactionMembersOnSignupPassword](./TransactionMembersOnSignupPassword)'> +> **transaction**: [`TransactionMembersOnSignupPassword`](./TransactionMembersOnSignupPassword) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:49 + +**Overrides** + +[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) + +**Methods** +</ParamField> + +<ParamField body='signup()' type='unknown'> +> **signup**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:50 + +**Parameters** + +**payload** + +[`SignupPasswordOptions`](./SignupPasswordOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='federatedSignup()' type='unknown'> +> **federatedSignup**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:51 + +**Parameters** + +**payload** + +[`FederatedSignupPasswordPayloadOptions`](./FederatedSignupPasswordPayloadOptions) + +**Returns** + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='validatePassword()' type='unknown'> +> **validatePassword**(`password`): [`PasswordValidationResult`](./PasswordValidationResult) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:52 + +**Parameters** + +**password** + +`string` + +**Returns** + +[`PasswordValidationResult`](./PasswordValidationResult) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordOptions.mdx new file mode 100644 index 000000000..9bd56d26e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordOptions.mdx @@ -0,0 +1,45 @@ +--- +title: "SignupPasswordOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:39 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='email?' type='string'> +> `optional` **email**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:40 + +</ParamField> + +<ParamField body='username?' type='string'> +> `optional` **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:41 + +</ParamField> + +<ParamField body='phoneNumber?' type='string'> +> `optional` **phoneNumber**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:42 + +</ParamField> + +<ParamField body='password' type='string'> +> **password**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:43 + +</ParamField> + +<ParamField body='captcha?' type='string'> +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:44 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPayloadOptions.mdx new file mode 100644 index 000000000..618f166cd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPayloadOptions.mdx @@ -0,0 +1,45 @@ +--- +title: "SignupPayloadOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:9 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='email?' type='string'> +> `optional` **email**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:10 + +</ParamField> + +<ParamField body='username?' type='string'> +> `optional` **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:11 + +</ParamField> + +<ParamField body='phoneNumber?' type='string'> +> `optional` **phoneNumber**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:12 + +</ParamField> + +<ParamField body='password?' type='string'> +> `optional` **password**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:13 + +</ParamField> + +<ParamField body='captcha?' type='string'> +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:14 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions.mdx new file mode 100644 index 000000000..56cb03383 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions.mdx @@ -0,0 +1,33 @@ +--- +title: "StartResendOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/resend-control.d.ts:10 + +Options for configuring resend functionality + +## Properties + +<ParamField body='timeoutSeconds?' type='number'> +> `optional` **timeoutSeconds**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/resend-control.d.ts:11 + +</ParamField> + +<ParamField body='onStatusChange?' type='[OnStatusChangeCallback](../type-aliases/OnStatusChangeCallback)'> +> `optional` **onStatusChange**: [`OnStatusChangeCallback`](../type-aliases/OnStatusChangeCallback) + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/resend-control.d.ts:12 + +</ParamField> + +<ParamField body='onTimeout()?' type='() => void'> +> `optional` **onTimeout**: () => `void` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/resend-control.d.ts:13 + +**Returns** + +`void` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCaptchaOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCaptchaOptions.mdx new file mode 100644 index 000000000..c00c464c1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCaptchaOptions.mdx @@ -0,0 +1,17 @@ +--- +title: "SubmitCaptchaOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/interstitial-captcha.d.ts:2 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` + +## Properties + +<ParamField body='captcha' type='string'> +> **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/interstitial-captcha.d.ts:3 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions.mdx new file mode 100644 index 000000000..810542d20 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions.mdx @@ -0,0 +1,24 @@ +--- +title: "SubmitCodeOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:18 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string '> +> **code**: `string` \| `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:19 + +</ParamField> + +<ParamField body='captcha?' type='string'> +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:20 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitOTPOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitOTPOptions.mdx new file mode 100644 index 000000000..14f3d7462 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitOTPOptions.mdx @@ -0,0 +1,31 @@ +--- +title: "SubmitOTPOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:25 + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='username?' type='string'> +> `optional` **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:26 + +</ParamField> + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:27 + +</ParamField> + +<ParamField body='captcha?' type='string'> +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:28 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions.mdx new file mode 100644 index 000000000..07cb871c7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions.mdx @@ -0,0 +1,15 @@ +--- +title: "SubmitPasskeyCredentialOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:27 + +SubmitPasskeyCredentialOptions + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers.mdx new file mode 100644 index 000000000..96e9bb3c5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers.mdx @@ -0,0 +1,34 @@ +--- +title: "TenantMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/tenant.d.ts:7 + +## Properties + +<ParamField body='name' type='string '> +> **name**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/tenant.d.ts:8 + +</ParamField> + +<ParamField body='friendlyName' type='string '> +> **friendlyName**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/tenant.d.ts:9 + +</ParamField> + +<ParamField body='enabledLocales' type='string[] '> +> **enabledLocales**: `string`[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/tenant.d.ts:10 + +</ParamField> + +<ParamField body='enabledFactors' type='string[] '> +> **enabledFactors**: `string`[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/tenant.d.ts:11 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.mdx new file mode 100644 index 000000000..fa164e7de --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.mdx @@ -0,0 +1,82 @@ +--- +title: "TransactionMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:151 + +## Extended by + +- [`TransactionMembersOnLoginId`](./TransactionMembersOnLoginId) +- [`TransactionMembersOnLoginPassword`](./TransactionMembersOnLoginPassword) +- [`TransactionMembersOnLoginPasswordlessEmailCode`](./TransactionMembersOnLoginPasswordlessEmailCode) +- [`TransactionMembersOnLoginPasswordlessSmsOtp`](./TransactionMembersOnLoginPasswordlessSmsOtp) +- [`TransactionMembersOnSignupId`](./TransactionMembersOnSignupId) +- [`TransactionMembersOnSignupPassword`](./TransactionMembersOnSignupPassword) +- [`TransactionMembersOnSignup`](./TransactionMembersOnSignup) +- [`TransactionMembersOnResetPasswordRequest`](./TransactionMembersOnResetPasswordRequest) +- [`TransactionMembersOnLogin`](./TransactionMembersOnLogin) +- [`TransactionMembersOnResetPassword`](./TransactionMembersOnResetPassword) + +## Properties + +<ParamField body='state' type='string'> +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +</ParamField> + +<ParamField body='locale' type='string'> +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +</ParamField> + +<ParamField body='countryCode' type='string '> +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +</ParamField> + +<ParamField body='countryPrefix' type='string '> +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +</ParamField> + +<ParamField body='connectionStrategy' type='string '> +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +</ParamField> + +<ParamField body='errors' type='[Error](./Error)[] '> +> **errors**: [`Error`](./Error)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 + +</ParamField> + +<ParamField body='currentConnection' type='[Connection](./Connection) '> +> **currentConnection**: [`Connection`](./Connection) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 + +</ParamField> + +<ParamField body='alternateConnections' type='([Connection](./Connection) '> +> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin.mdx new file mode 100644 index 000000000..f7f612a2c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin.mdx @@ -0,0 +1,146 @@ +--- +title: "TransactionMembersOnLogin" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:34 + +Extended transaction members interface for the login screen + +## Extends + +- [`TransactionMembers`](./TransactionMembers) + +## Properties + +<ParamField body='state' type='string'> +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) + +</ParamField> + +<ParamField body='locale' type='string'> +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='countryCode' type='string '> +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string '> +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='connectionStrategy' type='string '> +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='errors' type='[Error](./Error)[] '> +> **errors**: [`Error`](./Error)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='currentConnection' type='[Connection](./Connection) '> +> **currentConnection**: [`Connection`](./Connection) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='alternateConnections' type='([Connection](./Connection) '> +> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='isSignupEnabled' type='boolean'> +> **isSignupEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:35 + +</ParamField> + +<ParamField body='isForgotPasswordEnabled' type='boolean'> +> **isForgotPasswordEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:36 + +</ParamField> + +<ParamField body='isPasskeyEnabled' type='boolean'> +> **isPasskeyEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:37 + +</ParamField> + +<ParamField body='passwordPolicy' type='[PasswordPolicy](./PasswordPolicy) '> +> **passwordPolicy**: [`PasswordPolicy`](./PasswordPolicy) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:38 + +</ParamField> + +<ParamField body='allowedIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> +> **allowedIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:39 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId.mdx new file mode 100644 index 000000000..81ca680dc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId.mdx @@ -0,0 +1,151 @@ +--- +title: "TransactionMembersOnLoginId" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:31 + +## Extends + +- [`TransactionMembers`](./TransactionMembers) + +## Properties + +<ParamField body='state' type='string'> +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) + +</ParamField> + +<ParamField body='locale' type='string'> +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='countryCode' type='string '> +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string '> +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='connectionStrategy' type='string '> +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='errors' type='[Error](./Error)[] '> +> **errors**: [`Error`](./Error)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='currentConnection' type='[Connection](./Connection) '> +> **currentConnection**: [`Connection`](./Connection) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='alternateConnections' type='([Connection](./Connection) '> +> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='isSignupEnabled' type='boolean'> +> **isSignupEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:32 + +</ParamField> + +<ParamField body='isPasskeyEnabled' type='boolean'> +> **isPasskeyEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:33 + +</ParamField> + +<ParamField body='isForgotPasswordEnabled' type='boolean'> +> **isForgotPasswordEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:34 + +</ParamField> + +<ParamField body='isUsernameRequired' type='boolean'> +> **isUsernameRequired**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:35 + +</ParamField> + +<ParamField body='usernamePolicy' type='[UsernamePolicy](./UsernamePolicy) '> +> **usernamePolicy**: [`UsernamePolicy`](./UsernamePolicy) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:36 + +</ParamField> + +<ParamField body='allowedIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> +> **allowedIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:37 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword.mdx new file mode 100644 index 000000000..2b3ac998b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword.mdx @@ -0,0 +1,164 @@ +--- +title: "TransactionMembersOnLoginPassword" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:23 + +## Extends + +- [`TransactionMembers`](./TransactionMembers) + +## Properties + +<ParamField body='state' type='string'> +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) + +</ParamField> + +<ParamField body='locale' type='string'> +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='countryCode' type='string '> +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string '> +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='connectionStrategy' type='string '> +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='errors' type='[Error](./Error)[] '> +> **errors**: [`Error`](./Error)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='currentConnection' type='[Connection](./Connection) '> +> **currentConnection**: [`Connection`](./Connection) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='alternateConnections' type='([Connection](./Connection) '> +> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='isSignupEnabled' type='boolean'> +> **isSignupEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:24 + +</ParamField> + +<ParamField body='isForgotPasswordEnabled' type='boolean'> +> **isForgotPasswordEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:25 + +</ParamField> + +<ParamField body='isPasskeyEnabled' type='boolean'> +> **isPasskeyEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:26 + +**Methods** +</ParamField> + +<ParamField body='getPasswordPolicy()' type='unknown'> +> **getPasswordPolicy**(): [`PasswordPolicy`](./PasswordPolicy) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:27 + +**Returns** + +[`PasswordPolicy`](./PasswordPolicy) \| `null` + +</ParamField> + +<ParamField body='getUsernamePolicy()' type='unknown'> +> **getUsernamePolicy**(): [`UsernamePolicy`](./UsernamePolicy) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:28 + +**Returns** + +[`UsernamePolicy`](./UsernamePolicy) \| `null` + +</ParamField> + +<ParamField body='getAllowedIdentifiers()' type='unknown'> +> **getAllowedIdentifiers**(): [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:29 + +**Returns** + +[`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx new file mode 100644 index 000000000..c68a96146 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx @@ -0,0 +1,116 @@ +--- +title: "TransactionMembersOnLoginPasswordlessEmailCode" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:15 + +## Extends + +- [`TransactionMembers`](./TransactionMembers) + +## Properties + +<ParamField body='state' type='string'> +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) + +</ParamField> + +<ParamField body='locale' type='string'> +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='countryCode' type='string '> +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string '> +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='connectionStrategy' type='string '> +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='errors' type='[Error](./Error)[] '> +> **errors**: [`Error`](./Error)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='currentConnection' type='[Connection](./Connection) '> +> **currentConnection**: [`Connection`](./Connection) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='alternateConnections' type='([Connection](./Connection) '> +> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='isSignupEnabled' type='boolean '> +> **isSignupEnabled**: `boolean` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:16 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx new file mode 100644 index 000000000..7a571d3a3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx @@ -0,0 +1,116 @@ +--- +title: "TransactionMembersOnLoginPasswordlessSmsOtp" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:22 + +## Extends + +- [`TransactionMembers`](./TransactionMembers) + +## Properties + +<ParamField body='state' type='string'> +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) + +</ParamField> + +<ParamField body='locale' type='string'> +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='countryCode' type='string '> +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string '> +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='connectionStrategy' type='string '> +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='errors' type='[Error](./Error)[] '> +> **errors**: [`Error`](./Error)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='currentConnection' type='[Connection](./Connection) '> +> **currentConnection**: [`Connection`](./Connection) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='alternateConnections' type='([Connection](./Connection) '> +> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='isSignupEnabled' type='boolean'> +> **isSignupEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:23 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword.mdx new file mode 100644 index 000000000..f062f04bd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword.mdx @@ -0,0 +1,116 @@ +--- +title: "TransactionMembersOnResetPassword" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:18 + +## Extends + +- [`TransactionMembers`](./TransactionMembers) + +## Properties + +<ParamField body='state' type='string'> +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) + +</ParamField> + +<ParamField body='locale' type='string'> +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='countryCode' type='string '> +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string '> +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='connectionStrategy' type='string '> +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='errors' type='[Error](./Error)[] '> +> **errors**: [`Error`](./Error)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='currentConnection' type='[Connection](./Connection) '> +> **currentConnection**: [`Connection`](./Connection) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='alternateConnections' type='([Connection](./Connection) '> +> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='passwordPolicy' type='[PasswordPolicy](./PasswordPolicy) '> +> **passwordPolicy**: [`PasswordPolicy`](./PasswordPolicy) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:19 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest.mdx new file mode 100644 index 000000000..1a104b613 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest.mdx @@ -0,0 +1,130 @@ +--- +title: "TransactionMembersOnResetPasswordRequest" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:11 + +## Extends + +- [`TransactionMembers`](./TransactionMembers) + +## Properties + +<ParamField body='state' type='string'> +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) + +</ParamField> + +<ParamField body='locale' type='string'> +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='countryCode' type='string '> +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string '> +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='connectionStrategy' type='string '> +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='errors' type='[Error](./Error)[] '> +> **errors**: [`Error`](./Error)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='currentConnection' type='[Connection](./Connection) '> +> **currentConnection**: [`Connection`](./Connection) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='alternateConnections' type='([Connection](./Connection) '> +> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='allowedIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> +> **allowedIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:12 + +</ParamField> + +<ParamField body='requiredIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> +> **requiredIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:13 + +</ParamField> + +<ParamField body='hasFlexibleIdentifier' type='boolean'> +> **hasFlexibleIdentifier**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:14 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup.mdx new file mode 100644 index 000000000..3055bfc7a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup.mdx @@ -0,0 +1,144 @@ +--- +title: "TransactionMembersOnSignup" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:24 + +## Extends + +- [`TransactionMembers`](./TransactionMembers) + +## Properties + +<ParamField body='state' type='string'> +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) + +</ParamField> + +<ParamField body='locale' type='string'> +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='countryCode' type='string '> +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string '> +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='connectionStrategy' type='string '> +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='errors' type='[Error](./Error)[] '> +> **errors**: [`Error`](./Error)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='currentConnection' type='[Connection](./Connection) '> +> **currentConnection**: [`Connection`](./Connection) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='alternateConnections' type='([Connection](./Connection) '> +> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='isPasskeyEnabled' type='boolean'> +> **isPasskeyEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:25 + +</ParamField> + +<ParamField body='usernamePolicy' type='[UsernamePolicy](./UsernamePolicy) '> +> **usernamePolicy**: [`UsernamePolicy`](./UsernamePolicy) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:26 + +</ParamField> + +<ParamField body='requiredIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> +> **requiredIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:27 + +</ParamField> + +<ParamField body='optionalIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> +> **optionalIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:28 + +</ParamField> + +<ParamField body='passwordPolicy' type='[PasswordPolicy](./PasswordPolicy) '> +> **passwordPolicy**: [`PasswordPolicy`](./PasswordPolicy) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:29 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId.mdx new file mode 100644 index 000000000..7e79cd819 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId.mdx @@ -0,0 +1,137 @@ +--- +title: "TransactionMembersOnSignupId" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:25 + +## Extends + +- [`TransactionMembers`](./TransactionMembers) + +## Properties + +<ParamField body='state' type='string'> +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) + +</ParamField> + +<ParamField body='locale' type='string'> +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='countryCode' type='string '> +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string '> +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='connectionStrategy' type='string '> +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='errors' type='[Error](./Error)[] '> +> **errors**: [`Error`](./Error)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='currentConnection' type='[Connection](./Connection) '> +> **currentConnection**: [`Connection`](./Connection) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='alternateConnections' type='([Connection](./Connection) '> +> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='isPasskeyEnabled' type='boolean'> +> **isPasskeyEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:26 + +</ParamField> + +<ParamField body='usernamePolicy' type='[UsernamePolicy](./UsernamePolicy) '> +> **usernamePolicy**: [`UsernamePolicy`](./UsernamePolicy) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:27 + +</ParamField> + +<ParamField body='requiredIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> +> **requiredIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:28 + +</ParamField> + +<ParamField body='optionalIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> +> **optionalIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:29 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword.mdx new file mode 100644 index 000000000..79db58454 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword.mdx @@ -0,0 +1,137 @@ +--- +title: "TransactionMembersOnSignupPassword" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:33 + +## Extends + +- [`TransactionMembers`](./TransactionMembers) + +## Properties + +<ParamField body='state' type='string'> +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) + +</ParamField> + +<ParamField body='locale' type='string'> +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='countryCode' type='string '> +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string '> +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='connectionStrategy' type='string '> +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='errors' type='[Error](./Error)[] '> +> **errors**: [`Error`](./Error)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='currentConnection' type='[Connection](./Connection) '> +> **currentConnection**: [`Connection`](./Connection) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='alternateConnections' type='([Connection](./Connection) '> +> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 + +**Inherited from** + +[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='isPasskeyEnabled' type='boolean'> +> **isPasskeyEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:34 + +</ParamField> + +<ParamField body='passwordPolicy' type='[PasswordPolicy](./PasswordPolicy) '> +> **passwordPolicy**: [`PasswordPolicy`](./PasswordPolicy) \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:35 + +</ParamField> + +<ParamField body='requiredIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> +> **requiredIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:36 + +</ParamField> + +<ParamField body='optionalIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> +> **optionalIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:37 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx new file mode 100644 index 000000000..a5244ef2b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx @@ -0,0 +1,13 @@ +--- +title: "TryAnotherMethodMfaOtpChallengeOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:34 + +Options for trying another method + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodOptions.mdx new file mode 100644 index 000000000..b98c22622 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodOptions.mdx @@ -0,0 +1,13 @@ +--- +title: "TryAnotherMethodOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:33 + +Options for trying another method. + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodPayloadOptions.mdx new file mode 100644 index 000000000..a6f181513 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodPayloadOptions.mdx @@ -0,0 +1,13 @@ +--- +title: "TryAnotherMethodPayloadOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:44 + +Options for trying another method + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.mdx new file mode 100644 index 000000000..8634eab80 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.mdx @@ -0,0 +1,28 @@ +--- +title: "UntrustedDataMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:13 + +## Extended by + +- [`UntrustedDataMembersOnMfaSmsChallenge`](./UntrustedDataMembersOnMfaSmsChallenge) +- [`UntrustedDataMembersOnMfaEmailChallenge`](./UntrustedDataMembersOnMfaEmailChallenge) +- [`UntrustedDataMembersOnMfaPushChallengePush`](./UntrustedDataMembersOnMfaPushChallengePush) +- [`UntrustedDataMembersOnMfaOtpChallenge`](./UntrustedDataMembersOnMfaOtpChallenge) +- [`UntrustedDataMembersOnMfaVoiceChallenge`](./UntrustedDataMembersOnMfaVoiceChallenge) + +## Properties + +<ParamField body='submittedFormData' type='{[key: string]: string '> +> **submittedFormData**: \{\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `null` \| `undefined`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:14 + +</ParamField> + +<ParamField body='authorizationParams' type='{[key: ext-${string} ]: string; login_hint?: string; screen_hint?: string; ui_locales?: string; } '> +> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:17 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx new file mode 100644 index 000000000..11e0e7fd2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx @@ -0,0 +1,34 @@ +--- +title: "UntrustedDataMembersOnMfaEmailChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:18 + +Interface for untrusted data specific to mfa-email-challenge screen + +## Extends + +- [`UntrustedDataMembers`](./UntrustedDataMembers) + +## Properties + +<ParamField body='authorizationParams' type='{[key: ext-${string} ]: string; login_hint?: string; screen_hint?: string; ui_locales?: string; } '> +> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:17 + +**Inherited from** + +[`UntrustedDataMembers`](./UntrustedDataMembers).[`authorizationParams`](./UntrustedDataMembers.md#authorizationparams) + +</ParamField> + +<ParamField body='submittedFormData' type='{ rememberDevice: boolean; } '> +> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:19 + +**Overrides** + +[`UntrustedDataMembers`](./UntrustedDataMembers).[`submittedFormData`](./UntrustedDataMembers.md#submittedformdata) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx new file mode 100644 index 000000000..f7376753f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx @@ -0,0 +1,34 @@ +--- +title: "UntrustedDataMembersOnMfaOtpChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:15 + +Interface for untrusted data specific to mfa-otp-challenge screen + +## Extends + +- [`UntrustedDataMembers`](./UntrustedDataMembers) + +## Properties + +<ParamField body='authorizationParams' type='{[key: ext-${string} ]: string; login_hint?: string; screen_hint?: string; ui_locales?: string; } '> +> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:17 + +**Inherited from** + +[`UntrustedDataMembers`](./UntrustedDataMembers).[`authorizationParams`](./UntrustedDataMembers.md#authorizationparams) + +</ParamField> + +<ParamField body='submittedFormData' type='{ rememberDevice: boolean; } '> +> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:16 + +**Overrides** + +[`UntrustedDataMembers`](./UntrustedDataMembers).[`submittedFormData`](./UntrustedDataMembers.md#submittedformdata) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx new file mode 100644 index 000000000..0de5591b9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx @@ -0,0 +1,34 @@ +--- +title: "UntrustedDataMembersOnMfaPushChallengePush" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:20 + +Interface for untrusted data specific to mfa-push-challenge-push screen + +## Extends + +- [`UntrustedDataMembers`](./UntrustedDataMembers) + +## Properties + +<ParamField body='authorizationParams' type='{[key: ext-${string} ]: string; login_hint?: string; screen_hint?: string; ui_locales?: string; } '> +> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:17 + +**Inherited from** + +[`UntrustedDataMembers`](./UntrustedDataMembers).[`authorizationParams`](./UntrustedDataMembers.md#authorizationparams) + +</ParamField> + +<ParamField body='submittedFormData' type='{ rememberDevice: boolean; } '> +> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:21 + +**Overrides** + +[`UntrustedDataMembers`](./UntrustedDataMembers).[`submittedFormData`](./UntrustedDataMembers.md#submittedformdata) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx new file mode 100644 index 000000000..4ccf5f0a1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx @@ -0,0 +1,34 @@ +--- +title: "UntrustedDataMembersOnMfaSmsChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:47 + +Interface for untrusted data specific to mfa-sms-challenge screen + +## Extends + +- [`UntrustedDataMembers`](./UntrustedDataMembers) + +## Properties + +<ParamField body='authorizationParams' type='{[key: ext-${string} ]: string; login_hint?: string; screen_hint?: string; ui_locales?: string; } '> +> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:17 + +**Inherited from** + +[`UntrustedDataMembers`](./UntrustedDataMembers).[`authorizationParams`](./UntrustedDataMembers.md#authorizationparams) + +</ParamField> + +<ParamField body='submittedFormData' type='{ rememberDevice: boolean; } '> +> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:48 + +**Overrides** + +[`UntrustedDataMembers`](./UntrustedDataMembers).[`submittedFormData`](./UntrustedDataMembers.md#submittedformdata) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx new file mode 100644 index 000000000..5317cf5d1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx @@ -0,0 +1,34 @@ +--- +title: "UntrustedDataMembersOnMfaVoiceChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:131 + +Interface for untrusted data specific to mfa-voice-challenge screen + +## Extends + +- [`UntrustedDataMembers`](./UntrustedDataMembers) + +## Properties + +<ParamField body='authorizationParams' type='{[key: ext-${string} ]: string; login_hint?: string; screen_hint?: string; ui_locales?: string; } '> +> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:17 + +**Inherited from** + +[`UntrustedDataMembers`](./UntrustedDataMembers).[`authorizationParams`](./UntrustedDataMembers.md#authorizationparams) + +</ParamField> + +<ParamField body='submittedFormData' type='{ rememberDevice: boolean; } '> +> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:132 + +**Overrides** + +[`UntrustedDataMembers`](./UntrustedDataMembers).[`submittedFormData`](./UntrustedDataMembers.md#submittedformdata) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions.mdx new file mode 100644 index 000000000..b8621d009 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions.mdx @@ -0,0 +1,13 @@ +--- +title: "UseErrorOptions" +--- + +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L17) + +## Properties + +<ParamField body='includeDevErrors?' type='boolean'> +> `optional` **includeDevErrors**: `boolean` + +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L18) +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult.mdx new file mode 100644 index 000000000..d8fe741a3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult.mdx @@ -0,0 +1,48 @@ +--- +title: "UseErrorsResult" +--- + +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L21) + +## Properties + +<ParamField body='errors' type='[ErrorsResult](./ErrorsResult)'> +> **errors**: [`ErrorsResult`](./ErrorsResult) + +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L22) + +</ParamField> + +<ParamField body='hasError' type='boolean'> +> **hasError**: `boolean` + +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L23) + +</ParamField> + +<ParamField body='dismiss()' type='(id) => void'> +> **dismiss**: (`id`) => `void` + +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L24) + +**Parameters** + +**id** + +`string` + +**Returns** + +`void` + +</ParamField> + +<ParamField body='dismissAll()' type='() => void'> +> **dismissAll**: () => `void` + +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L25) + +**Returns** + +`void` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions.mdx new file mode 100644 index 000000000..d1f711fb2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions.mdx @@ -0,0 +1,32 @@ +--- +title: "UseResendOptions" +--- + +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L18) + +Optional configuration for [useResend](../../Hooks/functions/useResend). + +## Properties + +<ParamField body='timeoutSeconds?' type='number'> +> `optional` **timeoutSeconds**: `number` + +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L23) + +Countdown duration (in seconds) before another resend is allowed. +Defaults to `10`. + +</ParamField> + +<ParamField body='onTimeout()?' type='() => void'> +> `optional` **onTimeout**: () => `void` + +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L28) + +Callback fired when the countdown finishes and the resend +action becomes available again. + +**Returns** + +`void` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn.mdx new file mode 100644 index 000000000..b042057c6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn.mdx @@ -0,0 +1,39 @@ +--- +title: "UseResendReturn" +--- + +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:8](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L8) + +Return type for [useResend](../../Hooks/functions/useResend). + +## Properties + +<ParamField body='remaining' type='number'> +> **remaining**: `number` + +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:10](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L10) + +Seconds remaining until the next resend attempt is allowed. + +</ParamField> + +<ParamField body='disabled' type='boolean'> +> **disabled**: `boolean` + +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:12](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L12) + +Whether the resend action is currently disabled. + +</ParamField> + +<ParamField body='startResend()' type='() => void'> +> **startResend**: () => `void` + +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:14](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L14) + +Start a resend attempt immediately, if allowed. + +**Returns** + +`void` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers.mdx new file mode 100644 index 000000000..4bf3a5b52 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers.mdx @@ -0,0 +1,90 @@ +--- +title: "UserMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:34 + +## Properties + +<ParamField body='id' type='string '> +> **id**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:35 + +</ParamField> + +<ParamField body='email' type='string '> +> **email**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:36 + +</ParamField> + +<ParamField body='username' type='string '> +> **username**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:37 + +</ParamField> + +<ParamField body='phoneNumber' type='string '> +> **phoneNumber**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:38 + +</ParamField> + +<ParamField body='picture' type='string '> +> **picture**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:39 + +</ParamField> + +<ParamField body='enrolledFactors' type='string[] '> +> **enrolledFactors**: `string`[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:40 + +</ParamField> + +<ParamField body='enrolledEmails' type='[EnrolledEmail](./EnrolledEmail)[] '> +> **enrolledEmails**: [`EnrolledEmail`](./EnrolledEmail)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:41 + +</ParamField> + +<ParamField body='enrolledPhoneNumbers' type='[EnrolledPhoneNumber](./EnrolledPhoneNumber)[] '> +> **enrolledPhoneNumbers**: [`EnrolledPhoneNumber`](./EnrolledPhoneNumber)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:42 + +</ParamField> + +<ParamField body='enrolledDevices' type='[EnrolledDevice](./EnrolledDevice)[] '> +> **enrolledDevices**: [`EnrolledDevice`](./EnrolledDevice)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:43 + +</ParamField> + +<ParamField body='organizations' type='[Organizations](./Organizations)[] '> +> **organizations**: [`Organizations`](./Organizations)[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:44 + +</ParamField> + +<ParamField body='userMetadata' type='{[key: string]: string; } '> +> **userMetadata**: \{\[`key`: `string`\]: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:45 + +</ParamField> + +<ParamField body='appMetadata' type='{[key: string]: string; } '> +> **appMetadata**: \{\[`key`: `string`\]: `string`; \} \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:48 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy.mdx new file mode 100644 index 000000000..3687e45f2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy.mdx @@ -0,0 +1,42 @@ +--- +title: "UsernamePolicy" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:42 + +## Properties + +<ParamField body='isActive?' type='boolean'> +> `optional` **isActive**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:43 + +</ParamField> + +<ParamField body='maxLength' type='number'> +> **maxLength**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:44 + +</ParamField> + +<ParamField body='minLength' type='number'> +> **minLength**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:45 + +</ParamField> + +<ParamField body='allowedFormats?' type='object'> +> `optional` **allowedFormats**: `object` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:46 + +**usernameInEmailFormat?** + +> `optional` **usernameInEmailFormat**: `boolean` + +**usernameInPhoneFormat?** + +> `optional` **usernameInPhoneFormat**: `boolean` +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationError.mdx new file mode 100644 index 000000000..bd27df0d8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationError.mdx @@ -0,0 +1,41 @@ +--- +title: "UsernameValidationError" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/validate-username.d.ts:6 + +Represents a single username validation error returned during validation. + +Each error has a machine-readable `code` and a human-readable `message`. + +## Properties + +<ParamField body='code' type='string'> +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/validate-username.d.ts:12 + +A unique identifier for the validation rule that failed. + +Example: `"username-too-short"`, `"username-invalid-characters"` + +</ParamField> + +<ParamField body='message' type='string'> +> **message**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/validate-username.d.ts:18 + +A human-readable description of the error. + +Example: `"Username must be at least 3 characters long."` + +</ParamField> + +<ParamField body='field' type='string'> +> **field**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/validate-username.d.ts:22 + +The field associated with the validation error, typically "username", "email", or "phone". +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult.mdx new file mode 100644 index 000000000..9f89130fe --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult.mdx @@ -0,0 +1,29 @@ +--- +title: "UsernameValidationResult" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/validate-username.d.ts:27 + +The result of validating a username against one or more rules. + +## Properties + +<ParamField body='isValid' type='boolean'> +> **isValid**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/validate-username.d.ts:31 + +Indicates whether the username passed all validation rules. + +</ParamField> + +<ParamField body='errors' type='[UsernameValidationError](./UsernameValidationError)[]'> +> **errors**: [`UsernameValidationError`](./UsernameValidationError)[] + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/validate-username.d.ts:38 + +An array of [UsernameValidationError](./UsernameValidationError) objects representing +the individual rules that failed, if any. + +This array is empty if [UsernameValidationResult.isValid](#isvalid) is `true`. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions.mdx new file mode 100644 index 000000000..2ff324e64 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions.mdx @@ -0,0 +1,26 @@ +--- +title: "VerifyPlatformAuthenticatorOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:37 + +VerifyPlatformAuthenticatorOptions + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='rememberDevice?' type='boolean'> +> `optional` **rememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:43 + +Optional. If true, attempts to remember the browser for future MFA challenges. +Corresponds to the `rememberBrowser` form field. This is only applicable if `screen.showRememberDevice` is true. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions.mdx new file mode 100644 index 000000000..877e7a560 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions.mdx @@ -0,0 +1,26 @@ +--- +title: "VerifySecurityKeyOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:29 + +VerifySecurityKeyOptions + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='rememberDevice?' type='boolean'> +> `optional` **rememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:30 + +Optional. If true, attempts to remember the browser for future MFA challenges. +Corresponds to the `rememberBrowser` form field. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx new file mode 100644 index 000000000..855d0d62c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx @@ -0,0 +1,15 @@ +--- +title: "WebAuthnEnrollSuccessContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-enrollment-success.d.ts:45 + +ContinueOptions + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails.mdx new file mode 100644 index 000000000..dc285b765 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails.mdx @@ -0,0 +1,32 @@ +--- +title: "WebAuthnErrorDetails" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:8 + +Details of a WebAuthn browser error. + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional error properties. + +## Properties + +<ParamField body='name' type='string'> +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:12 + +The name of the error (e.g., "NotAllowedError"). + +</ParamField> + +<ParamField body='message' type='string'> +> **message**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:16 + +The error message. +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions.mdx new file mode 100644 index 000000000..e9ded993e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions.mdx @@ -0,0 +1,21 @@ +--- +title: "WithRememberOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:25 + +## Extends + +- [`CustomOptions`](./CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='rememberDevice?' type='boolean'> +> `optional` **rememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:26 +</ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/AuthenticatorTransport.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/AuthenticatorTransport.mdx new file mode 100644 index 000000000..5a8dfc366 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/AuthenticatorTransport.mdx @@ -0,0 +1,7 @@ +--- +title: "Type Alias: AuthenticatorTransport" +--- + +> **AuthenticatorTransport** = `"usb"` \| `"nfc"` \| `"ble"` \| `"internal"` \| `"hybrid"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:7 \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind.mdx new file mode 100644 index 000000000..39d329ac2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind.mdx @@ -0,0 +1,7 @@ +--- +title: "Type Alias: ErrorKind" +--- + +> **ErrorKind** = `"server"` \| `"client"` \| `"developer"` + +Defined in: [packages/auth0-acul-react/src/state/error-store.ts:9](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/state/error-store.ts#L9) \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType.mdx new file mode 100644 index 000000000..16d331b04 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType.mdx @@ -0,0 +1,9 @@ +--- +title: "Type Alias: IdentifierType" +--- + +> **IdentifierType** = `"phone"` \| `"email"` \| `"username"` + +Defined in: packages/auth0-acul-js/dist/types/src/constants/identifiers.d.ts:18 + +Type representing valid identifier values \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaEnrollFactorType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaEnrollFactorType.mdx new file mode 100644 index 000000000..e876e84ea --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaEnrollFactorType.mdx @@ -0,0 +1,9 @@ +--- +title: "Type Alias: MfaEnrollFactorType" +--- + +> **MfaEnrollFactorType** = `"push-notification"` \| `"otp"` \| `"sms"` \| `"phone"` \| `"voice"` \| `"webauthn-roaming"` + +Defined in: packages/auth0-acul-js/dist/types/src/constants/mfa-factors.d.ts:36 + +Type definition for MFA enroll factor constants \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaLoginFactorType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaLoginFactorType.mdx new file mode 100644 index 000000000..a6cdd9157 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaLoginFactorType.mdx @@ -0,0 +1,9 @@ +--- +title: "Type Alias: MfaLoginFactorType" +--- + +> **MfaLoginFactorType** = `"push-notification"` \| `"otp"` \| `"sms"` \| `"phone"` \| `"voice"` \| `"email"` \| `"recovery-code"` \| `"webauthn-roaming"` \| `"webauthn-platform"` \| `"duo"` + +Defined in: packages/auth0-acul-js/dist/types/src/constants/mfa-factors.d.ts:20 + +Type definition for MFA login factor constants \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions.mdx new file mode 100644 index 000000000..69f7f270f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions.mdx @@ -0,0 +1,76 @@ +--- +title: "Type Alias: MfaPollingOptions" +--- + +> **MfaPollingOptions** = `object` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/polling-control.d.ts:10 + +Configuration options for managing an MFA push-notification polling process. + +Supply these options when starting a polling session to control how often +the challenge endpoint is queried and how success or failure is handled. + +## Properties + +### intervalMs? + +> `optional` **intervalMs**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/polling-control.d.ts:19 + +Optional interval, in **milliseconds**, between consecutive polling requests. + +- If omitted, the SDK’s internal default interval is used (typically 5000 ms). +- Choose a value that balances responsiveness with rate-limit considerations. + +#### Default Value + +```ts +Implementation-specific (commonly 5000 ms) +``` + +*** + +### onCompleted()? + +> `optional` **onCompleted**: () => `void` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/polling-control.d.ts:27 + +Optional callback executed once the MFA push challenge is successfully +approved and polling completes. + +- Called exactly **once**, after which polling stops automatically. +- Useful for advancing the login flow (e.g., calling `continue()`). + +#### Returns + +`void` + +*** + +### onError()? + +> `optional` **onError**: (`error`) => `void` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/polling-control.d.ts:38 + +Optional callback invoked if an error occurs while polling. + +Receives an [ULError](../interfaces/Error) object containing: +- `status` — the HTTP status code from the failed request +- `responseText` — the raw response body, if available + +- Called once per error event; polling may retry depending on error type. +- Use to surface error messages or trigger custom retry/abort logic. + +#### Parameters + +##### error + +[`Error`](../interfaces/Error) + +#### Returns + +`void` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/OnStatusChangeCallback.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/OnStatusChangeCallback.mdx new file mode 100644 index 000000000..0ab789504 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/OnStatusChangeCallback.mdx @@ -0,0 +1,27 @@ +--- +title: "Type Alias: OnStatusChangeCallback" +--- + +> **OnStatusChangeCallback** = (`remainingSeconds`, `isDisabled`) => `void` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/resend-control.d.ts:6 + +Callback function for status changes during resend countdown. + +## Parameters + +### remainingSeconds + +`number` + +Number of seconds remaining in the countdown + +### isDisabled + +`boolean` + +Whether the resend functionality is currently disabled + +## Returns + +`void` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ScreenIdentifierType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ScreenIdentifierType.mdx new file mode 100644 index 000000000..66c2d12ff --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ScreenIdentifierType.mdx @@ -0,0 +1,22 @@ +--- +title: "Type Alias: ScreenIdentifierType" +--- + +> **ScreenIdentifierType** = `"email"` \| `"phone"` \| `"username"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/signup-identifiers.d.ts:16 + +Represents the types of user identifiers that can be used during signup. + +- `'email'`: The user will provide an email address. +- `'phone'`: The user will provide a phone number. +- `'username'`: The user will choose a username. + +This type is typically used in identity selection or signup flows +to define which identifiers are enabled and how they behave. + +## Example + +```ts +const type: IdentifierType = 'email'; +``` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType.mdx new file mode 100644 index 000000000..cc30a7dbd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType.mdx @@ -0,0 +1,7 @@ +--- +title: "Type Alias: WebAuthnType" +--- + +> **WebAuthnType** = `"webauthn-roaming"` \| `"webauthn-platform"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-error.d.ts:10 \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/index.mdx new file mode 100644 index 000000000..b93ea04e9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/index.mdx @@ -0,0 +1,9 @@ +--- +title: "API Reference" +--- + +## Namespaces + +- [Hooks](./namespaces/Hooks) +- [Screens](./namespaces/Screens) +- [Types](./namespaces/Types) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/README.md b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/README.md deleted file mode 100644 index d8fced167..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/README.md +++ /dev/null @@ -1,50 +0,0 @@ -# Auth0 ACUL React Documentation - -Generated on 11/12/2025, 2:23:00 PM - -## Classes (2) - -- [ErrorStore](./classes/ErrorStore.mdx) -- [ContextHooks](./classes/ContextHooks.mdx) - -## Interfaces (12) - -- [ErrorsResult](./interfaces/ErrorsResult.mdx) -- [UseErrorOptions](./interfaces/UseErrorOptions.mdx) -- [UseErrorsResult](./interfaces/UseErrorsResult.mdx) -- [WithLoginIdentifiers](./interfaces/WithLoginIdentifiers.mdx) -- [MfaPollingResult](./interfaces/MfaPollingResult.mdx) -- [UseResendReturn](./interfaces/UseResendReturn.mdx) -- [UseResendOptions](./interfaces/UseResendOptions.mdx) -- [WithResendManager](./interfaces/WithResendManager.mdx) -- [WithSignupIdentifiers](./interfaces/WithSignupIdentifiers.mdx) -- [WithValidatePassword](./interfaces/WithValidatePassword.mdx) -- ... and 2 more - -## Functions (243) - -- [classifyKind](./functions/classifyKind.mdx) -- [toErrorObject](./functions/toErrorObject.mdx) -- [filterByField](./functions/filterByField.mdx) -- [withError](./functions/withError.mdx) -- [listsEqual](./functions/listsEqual.mdx) -- [registerScreen](./functions/registerScreen.mdx) -- [getScreen](./functions/getScreen.mdx) -- [clearScreen](./functions/clearScreen.mdx) -- [acceptInvitation](./functions/acceptInvitation.mdx) -- [useAcceptInvitation](./functions/useAcceptInvitation.mdx) -- ... and 233 more - -## Screens (76) - -- [accept-invitation](./screens/accept-invitation.mdx) -- [consent](./screens/consent.mdx) -- [customized-consent](./screens/customized-consent.mdx) -- [device-code-activation-allowed](./screens/device-code-activation-allowed.mdx) -- [device-code-activation-denied](./screens/device-code-activation-denied.mdx) -- [device-code-activation](./screens/device-code-activation.mdx) -- [device-code-confirmation](./screens/device-code-confirmation.mdx) -- [email-identifier-challenge](./screens/email-identifier-challenge.mdx) -- [email-otp-challenge](./screens/email-otp-challenge.mdx) -- [email-verification-result](./screens/email-verification-result.mdx) -- ... and 66 more diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ContextHooks.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ContextHooks.mdx deleted file mode 100644 index acc179d11..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ContextHooks.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "ContextHooks" -description: "Factory class that creates context hooks for accessing Auth0 Universal Login data. These hooks provide access to various aspects of the authentication flow and tenant configuration." ---- - -## Properties - -<ParamField path="useUser" type={<span>any</span>} required> - Hook to access user information and profile data. -</ParamField> - -<ParamField path="useTenant" type={<span>any</span>} required> - Hook to access tenant configuration and settings. -</ParamField> - -<ParamField path="useBranding" type={<span>any</span>} required> - Hook to access branding and theme configuration. -</ParamField> - -<ParamField path="useClient" type={<span>any</span>} required> - Hook to access Auth0 application (client) configuration. -</ParamField> - -<ParamField path="useOrganization" type={<span>any</span>} required> - Hook to access organization context and settings. -</ParamField> - -<ParamField path="usePrompt" type={<span>any</span>} required> - Hook to access prompt configuration and flow settings. -</ParamField> - -<ParamField path="useUntrustedData" type={<span>any</span>} required> - Hook to access untrusted data from URL parameters and form submissions. -</ParamField> - -<ParamField path="useScreen" type={<span>any</span>} required> - Hook to access current screen information and metadata. -</ParamField> - -<ParamField path="useTransaction" type={<span>any</span>} required> - Hook to access transaction state and authentication flow data. -</ParamField> - ---- - -**File:** [src/hooks/context/index.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/context/index.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ErrorStore.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ErrorStore.mdx deleted file mode 100644 index 16bc2c94d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ErrorStore.mdx +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "ErrorStore" -description: "Global error store for ACUL (one screen per page). - Holds a single bucket of errors across the current page. - Generates stable ids for every inserted error. - Emits immutable snapshots to subscribers." ---- - -## Properties - -<ParamField path="bucket" type={<span>Bucket</span>} required> -</ParamField> - -<ParamField path="listeners" type={<span>Set<Listener></span>} required> -</ParamField> - -## Methods - -<ParamField path="subscribe" type={<span>() => void</span>}> - <Expandable title="parameters"> - <ParamField path="cb" type={<span>Listener</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="snapshot" type={<span>Readonly<Bucket></span>}> -</ParamField> - -<ParamField path="normalize" type={<span>ReadonlyArray<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>}> - Add ids and freeze an array of ErrorItem-like objects. - - <Expandable title="parameters"> - <ParamField path="list" type={<span>Array<Omit<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>, 'id'> & { id?: string }></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="replace" type={<span>void</span>}> - Replace an entire kind with a new list (generating ids if needed). - - <Expandable title="parameters"> - <ParamField path="kind" type={<span>ErrorKind</span>} required> - </ParamField> - <ParamField path="list" type={<span>Array<Omit<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>, 'id'> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="replacePartial" type={<span>void</span>}> - Replace only errors for a specific field within a kind. - Keeps all existing errors for other fields. - Normalizes incoming errors and replaces matching field ones. - - <Expandable title="parameters"> - <ParamField path="kind" type={<span>ErrorKind</span>} required> - </ParamField> - <ParamField path="list" type={<span>Array<Omit<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>, 'id'> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>} required> - </ParamField> - <ParamField path="field" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="push" type={<span>void</span>}> - Append one or more items to a kind. - - <Expandable title="parameters"> - <ParamField path="kind" type={<span>ErrorKind</span>} required> - </ParamField> - <ParamField path="list" type={<span>Omit<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>, 'id'> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a> | Array<Omit<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>, 'id'> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="clear" type={<span>void</span>}> - Clear one or more kinds (default: all kinds). - - <Expandable title="parameters"> - <ParamField path="kinds" type={<span>ErrorKind[]</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="remove" type={<span>void</span>}> - Remove errors that match a given id or predicate from specified kinds. - - <Expandable title="parameters"> - <ParamField path="kinds" type={<span>ErrorKind[]</span>} required> - </ParamField> - <ParamField path="test" type={<span>string | ((e: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>) => boolean)</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="notify" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/state/error-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/error-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/abortPasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/abortPasskeyEnrollment.mdx deleted file mode 100644 index 04c51036b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/abortPasskeyEnrollment.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "abortPasskeyEnrollment" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/passkey-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/accept.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/accept.mdx deleted file mode 100644 index 1d12e8afe..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/accept.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "accept" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/customized-consent.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/customized-consent.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/acceptInvitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/acceptInvitation.mdx deleted file mode 100644 index a0ad028b3..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/acceptInvitation.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "acceptInvitation" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/accept-invitation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/accept-invitation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backAction.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backAction.mdx deleted file mode 100644 index 979802cde..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backAction.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "backAction" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-sms-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backToLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backToLogin.mdx deleted file mode 100644 index 1e7348bd8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backToLogin.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "backToLogin" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-request.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-request.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/cancel.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/cancel.mdx deleted file mode 100644 index 1520c6acc..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/cancel.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "cancel" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/device-code-confirmation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/classifyKind.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/classifyKind.mdx deleted file mode 100644 index 8b12a8e94..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/classifyKind.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "classifyKind" -description: "" ---- - -## Parameters - -<ParamField path="e" type={<span>unknown</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>ErrorKind | null</span>}> -</ParamField> - ---- - -**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/clearScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/clearScreen.mdx deleted file mode 100644 index 1570e47e6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/clearScreen.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "clearScreen" -description: "Clear the current instance." ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/state/instance-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/instance-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirm.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirm.mdx deleted file mode 100644 index 1b4c98667..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirm.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "confirm" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/device-code-confirmation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirmLogout.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirmLogout.mdx deleted file mode 100644 index 9455b1e44..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirmLogout.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "confirmLogout" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>ConfirmLogoutOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/logout.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/logout.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueEnrollment.mdx deleted file mode 100644 index 03e34363f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueEnrollment.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "continueEnrollment" -description: "" ---- - -## Parameters - -<ParamField path="payload" type="object" required> - <Expandable title="properties"> - <ParamField path="phone" type={<span>string</span>} required> - </ParamField> - <ParamField path="captcha" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-sms-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod.mdx deleted file mode 100644 index b784bb8b0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "continueMethod" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>ContinueOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMfaSmsChallenge.mdx deleted file mode 100644 index a65c3902c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMfaSmsChallenge.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "continueMfaSmsChallenge" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>MfaSmsChallengeOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-sms-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePasskeyEnrollment.mdx deleted file mode 100644 index 3d79e895c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePasskeyEnrollment.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "continuePasskeyEnrollment" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/passkey-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePhoneEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePhoneEnrollment.mdx deleted file mode 100644 index 5cb45e88f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePhoneEnrollment.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "continuePhoneEnrollment" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>PhoneEnrollmentOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/phone-identifier-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithCode.mdx deleted file mode 100644 index d49be72c5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithCode.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "continueWithCode" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>ContinueWithCodeOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/login-email-verification.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-email-verification.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithNewNickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithNewNickname.mdx deleted file mode 100644 index 4e906bb6d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithNewNickname.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "continueWithNewNickname" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>ContinueOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-change-key-nickname.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithOrganizationName.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithOrganizationName.mdx deleted file mode 100644 index f4032c0e9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithOrganizationName.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "continueWithOrganizationName" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>ContinueWithOrganizationNameOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/organization-selection.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/organization-selection.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithPasskey.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithPasskey.mdx deleted file mode 100644 index 7744102f7..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithPasskey.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "continueWithPasskey" -description: "" ---- - -## Parameters - -<ParamField path="options" type={<span>ContinueWithPasskeyOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-webauthn-platform-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/deny.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/deny.mdx deleted file mode 100644 index 4dfd1d4d2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/deny.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "deny" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/customized-consent.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/customized-consent.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/detectCapabilities.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/detectCapabilities.mdx deleted file mode 100644 index 25ebdba4b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/detectCapabilities.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "detectCapabilities" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-detect-browser-capabilities.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll.mdx deleted file mode 100644 index eefd3194d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "enroll" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-roaming-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enterCodeManually.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enterCodeManually.mdx deleted file mode 100644 index 2041f17b2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enterCodeManually.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "enterCodeManually" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-push-challenge-push.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin.mdx deleted file mode 100644 index 78126f05a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "federatedLogin" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>FederatedLoginOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/login.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup.mdx deleted file mode 100644 index 46bab7926..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "federatedSignup" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>FederatedSignupOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/signup.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/filterByField.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/filterByField.mdx deleted file mode 100644 index a4e8bf3c5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/filterByField.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "filterByField" -description: "" ---- - -## Parameters - -<ParamField path="list" type={<span>ReadonlyArray<T></span>} required> -</ParamField> - -<ParamField path="field" type={<span>string</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>ReadonlyArray<T></span>}> -</ParamField> - ---- - -**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getACall.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getACall.mdx deleted file mode 100644 index 09c2e5d39..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getACall.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getACall" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-sms-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getScreen.mdx deleted file mode 100644 index dba6bab89..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getScreen.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "getScreen" -description: "Get the current screen instance (throws if not initialized)." ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>T</span>}> -</ParamField> - ---- - -**File:** [src/state/instance-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/instance-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack.mdx deleted file mode 100644 index 7847a8094..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "goBack" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-push-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/listsEqual.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/listsEqual.mdx deleted file mode 100644 index 7b2a9b0cd..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/listsEqual.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "listsEqual" -description: "Compare two error lists by id only for maximal speed." ---- - -## Parameters - -<ParamField path="a" type={<span>ReadonlyArray<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>} required> -</ParamField> - -<ParamField path="b" type={<span>ReadonlyArray<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/state/error-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/error-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login.mdx deleted file mode 100644 index d223b3da0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "login" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>LoginOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/login.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/noThanks.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/noThanks.mdx deleted file mode 100644 index 57b0709d5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/noThanks.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "noThanks" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/passkeyLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/passkeyLogin.mdx deleted file mode 100644 index f388a4f19..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/passkeyLogin.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "passkeyLogin" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/login-id.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-id.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickAuthenticator.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickAuthenticator.mdx deleted file mode 100644 index 8f21c0f5d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickAuthenticator.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "pickAuthenticator" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-push-welcome.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode.mdx deleted file mode 100644 index 6e6176168..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "pickCountryCode" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/signup.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickEmail.mdx deleted file mode 100644 index 38c9bbb21..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickEmail.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "pickEmail" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-email-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickPhone.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickPhone.mdx deleted file mode 100644 index b55677a2c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickPhone.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "pickPhone" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickSms.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickSms.mdx deleted file mode 100644 index 827d5ebaf..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickSms.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "pickSms" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-sms-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/refuseEnrollmentOnThisDevice.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/refuseEnrollmentOnThisDevice.mdx deleted file mode 100644 index 0ded85af7..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/refuseEnrollmentOnThisDevice.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "refuseEnrollmentOnThisDevice" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-platform-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/registerScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/registerScreen.mdx deleted file mode 100644 index 2e9f133c8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/registerScreen.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "registerScreen" -description: "Register a screen class. If its identifier matches the current screen, instantiate it immediately and store as the singleton. Returns the instance if created, or null otherwise." ---- - -## Parameters - -<ParamField path="Constructor" type={<span>ScreenConstructor<T></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>T | null</span>}> -</ParamField> - ---- - -**File:** [src/state/instance-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/instance-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError.mdx deleted file mode 100644 index 4acb62e69..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "reportBrowserError" -description: "" ---- - -## Parameters - -<ParamField path="options" type={<span>ReportBrowserErrorOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-webauthn-platform-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportWebAuthnError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportWebAuthnError.mdx deleted file mode 100644 index b696b7eaf..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportWebAuthnError.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "reportWebAuthnError" -description: "" ---- - -## Parameters - -<ParamField path="options" type={<span>ReportWebAuthnErrorOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode.mdx deleted file mode 100644 index d8f74622b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "resendCode" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendEmail.mdx deleted file mode 100644 index 50293253a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendEmail.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "resendEmail" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-email.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-email.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendOTP.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendOTP.mdx deleted file mode 100644 index f78a6c90c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendOTP.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "resendOTP" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/login-passwordless-sms-otp.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendPushNotification.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendPushNotification.mdx deleted file mode 100644 index 4bd7555eb..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendPushNotification.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "resendPushNotification" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-push-challenge-push.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resetPassword.mdx deleted file mode 100644 index 3688b2125..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resetPassword.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "resetPassword" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>ResetPasswordOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious.mdx deleted file mode 100644 index f0292279a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "returnToPrevious" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/phone-identifier-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectCountryCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectCountryCode.mdx deleted file mode 100644 index 5eb0ab928..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectCountryCode.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "selectCountryCode" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>SelectCountryCodeOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-country-codes.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaEmail.mdx deleted file mode 100644 index 84b6b10ff..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaEmail.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "selectMfaEmail" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>SelectMfaEmailOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-email-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-email-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaPushDevice.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaPushDevice.mdx deleted file mode 100644 index d445cdb0e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaPushDevice.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "selectMfaPushDevice" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>SelectMfaPushDeviceOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-push-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectOrganization.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectOrganization.mdx deleted file mode 100644 index a9fa90ced..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectOrganization.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "selectOrganization" -description: "" ---- - -## Parameters - -<ParamField path="payload" type="object" required> - <Expandable title="properties"> - <ParamField path="organization" type={<span>string</span>} required> - </ParamField> - <ParamField path="state" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/organization-picker.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/organization-picker.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneCountryCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneCountryCode.mdx deleted file mode 100644 index 43e36901f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneCountryCode.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "selectPhoneCountryCode" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-voice-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneNumber.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneNumber.mdx deleted file mode 100644 index c6ecb6846..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneNumber.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "selectPhoneNumber" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>MfaSmsListOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-sms-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/showError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/showError.mdx deleted file mode 100644 index 36f64301b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/showError.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "showError" -description: "" ---- - -## Parameters - -<ParamField path="options" type={<span>ShowErrorOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup.mdx deleted file mode 100644 index 04edf2c80..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "signup" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>SignupOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/signup.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/skipOrganizationSelection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/skipOrganizationSelection.mdx deleted file mode 100644 index 2573e6634..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/skipOrganizationSelection.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "skipOrganizationSelection" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/organization-picker.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/organization-picker.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/snoozeEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/snoozeEnrollment.mdx deleted file mode 100644 index d14ce986b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/snoozeEnrollment.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "snoozeEnrollment" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-platform-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitCode.mdx deleted file mode 100644 index bb5b5c33d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitCode.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "submitCode" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>SubmitCodeOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/login-passwordless-email-code.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitEmailChallenge.mdx deleted file mode 100644 index 4e1b0cdc8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitEmailChallenge.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "submitEmailChallenge" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>EmailChallengeOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/email-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitOTP.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitOTP.mdx deleted file mode 100644 index d9a1eb3d0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitOTP.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "submitOTP" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>SubmitOTPOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/login-passwordless-sms-otp.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPasskeyCredential.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPasskeyCredential.mdx deleted file mode 100644 index d0f79fff2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPasskeyCredential.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "submitPasskeyCredential" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>SubmitPasskeyCredentialOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-platform-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPhoneChallenge.mdx deleted file mode 100644 index 2dc682839..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPhoneChallenge.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "submitPhoneChallenge" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>PhoneChallengeOptions</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/phone-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToSms.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToSms.mdx deleted file mode 100644 index cd2d866ba..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToSms.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "switchToSms" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToText.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToText.mdx deleted file mode 100644 index f23de4812..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToText.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "switchToText" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/phone-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToVoice.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToVoice.mdx deleted file mode 100644 index 04d01dfcc..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToVoice.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "switchToVoice" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/phone-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toErrorObject.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toErrorObject.mdx deleted file mode 100644 index c52b70a2e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toErrorObject.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "toErrorObject" -description: "" ---- - -## Parameters - -<ParamField path="e" type={<span>unknown</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>Omit<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>, 'id'></span>}> -</ParamField> - ---- - -**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toggleView.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toggleView.mdx deleted file mode 100644 index 1b3590552..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toggleView.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "toggleView" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-otp-enrollment-qr.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAgain.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAgain.mdx deleted file mode 100644 index 0f85bc240..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAgain.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "tryAgain" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod.mdx deleted file mode 100644 index 1cdaef2a2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "tryAnotherMethod" -description: "" ---- - -## Parameters - -<ParamField path="options" type={<span>TryAnotherMethodOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAcceptInvitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAcceptInvitation.mdx deleted file mode 100644 index bdda39ec4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAcceptInvitation.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useAcceptInvitation" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>AcceptInvitationMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/accept-invitation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/accept-invitation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAuth0Themes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAuth0Themes.mdx deleted file mode 100644 index 9d3ca6836..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAuth0Themes.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useAuth0Themes" -description: "React hook to get the current theme options with flattened configuration from branding context." ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>FlattenedTheme | null</span>}> -</ParamField> - ---- - -**File:** [src/hooks/common/auth0-themes.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/auth0-themes.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useConsent.mdx deleted file mode 100644 index 84dab8e01..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useConsent.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useConsent" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>ConsentMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/consent.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/consent.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCurrentScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCurrentScreen.mdx deleted file mode 100644 index ec86f1611..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCurrentScreen.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useCurrentScreen" -description: "React hook that gets the current screen context and state. This hook provides access to client configuration, organization details, screen identification, tenant settings, transaction state, and authorization parameters for building custom authentication UI. ## Return Value Returns `CurrentScreenOptions` object with the following properties, or `null` if unavailable: - **`client`** - Application identifier and metadata - **`organization`** - Organization ID and metadata (for Auth0 Organizations) - **`prompt`** - Current prompt name (e.g., \"login\", \"consent\", \"mfa\") - **`screen`** - Current screen name (e.g., \"login-id\", \"login-password\", \"mfa-otp-challenge\") - **`tenant`** - Tenant configuration including enabled locales - **`transaction`** - Transaction state, errors array, and current locale - **`untrustedData`** - Authorization parameters from the client (validate before use) ## Key Points - Use `screen.name` for conditional rendering of authentication screens - Always use optional chaining (`?.`) as nested properties can be `null` - Check `transaction.errors` for displaying validation errors - Access `organization.metadata` for organization-specific branding" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>CurrentScreenOptions | null</span>}> -</ParamField> - ---- - -**File:** [src/hooks/common/current-screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/current-screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCustomizedConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCustomizedConsent.mdx deleted file mode 100644 index 15d4f0dd5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCustomizedConsent.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useCustomizedConsent" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>CustomizedConsentMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/customized-consent.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/customized-consent.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivation.mdx deleted file mode 100644 index 0ba37a876..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivation.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useDeviceCodeActivation" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>DeviceCodeActivationMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/device-code-activation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-activation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationAllowed.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationAllowed.mdx deleted file mode 100644 index b29f0d7c9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationAllowed.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useDeviceCodeActivationAllowed" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>DeviceCodeActivationAllowedMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/device-code-activation-allowed.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationDenied.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationDenied.mdx deleted file mode 100644 index 9af80795c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationDenied.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useDeviceCodeActivationDenied" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>DeviceCodeActivationDeniedMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/device-code-activation-denied.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeConfirmation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeConfirmation.mdx deleted file mode 100644 index 0e72f5016..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeConfirmation.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useDeviceCodeConfirmation" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>DeviceCodeConfirmationMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/device-code-confirmation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailIdentifierChallenge.mdx deleted file mode 100644 index df729a06b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailIdentifierChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useEmailIdentifierChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>EmailIdentifierChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/email-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailOTPChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailOTPChallenge.mdx deleted file mode 100644 index 7a42e2c23..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailOTPChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useEmailOTPChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>EmailOTPChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/email-otp-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailVerificationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailVerificationResult.mdx deleted file mode 100644 index 9f60af9d6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailVerificationResult.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useEmailVerificationResult" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>EmailVerificationResultMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/email-verification-result.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/email-verification-result.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useErrors.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useErrors.mdx deleted file mode 100644 index b34ddc4ca..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useErrors.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "useErrors" -description: "React hook for reading and managing errors in ACUL (Advanced Customization of Universal Login). With all validation and server-side errors. It groups errors into three kinds: - `server` — errors returned by Auth0 or your own backend. - `client` — errors from client-side validation (e.g., invalid form input). - `developer` — errors caused by incorrect integration or SDK misuse." ---- - -## Parameters - -<ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorOptions">UseErrorOptions</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorsResult">UseErrorsResult</a></span>}> -</ParamField> - ---- - -**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useInterstitialCaptcha.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useInterstitialCaptcha.mdx deleted file mode 100644 index a7cb99217..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useInterstitialCaptcha.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useInterstitialCaptcha" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>InterstitialCaptchaMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/interstitial-captcha.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogin.mdx deleted file mode 100644 index cbda1f214..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogin.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useLogin" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>LoginMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/login.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginEmailVerification.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginEmailVerification.mdx deleted file mode 100644 index 5a3eaf823..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginEmailVerification.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useLoginEmailVerification" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>LoginEmailVerificationMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/login-email-verification.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-email-verification.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginId.mdx deleted file mode 100644 index 69677d85c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginId.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useLoginId" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>LoginIdMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/login-id.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-id.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginIdentifiers.mdx deleted file mode 100644 index e4b148da9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginIdentifiers.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useLoginIdentifiers" -description: "Returns a list of active identifier types (such as `'email'`, `'phone'`, or `'username'`) currently in use in the authentication flow or login process." ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>IdentifierType[]</span>}> -</ParamField> - ---- - -**File:** [src/hooks/utility/login-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/login-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPassword.mdx deleted file mode 100644 index 596d57222..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPassword.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useLoginPassword" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>LoginPasswordMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/login-password.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-password.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessEmailCode.mdx deleted file mode 100644 index 439e3e16e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessEmailCode.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useLoginPasswordlessEmailCode" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>LoginPasswordlessEmailCodeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/login-passwordless-email-code.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessSmsOtp.mdx deleted file mode 100644 index 1767723fe..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessSmsOtp.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useLoginPasswordlessSmsOtp" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>LoginPasswordlessSmsOtpMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/login-passwordless-sms-otp.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogout.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogout.mdx deleted file mode 100644 index 34581fd40..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogout.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useLogout" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>LogoutMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/logout.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/logout.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutAborted.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutAborted.mdx deleted file mode 100644 index 4c84ded48..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutAborted.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useLogoutAborted" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>LogoutAbortedMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/logout-aborted.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/logout-aborted.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutComplete.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutComplete.mdx deleted file mode 100644 index 79a58ba87..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutComplete.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useLogoutComplete" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>LogoutCompleteMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/logout-complete.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/logout-complete.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaBeginEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaBeginEnrollOptions.mdx deleted file mode 100644 index bb1da7a7d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaBeginEnrollOptions.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaBeginEnrollOptions" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaBeginEnrollOptionsMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-begin-enroll-options.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaCountryCodes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaCountryCodes.mdx deleted file mode 100644 index 6ad6b794e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaCountryCodes.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaCountryCodes" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaCountryCodesMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-country-codes.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaDetectBrowserCapabilities.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaDetectBrowserCapabilities.mdx deleted file mode 100644 index 5ffe3f2ca..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaDetectBrowserCapabilities.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaDetectBrowserCapabilities" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaDetectBrowserCapabilitiesMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-detect-browser-capabilities.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailChallenge.mdx deleted file mode 100644 index 69a081403..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaEmailChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaEmailChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-email-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailList.mdx deleted file mode 100644 index 7b5bd8e5b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailList.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaEmailList" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaEmailListMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-email-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-email-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEnrollResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEnrollResult.mdx deleted file mode 100644 index fcf70895d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEnrollResult.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaEnrollResult" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaEnrollResultMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-enroll-result.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaLoginOptions.mdx deleted file mode 100644 index 08dd6f640..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaLoginOptions.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaLoginOptions" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaLoginOptionsMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-login-options.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-login-options.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpChallenge.mdx deleted file mode 100644 index b56d61ae0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaOtpChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaOtpChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-otp-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentCode.mdx deleted file mode 100644 index 897b80500..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentCode.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaOtpEnrollmentCode" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaOtpEnrollmentCodeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-otp-enrollment-code.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentQr.mdx deleted file mode 100644 index 9986d454f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentQr.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaOtpEnrollmentQr" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaOtpEnrollmentQrMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-otp-enrollment-qr.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneChallenge.mdx deleted file mode 100644 index 98075a8fe..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaPhoneChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaPhoneChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-phone-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneEnrollment.mdx deleted file mode 100644 index 0c5957453..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneEnrollment.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaPhoneEnrollment" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaPhoneEnrollmentMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-phone-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPolling.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPolling.mdx deleted file mode 100644 index 3e0696c9f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPolling.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "useMfaPolling" -description: "- The `onError` callback receives an object with `status` and `responseText` describing the server response. - Internal rate-limit responses (`429`) are automatically handled: polling waits for the reset window before retrying. - Calling `startPolling()` repeatedly while running is safe and idempotent." ---- - -## Parameters - -<ParamField path="options" type={<span>MfaPollingOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/MfaPollingResult">MfaPollingResult</a></span>}> -</ParamField> - ---- - -**File:** [src/hooks/utility/polling-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushChallengePush.mdx deleted file mode 100644 index 4981352ab..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushChallengePush.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaPushChallengePush" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaPushChallengePushMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-push-challenge-push.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushEnrollmentQr.mdx deleted file mode 100644 index 86beee5cb..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushEnrollmentQr.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaPushEnrollmentQr" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaPushEnrollmentQrMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-push-enrollment-qr.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushList.mdx deleted file mode 100644 index a4e4c3d81..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushList.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaPushList" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaPushListMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-push-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushWelcome.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushWelcome.mdx deleted file mode 100644 index 9175ea4f4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushWelcome.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaPushWelcome" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaPushWelcomeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-push-welcome.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallenge.mdx deleted file mode 100644 index b9cab015e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaRecoveryCodeChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaRecoveryCodeChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-recovery-code-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallengeNewCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallengeNewCode.mdx deleted file mode 100644 index 60737f7f4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallengeNewCode.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaRecoveryCodeChallengeNewCode" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaRecoveryCodeChallengeNewCodeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-recovery-code-challenge-new-code.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeEnrollment.mdx deleted file mode 100644 index efc9edc1f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeEnrollment.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaRecoveryCodeEnrollment" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaRecoveryCodeEnrollmentMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-recovery-code-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsChallenge.mdx deleted file mode 100644 index 798505571..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaSmsChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaSmsChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-sms-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsEnrollment.mdx deleted file mode 100644 index 63c30961b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsEnrollment.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaSmsEnrollment" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaSmsEnrollmentMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-sms-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsList.mdx deleted file mode 100644 index 10bfb3ebf..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsList.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaSmsList" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaSmsListMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-sms-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceChallenge.mdx deleted file mode 100644 index a29993189..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaVoiceChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaVoiceChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceEnrollment.mdx deleted file mode 100644 index df49ef27a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceEnrollment.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaVoiceEnrollment" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaVoiceEnrollmentMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-voice-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnChangeKeyNickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnChangeKeyNickname.mdx deleted file mode 100644 index 8809731fa..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnChangeKeyNickname.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaWebAuthnChangeKeyNickname" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaWebAuthnChangeKeyNicknameMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-change-key-nickname.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnEnrollmentSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnEnrollmentSuccess.mdx deleted file mode 100644 index b75f668a3..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnEnrollmentSuccess.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaWebAuthnEnrollmentSuccess" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaWebAuthnEnrollmentSuccessMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-enrollment-success.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnError.mdx deleted file mode 100644 index e8aeb2b6d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnError.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaWebAuthnError" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaWebAuthnErrorMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnNotAvailableError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnNotAvailableError.mdx deleted file mode 100644 index b607139ae..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnNotAvailableError.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaWebAuthnNotAvailableError" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaWebAuthnNotAvailableErrorMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-not-available-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformChallenge.mdx deleted file mode 100644 index 21f303f12..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaWebAuthnPlatformChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaWebAuthnPlatformChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-platform-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformEnrollment.mdx deleted file mode 100644 index 69810e44d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformEnrollment.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaWebAuthnPlatformEnrollment" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaWebAuthnPlatformEnrollmentMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-platform-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingChallenge.mdx deleted file mode 100644 index 96dc8966e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaWebAuthnRoamingChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaWebAuthnRoamingChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingEnrollment.mdx deleted file mode 100644 index d0c183003..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingEnrollment.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useMfaWebAuthnRoamingEnrollment" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>MfaWebAuthnRoamingEnrollmentMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-roaming-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationPicker.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationPicker.mdx deleted file mode 100644 index 3160d768e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationPicker.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useOrganizationPicker" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>OrganizationPickerMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/organization-picker.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/organization-picker.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationSelection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationSelection.mdx deleted file mode 100644 index 69f762d1d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationSelection.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useOrganizationSelection" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>OrganizationSelectionMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/organization-selection.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/organization-selection.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollment.mdx deleted file mode 100644 index 94374ec81..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollment.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "usePasskeyEnrollment" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>PasskeyEnrollmentMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/passkey-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollmentLocal.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollmentLocal.mdx deleted file mode 100644 index 3e0761934..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollmentLocal.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "usePasskeyEnrollmentLocal" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>PasskeyEnrollmentLocalMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/passkey-enrollment-local.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePassword.mdx deleted file mode 100644 index 575ad9aeb..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePassword.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "usePassword" -description: "" ---- - -## Parameters - -<ParamField path="payload" type={<span>CustomOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasswordValidation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasswordValidation.mdx deleted file mode 100644 index 7206f3520..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasswordValidation.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "usePasswordValidation" -description: "This React hook validates a password against the current Auth0 password policy and returns a structured result describing whether the password satisfies each rule. Optionally, it can send the validation results to the global error manager so that form error components can update automatically." ---- - -## Parameters - -<ParamField path="password" type={<span>string</span>} required> -</ParamField> - -<ParamField path="options" type="object"> - <Expandable title="properties"> - <ParamField path="includeInErrors" type={<span>boolean</span>}> - </ParamField> - </Expandable> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>PasswordValidationResult</span>}> -</ParamField> - ---- - -**File:** [src/hooks/utility/validate-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/validate-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierChallenge.mdx deleted file mode 100644 index 3b4e9eded..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "usePhoneIdentifierChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>PhoneIdentifierChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/phone-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierEnrollment.mdx deleted file mode 100644 index 1baab3d08..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierEnrollment.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "usePhoneIdentifierEnrollment" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>PhoneIdentifierEnrollmentMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/phone-identifier-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useRedeemTicket.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useRedeemTicket.mdx deleted file mode 100644 index 612a6de64..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useRedeemTicket.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useRedeemTicket" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>RedeemTicketMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/redeem-ticket.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/redeem-ticket.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResend.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResend.mdx deleted file mode 100644 index a039275b5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResend.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "useResend" -description: "This React hook manages \"resend\" actions (e.g., resending a verification code) on ACUL screens. This hook: - Tracks the remaining cooldown time. - Tells you whether the resend button should be disabled. - Provides a `startResend` function to trigger a resend immediately." ---- - -## Parameters - -<ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendOptions">UseResendOptions</a></span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendReturn">UseResendReturn</a></span>}> -</ParamField> - ---- - -**File:** [src/hooks/utility/resend-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPassword.mdx deleted file mode 100644 index b1c600ada..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPassword.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useResetPassword" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>ResetPasswordMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordEmail.mdx deleted file mode 100644 index 8b09f673b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordEmail.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useResetPasswordEmail" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>ResetPasswordEmailMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-email.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-email.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordError.mdx deleted file mode 100644 index 15cf9ad41..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordError.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useResetPasswordError" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>ResetPasswordErrorMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaEmailChallenge.mdx deleted file mode 100644 index 0d22d403d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaEmailChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useResetPasswordMfaEmailChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>ResetPasswordMfaEmailChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-email-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaOtpChallenge.mdx deleted file mode 100644 index 09e3d54a0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaOtpChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useResetPasswordMfaOtpChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>ResetPasswordMfaOtpChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-otp-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPhoneChallenge.mdx deleted file mode 100644 index c4b8e125e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPhoneChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useResetPasswordMfaPhoneChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>ResetPasswordMfaPhoneChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-phone-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPushChallengePush.mdx deleted file mode 100644 index ccf5c1336..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPushChallengePush.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useResetPasswordMfaPushChallengePush" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>ResetPasswordMfaPushChallengePushMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-push-challenge-push.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaRecoveryCodeChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaRecoveryCodeChallenge.mdx deleted file mode 100644 index 312b84976..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaRecoveryCodeChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useResetPasswordMfaRecoveryCodeChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>ResetPasswordMfaRecoveryCodeChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-recovery-code-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaSmsChallenge.mdx deleted file mode 100644 index 5bf137d6a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaSmsChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useResetPasswordMfaSmsChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>ResetPasswordMfaSmsChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-sms-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaVoiceChallenge.mdx deleted file mode 100644 index 59d98bd7c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaVoiceChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useResetPasswordMfaVoiceChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>ResetPasswordMfaVoiceChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnPlatformChallenge.mdx deleted file mode 100644 index f7ec8e9c5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnPlatformChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useResetPasswordMfaWebAuthnPlatformChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>ResetPasswordMfaWebAuthnPlatformChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-webauthn-platform-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnRoamingChallenge.mdx deleted file mode 100644 index f98809fda..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnRoamingChallenge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useResetPasswordMfaWebAuthnRoamingChallenge" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>ResetPasswordMfaWebAuthnRoamingChallengeMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordRequest.mdx deleted file mode 100644 index 8a053cdd3..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordRequest.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useResetPasswordRequest" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>ResetPasswordRequestMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-request.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-request.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordSuccess.mdx deleted file mode 100644 index 334f2c744..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordSuccess.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useResetPasswordSuccess" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>ResetPasswordSuccessMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-success.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-success.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSecurityKey.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSecurityKey.mdx deleted file mode 100644 index 0f2d7a8c6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSecurityKey.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "useSecurityKey" -description: "" ---- - -## Parameters - -<ParamField path="options" type={<span>UseSecurityKeyOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignup.mdx deleted file mode 100644 index 80b133046..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignup.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useSignup" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>SignupMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/signup.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupId.mdx deleted file mode 100644 index 6053d72e3..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupId.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useSignupId" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>SignupIdMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/signup-id.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup-id.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupIdentifiers.mdx deleted file mode 100644 index 54cfbb81f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupIdentifiers.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useSignupIdentifiers" -description: "Returns a list of enabled identifiers (email, phone, or username), each with its `required` status, based on the current screen's signup identifiers." ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>Identifier[] | []</span>}> -</ParamField> - ---- - -**File:** [src/hooks/utility/signup-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/signup-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupPassword.mdx deleted file mode 100644 index 22f6a8183..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupPassword.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "useSignupPassword" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>SignupPasswordMembers</span>}> -</ParamField> - ---- - -**File:** [src/screens/signup-password.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup-password.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useUsernameValidation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useUsernameValidation.mdx deleted file mode 100644 index 72bde79ac..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useUsernameValidation.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "useUsernameValidation" -description: "React hook for validating a username against the current Auth0 username policy. This hook checks the provided username against all configured validation rules and returns a structured result describing whether it passes. Optionally, it can send validation errors to the global error manager so that UI components observing the `username` field can automatically display or react to these errors." ---- - -## Parameters - -<ParamField path="username" type={<span>string</span>} required> -</ParamField> - -<ParamField path="options" type="object"> - <Expandable title="properties"> - <ParamField path="includeInErrors" type={<span>boolean</span>}> - </ParamField> - </Expandable> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>UsernameValidationResult</span>}> -</ParamField> - ---- - -**File:** [src/hooks/utility/validate-username.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/validate-username.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/verify.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/verify.mdx deleted file mode 100644 index 82369522f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/verify.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "verify" -description: "" ---- - -## Parameters - -<ParamField path="options" type={<span>VerifySecurityKeyOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/withError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/withError.mdx deleted file mode 100644 index e9b5b7c7a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/withError.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "withError" -description: "" ---- - -## Parameters - -<ParamField path="actionOrPromise" type={<span>(() => T | Promise<T>) | Promise<T></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>T | Promise<T></span>}> -</ParamField> - ---- - -**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem.mdx deleted file mode 100644 index f0c99c29b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "ErrorItem" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ErrorItem extends Auth0Error { - id: string; - label?: string; - kind?: ErrorKind; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="id" type={<span>string</span>} required> -</ParamField> - -<ParamField path="label" type={<span>string</span>}> -</ParamField> - -<ParamField path="kind" type={<span>ErrorKind</span>}> -</ParamField> - ---- - -**File:** [src/state/error-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/error-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorsResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorsResult.mdx deleted file mode 100644 index 1ae49581d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorsResult.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "ErrorsResult" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ErrorsResult extends ReadonlyArray<ErrorItem> { - byKind(kind: ErrorKind, opts?: { field?: string }): ReadonlyArray<ErrorItem>; - byField(field: string, opts?: { kind?: ErrorKind }): ReadonlyArray<ErrorItem>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="byKind" type={<span>ReadonlyArray<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>} required> -</ParamField> - -<ParamField path="byField" type={<span>ReadonlyArray<<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem">ErrorItem</a>></span>} required> -</ParamField> - ---- - -**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/MfaPollingResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/MfaPollingResult.mdx deleted file mode 100644 index ac7db9b74..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/MfaPollingResult.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "MfaPollingResult" -description: "Result object returned by ." ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaPollingResult { - /** - * Indicates whether the MFA push polling process is currently active. - * - * - `true` — Polling is running and awaiting completion. - * - `false` — Polling has stopped, either due to completion, - * manual cancellation, or component unmount. - */ - isRunning: boolean; - - /** - * Starts or resumes the polling process. - * - * - If polling is already active, this call has no effect. - * - If previously stopped, calling this restarts the polling loop. - */ - startPolling: () => void; - - /** - * Stops the polling process immediately. - * - * - Cancels any scheduled timers or in-flight requests. - * - Safe to call multiple times; subsequent calls have no effect. - */ - stopPolling: () => void; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="isRunning" type={<span>boolean</span>} required> - Indicates whether the MFA push polling process is currently active. - `true` — Polling is running and awaiting completion. - `false` — Polling has stopped, either due to completion, manual cancellation, or component unmount. -</ParamField> - -<ParamField path="startPolling" type={<span>() => void</span>} required> - Starts or resumes the polling process. - If polling is already active, this call has no effect. - If previously stopped, calling this restarts the polling loop. -</ParamField> - -<ParamField path="stopPolling" type={<span>() => void</span>} required> - Stops the polling process immediately. - Cancels any scheduled timers or in-flight requests. - Safe to call multiple times; subsequent calls have no effect. -</ParamField> - ---- - -**File:** [src/hooks/utility/polling-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorOptions.mdx deleted file mode 100644 index 6f629bf36..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorOptions.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "UseErrorOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface UseErrorOptions { - includeDevErrors?: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="includeDevErrors" type={<span>boolean</span>}> -</ParamField> - ---- - -**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorsResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorsResult.mdx deleted file mode 100644 index 8b70f098b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorsResult.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "UseErrorsResult" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface UseErrorsResult { - errors: ErrorsResult; - hasError: boolean; - dismiss: (id: string) => void; - dismissAll: () => void; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorsResult">ErrorsResult</a></span>} required> -</ParamField> - -<ParamField path="hasError" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="dismiss" type={<span>(id: string) => void</span>} required> -</ParamField> - -<ParamField path="dismissAll" type={<span>() => void</span>} required> -</ParamField> - ---- - -**File:** [src/hooks/common/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/common/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendOptions.mdx deleted file mode 100644 index b6400964b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendOptions.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "UseResendOptions" -description: "Optional configuration for ." ---- - -<RequestExample> - -```typescript Interface lines -export interface UseResendOptions { - /** - * Countdown duration (in seconds) before another resend is allowed. - * Defaults to `10`. - */ - timeoutSeconds?: number; - /** - * Callback fired when the countdown finishes and the resend - * action becomes available again. - */ - onTimeout?: () => void; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="timeoutSeconds" type={<span>number</span>}> - Countdown duration (in seconds) before another resend is allowed. Defaults to `10`. -</ParamField> - -<ParamField path="onTimeout" type={<span>() => void</span>}> - Callback fired when the countdown finishes and the resend action becomes available again. -</ParamField> - ---- - -**File:** [src/hooks/utility/resend-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendReturn.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendReturn.mdx deleted file mode 100644 index aa8c10fa7..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendReturn.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "UseResendReturn" -description: "Return type for ." ---- - -<RequestExample> - -```typescript Interface lines -export interface UseResendReturn { - /** Seconds remaining until the next resend attempt is allowed. */ - remaining: number; - /** Whether the resend action is currently disabled. */ - disabled: boolean; - /** Start a resend attempt immediately, if allowed. */ - startResend: () => void; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="remaining" type={<span>number</span>} required> - Seconds remaining until the next resend attempt is allowed. -</ParamField> - -<ParamField path="disabled" type={<span>boolean</span>} required> - Whether the resend action is currently disabled. -</ParamField> - -<ParamField path="startResend" type={<span>() => void</span>} required> - Start a resend attempt immediately, if allowed. -</ParamField> - ---- - -**File:** [src/hooks/utility/resend-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithLoginIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithLoginIdentifiers.mdx deleted file mode 100644 index e8a9584a9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithLoginIdentifiers.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "WithLoginIdentifiers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -interface WithLoginIdentifiers { - getLoginIdentifiers: () => IdentifierType[]; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="getLoginIdentifiers" type={<span>() => IdentifierType[]</span>} required> -</ParamField> - ---- - -**File:** [src/hooks/utility/login-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/login-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithResendManager.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithResendManager.mdx deleted file mode 100644 index 8b9f2dce4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithResendManager.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "WithResendManager" -description: "Screens that support resend operations expose a `resendManager` method." ---- - -<RequestExample> - -```typescript Interface lines -interface WithResendManager { - resendManager(options?: StartResendOptions): ResendControl; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="resendManager" type={<span>ResendControl</span>} required> -</ParamField> - ---- - -**File:** [src/hooks/utility/resend-manager.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithSignupIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithSignupIdentifiers.mdx deleted file mode 100644 index 775e48aa9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithSignupIdentifiers.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "WithSignupIdentifiers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -interface WithSignupIdentifiers { - getSignupIdentifiers: () => Identifier[]; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="getSignupIdentifiers" type={<span>() => Identifier[]</span>} required> -</ParamField> - ---- - -**File:** [src/hooks/utility/signup-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/signup-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidatePassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidatePassword.mdx deleted file mode 100644 index 758fa5455..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidatePassword.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "WithValidatePassword" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -interface WithValidatePassword { - validatePassword: (password: string) => PasswordValidationResult; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="validatePassword" type={<span>(password: string) => PasswordValidationResult</span>} required> -</ParamField> - ---- - -**File:** [src/hooks/utility/validate-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/validate-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidateUsername.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidateUsername.mdx deleted file mode 100644 index c00456606..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidateUsername.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "WithValidateUsername" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -interface WithValidateUsername { - validateUsername: (username: string) => UsernameValidationResult; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="validateUsername" type={<span>(username: string) => UsernameValidationResult</span>} required> -</ParamField> - ---- - -**File:** [src/hooks/utility/validate-username.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/hooks/utility/validate-username.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/navigation.json b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/navigation.json index 4258540a2..7e57822c8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/navigation.json +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/navigation.json @@ -2,366 +2,402 @@ "group": "@auth0/auth0-acul-react", "pages": [ { - "group": "Classes", + "group": "Hooks", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ErrorStore", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/classes/ContextHooks" + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useAuth0Themes", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useCurrentScreen", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useErrors", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useLoginIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useMfaPolling", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/usePasswordValidation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useResend", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useSignupIdentifiers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useUsernameValidation" ] }, { - "group": "Interfaces", + "group": "Screens", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorsResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseErrorsResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithLoginIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/MfaPollingResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendReturn", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/UseResendOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithResendManager", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithSignupIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidatePassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/WithValidateUsername", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/interfaces/ErrorItem" + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index" ] }, { - "group": "Types", + "group": "Classes", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ErrorKind", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Bucket", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Listener", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ScreenConstructor" + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks" ] }, { - "group": "Functions", + "group": "Interfaces", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/classifyKind", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toErrorObject", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/filterByField", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/withError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/listsEqual", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/registerScreen", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getScreen", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/clearScreen", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/acceptInvitation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useAcceptInvitation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/accept", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/deny", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useConsent", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/accept", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/deny", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useCustomizedConsent", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationAllowed", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivationDenied", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeActivation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirm", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/cancel", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useDeviceCodeConfirmation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailOTPChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useEmailVerificationResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useInterstitialCaptcha", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginEmailVerification", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/passkeyLogin", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginId", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessEmailCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitOTP", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendOTP", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLoginPasswordlessSmsOtp", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/login", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedLogin", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogin", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutAborted", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogoutComplete", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/confirmLogout", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useLogout", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaBeginEnrollOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectCountryCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaCountryCodes", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/detectCapabilities", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaDetectBrowserCapabilities", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickEmail", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaEmail", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEmailList", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaEnrollResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaLoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/toggleView", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaOtpEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickPhone", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPhoneEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendPushNotification", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enterCodeManually", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickAuthenticator", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectMfaPushDevice", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/goBack", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushList", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickAuthenticator", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaPushWelcome", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallengeNewCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaRecoveryCodeEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickSms", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getACall", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneNumber", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backAction", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaSmsList", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickPhone", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToSms", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectPhoneCountryCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaVoiceEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithNewNickname", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnChangeKeyNickname", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnEnrollmentSuccess", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAgain", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/noThanks", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnNotAvailableError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/verify", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPasskeyCredential", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/snoozeEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/refuseEnrollmentOnThisDevice", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnPlatformEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/verify", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportWebAuthnError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enroll", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/showError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useMfaWebAuthnRoamingEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/selectOrganization", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/skipOrganizationSelection", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationPicker", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithOrganizationName", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useOrganizationSelection", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/abortPasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollmentLocal", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/abortPasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/submitPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToVoice", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToText", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continuePhoneEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/returnToPrevious", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/usePhoneIdentifierEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useRedeemTicket", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendEmail", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordEmail", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendPushNotification", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/enterCodeManually", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaRecoveryCodeChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/getACall", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/switchToSms", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resendCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/continueWithPasskey", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/reportBrowserError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSecurityKey", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/showError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/tryAnotherMethod", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordMfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resetPassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/backToLogin", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordRequest", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPasswordSuccess", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/resetPassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useResetPassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupId", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/signup", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/federatedSignup", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/pickCountryCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/functions/useSignup" + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AbortEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AuthorizationDetail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOTPOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinuePayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithOrganizationNameOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CredentialResponse", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledDevice", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledEmail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledPhoneNumber", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPasswordPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodePayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectCountryCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaEmailOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaPushDeviceOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectOrganizationOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCaptchaOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitOTPOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodMfaOtpChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions" ] }, { - "group": "Screens", + "group": "Type Aliases", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/accept-invitation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/consent", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/customized-consent", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-allowed", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-denied", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-confirmation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-identifier-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-otp-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-verification-result", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/interstitial-captcha", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-email-verification", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-id", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-password", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-email-code", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-sms-otp", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-aborted", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-complete", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-begin-enroll-options", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-country-codes", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-detect-browser-capabilities", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-list", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-enroll-result", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-login-options", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-code", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-qr", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-challenge-push", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-enrollment-qr", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-list", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-welcome", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge-new-code", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-list", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-change-key-nickname", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-enrollment-success", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-error", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-not-available-error", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-picker", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-selection", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment-local", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-enrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/redeem-ticket", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-email", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-error", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-email-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-otp-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-phone-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-push-challenge-push", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-recovery-code-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-sms-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-voice-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-platform-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-roaming-challenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-request", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-success", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-id", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-password", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup" + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/AuthenticatorTransport", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaEnrollFactorType", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaLoginFactorType", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/OnStatusChangeCallback", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ScreenIdentifierType", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType" ] } ] -} \ No newline at end of file +} diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/accept-invitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/accept-invitation.mdx deleted file mode 100644 index 71d57087f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/accept-invitation.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: "Accept Invitation" -description: "The Accept Invitation screen module provides access to the Accept Invitation flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useAcceptInvitation" type="AcceptInvitationMembers"> - Provides access to the Accept Invitation context and functionality. -</ParamField> - -<ParamField body="acceptInvitation" type="Function"> - Accepts the invitation to the organization. - - **Parameter:** Optional custom options to include with the request. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/accept-invitation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/accept-invitation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/consent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/consent.mdx deleted file mode 100644 index b809fb514..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/consent.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Consent" -description: "The Consent screen module provides access to the Consent flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useConsent" type="ConsentMembers"> - Provides access to the Consent context and functionality. -</ParamField> - -<ParamField body="accept" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="deny" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/consent.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/consent.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/customized-consent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/customized-consent.mdx deleted file mode 100644 index 464805f5d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/customized-consent.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Customized Consent" -description: "The Customized Consent screen module provides access to the Customized Consent flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useCustomizedConsent" type="CustomizedConsentMembers"> - Provides access to the Customized Consent context and functionality. -</ParamField> - -<ParamField body="accept" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="deny" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/customized-consent.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/customized-consent.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-allowed.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-allowed.mdx deleted file mode 100644 index 125f2e2a5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-allowed.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: "Device Code Activation Allowed" -description: "The Device Code Activation Allowed screen module provides access to the Device Code Activation Allowed flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useDeviceCodeActivationAllowed" type="DeviceCodeActivationAllowedMembers"> - Provides access to the Device Code Activation Allowed context and functionality. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/device-code-activation-allowed.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-denied.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-denied.mdx deleted file mode 100644 index 27d9b6549..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation-denied.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: "Device Code Activation Denied" -description: "The Device Code Activation Denied screen module provides access to the Device Code Activation Denied flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useDeviceCodeActivationDenied" type="DeviceCodeActivationDeniedMembers"> - Provides access to the Device Code Activation Denied context and functionality. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/device-code-activation-denied.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation.mdx deleted file mode 100644 index 4c9e33a9c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-activation.mdx +++ /dev/null @@ -1,150 +0,0 @@ ---- -title: "Device Code Activation" -description: "The Device Code Activation screen module provides access to the Device Code Activation flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useDeviceCodeActivation" type="DeviceCodeActivationMembers"> - Provides access to the Device Code Activation context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/device-code-activation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-activation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-confirmation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-confirmation.mdx deleted file mode 100644 index 4bf355757..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/device-code-confirmation.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Device Code Confirmation" -description: "The Device Code Confirmation screen module provides access to the Device Code Confirmation flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useDeviceCodeConfirmation" type="DeviceCodeConfirmationMembers"> - Provides access to the Device Code Confirmation context and functionality. -</ParamField> - -<ParamField body="confirm" type="Function"> - Interface describing the data available on the Device Code Confirmation screen. / export interface ScreenMembersOnDeviceCodeConfirmation extends ScreenMembers { data: { textCode: string; } | null; } Interface describing the members of the Device Code Confirmation screen. / export interface DeviceCodeConfirmationMembers extends BaseMembers { screen: ScreenMembersOnDeviceCodeConfirmation; Confirms the device code. - - **Parameter:** Optional custom options to include with the request. -</ParamField> - -<ParamField body="cancel" type="Function"> - Interface describing the data available on the Device Code Confirmation screen. / export interface ScreenMembersOnDeviceCodeConfirmation extends ScreenMembers { data: { textCode: string; } | null; } Interface describing the members of the Device Code Confirmation screen. / export interface DeviceCodeConfirmationMembers extends BaseMembers { screen: ScreenMembersOnDeviceCodeConfirmation; Confirms the device code. - - **Parameter:** Optional custom options to include with the request. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/device-code-confirmation.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-identifier-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-identifier-challenge.mdx deleted file mode 100644 index f2323b860..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-identifier-challenge.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Email Identifier Challenge" -description: "The Email Identifier Challenge screen module provides access to the Email Identifier Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useEmailIdentifierChallenge" type="EmailIdentifierChallengeMembers"> - Provides access to the Email Identifier Challenge context and functionality. -</ParamField> - -<ParamField body="submitEmailChallenge" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="resendCode" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="returnToPrevious" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/email-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-otp-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-otp-challenge.mdx deleted file mode 100644 index ff59be098..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-otp-challenge.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Email Otp Challenge" -description: "The Email Otp Challenge screen module provides access to the Email Otp Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useEmailOTPChallenge" type="EmailOTPChallengeMembers"> - Provides access to the Email Otp Challenge context and functionality. -</ParamField> - -<ParamField body="submitCode" type="Function"> - Represents the members of the Email OTP Challenge screen. Extends the base ScreenMembers interface. / export interface ScreenMembersOnEmailOTPChallenge extends ScreenMembers { // Add any specific members for this screen here } export interface OtpCodeOptions extends CustomOptions { The OTP code that the user enters to submit. / code: string; } // test data********* Represents the Email OTP Challenge screen interface. / export interface EmailOTPChallengeMembers extends BaseMembers { screen: ScreenMembersOnEmailOTPChallenge; Submits the OTP code entered by the user. - - **Parameter:** Optional parameters to include in the submission. -</ParamField> - -<ParamField body="resendCode" type="Function"> - Represents the members of the Email OTP Challenge screen. Extends the base ScreenMembers interface. / export interface ScreenMembersOnEmailOTPChallenge extends ScreenMembers { // Add any specific members for this screen here } export interface OtpCodeOptions extends CustomOptions { The OTP code that the user enters to submit. / code: string; } // test data********* Represents the Email OTP Challenge screen interface. / export interface EmailOTPChallengeMembers extends BaseMembers { screen: ScreenMembersOnEmailOTPChallenge; Submits the OTP code entered by the user. - - **Parameter:** Optional parameters to include in the submission. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/email-otp-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-verification-result.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-verification-result.mdx deleted file mode 100644 index f4445b8a9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/email-verification-result.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: "Email Verification Result" -description: "The Email Verification Result screen module provides access to the Email Verification Result flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useEmailVerificationResult" type="EmailVerificationResultMembers"> - Provides access to the Email Verification Result context and functionality. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/email-verification-result.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/email-verification-result.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/interstitial-captcha.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/interstitial-captcha.mdx deleted file mode 100644 index 00ba16e32..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/interstitial-captcha.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: "Interstitial Captcha" -description: "The Interstitial Captcha screen module provides access to the Interstitial Captcha flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useInterstitialCaptcha" type="InterstitialCaptchaMembers"> - Provides access to the Interstitial Captcha context and functionality. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/interstitial-captcha.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-email-verification.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-email-verification.mdx deleted file mode 100644 index 64c5d72a6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-email-verification.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Login Email Verification" -description: "The Login Email Verification screen module provides access to the Login Email Verification flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useLoginEmailVerification" type="LoginEmailVerificationMembers"> - Provides access to the Login Email Verification context and functionality. -</ParamField> - -<ParamField body="continueWithCode" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="resendCode" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/login-email-verification.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-email-verification.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-id.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-id.mdx deleted file mode 100644 index be69e771a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-id.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -title: "Login Id" -description: "The Login Id screen module provides access to the Login Id flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useLoginId" type="LoginIdMembers"> - Provides access to the Login Id context and functionality. -</ParamField> - -<ParamField body="login" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="federatedLogin" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="passkeyLogin" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="pickCountryCode" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/login-id.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-id.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-password.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-password.mdx deleted file mode 100644 index dede15ba0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-password.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Login Password" -description: "The Login Password screen module provides access to the Login Password flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useLoginPassword" type="LoginPasswordMembers"> - Provides access to the Login Password context and functionality. -</ParamField> - -<ParamField body="login" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="federatedLogin" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/login-password.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-password.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-email-code.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-email-code.mdx deleted file mode 100644 index 582a980a0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-email-code.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Login Passwordless Email Code" -description: "The Login Passwordless Email Code screen module provides access to the Login Passwordless Email Code flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useLoginPasswordlessEmailCode" type="LoginPasswordlessEmailCodeMembers"> - Provides access to the Login Passwordless Email Code context and functionality. -</ParamField> - -<ParamField body="submitCode" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="resendCode" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/login-passwordless-email-code.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-sms-otp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-sms-otp.mdx deleted file mode 100644 index 7fa6f1995..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login-passwordless-sms-otp.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Login Passwordless Sms Otp" -description: "The Login Passwordless Sms Otp screen module provides access to the Login Passwordless Sms Otp flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useLoginPasswordlessSmsOtp" type="LoginPasswordlessSmsOtpMembers"> - Provides access to the Login Passwordless Sms Otp context and functionality. -</ParamField> - -<ParamField body="submitOTP" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="resendOTP" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/login-passwordless-sms-otp.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login.mdx deleted file mode 100644 index 00662d6cf..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/login.mdx +++ /dev/null @@ -1,164 +0,0 @@ ---- -title: "Login" -description: "The Login screen module provides access to the Login flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useLogin" type="LoginMembers"> - Provides access to the Login context and functionality. -</ParamField> - -<ParamField body="login" type="Function"> - Extended screen context interface for the login screen / export interface ScreenContextOnLogin extends ScreenContext { links: { signup: string; reset_password: string; }; } Extended screen members interface for the login screen / export interface ScreenMembersOnLogin extends ScreenMembers { signupLink: string | null; resetPasswordLink: string | null; data: { username?: string; } | null; } Extended transaction context interface for the login screen / export interface TransactionContextOnLogin extends TransactionContext { connection: DBConnection; } Extended transaction members interface for the login screen / export interface TransactionMembersOnLogin extends TransactionMembers { isSignupEnabled: boolean; isForgotPasswordEnabled: boolean; isPasskeyEnabled: boolean; passwordPolicy: PasswordPolicy | null; allowedIdentifiers: IdentifierType[] | null; } Login screen interface extending base context / export interface Login extends BaseContext { screen: ScreenContextOnLogin; transaction: TransactionContextOnLogin; } Options for performing login operations / export interface LoginOptions { /** The username/email to login with */ username: string; /** The password for authentication */ password: string; /** Optional captcha value if required */ captcha?: string; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for performing social login operations / export interface FederatedLoginOptions { /** The social connection name to use */ connection: string; /** Any additional custom options */ [key: string]: string | number | boolean; } Login screen members interface extending base members / export interface LoginMembers extends BaseMembers { screen: ScreenMembersOnLogin; transaction: TransactionMembersOnLogin; Performs login with username/password - - **Parameter:** The login options -</ParamField> - -<ParamField body="federatedLogin" type="Function"> - Extended screen context interface for the login screen / export interface ScreenContextOnLogin extends ScreenContext { links: { signup: string; reset_password: string; }; } Extended screen members interface for the login screen / export interface ScreenMembersOnLogin extends ScreenMembers { signupLink: string | null; resetPasswordLink: string | null; data: { username?: string; } | null; } Extended transaction context interface for the login screen / export interface TransactionContextOnLogin extends TransactionContext { connection: DBConnection; } Extended transaction members interface for the login screen / export interface TransactionMembersOnLogin extends TransactionMembers { isSignupEnabled: boolean; isForgotPasswordEnabled: boolean; isPasskeyEnabled: boolean; passwordPolicy: PasswordPolicy | null; allowedIdentifiers: IdentifierType[] | null; } Login screen interface extending base context / export interface Login extends BaseContext { screen: ScreenContextOnLogin; transaction: TransactionContextOnLogin; } Options for performing login operations / export interface LoginOptions { /** The username/email to login with */ username: string; /** The password for authentication */ password: string; /** Optional captcha value if required */ captcha?: string; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for performing social login operations / export interface FederatedLoginOptions { /** The social connection name to use */ connection: string; /** Any additional custom options */ [key: string]: string | number | boolean; } Login screen members interface extending base members / export interface LoginMembers extends BaseMembers { screen: ScreenMembersOnLogin; transaction: TransactionMembersOnLogin; Performs login with username/password - - **Parameter:** The login options -</ParamField> - -<ParamField body="pickCountryCode" type="Function"> - Extended screen context interface for the login screen / export interface ScreenContextOnLogin extends ScreenContext { links: { signup: string; reset_password: string; }; } Extended screen members interface for the login screen / export interface ScreenMembersOnLogin extends ScreenMembers { signupLink: string | null; resetPasswordLink: string | null; data: { username?: string; } | null; } Extended transaction context interface for the login screen / export interface TransactionContextOnLogin extends TransactionContext { connection: DBConnection; } Extended transaction members interface for the login screen / export interface TransactionMembersOnLogin extends TransactionMembers { isSignupEnabled: boolean; isForgotPasswordEnabled: boolean; isPasskeyEnabled: boolean; passwordPolicy: PasswordPolicy | null; allowedIdentifiers: IdentifierType[] | null; } Login screen interface extending base context / export interface Login extends BaseContext { screen: ScreenContextOnLogin; transaction: TransactionContextOnLogin; } Options for performing login operations / export interface LoginOptions { /** The username/email to login with */ username: string; /** The password for authentication */ password: string; /** Optional captcha value if required */ captcha?: string; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for performing social login operations / export interface FederatedLoginOptions { /** The social connection name to use */ connection: string; /** Any additional custom options */ [key: string]: string | number | boolean; } Login screen members interface extending base members / export interface LoginMembers extends BaseMembers { screen: ScreenMembersOnLogin; transaction: TransactionMembersOnLogin; Performs login with username/password - - **Parameter:** The login options -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/login.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/login.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-aborted.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-aborted.mdx deleted file mode 100644 index adeddba2f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-aborted.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: "Logout Aborted" -description: "The Logout Aborted screen module provides access to the Logout Aborted flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useLogoutAborted" type="LogoutAbortedMembers"> - Provides access to the Logout Aborted context and functionality. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/logout-aborted.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/logout-aborted.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-complete.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-complete.mdx deleted file mode 100644 index 106f2551f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout-complete.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: "Logout Complete" -description: "The Logout Complete screen module provides access to the Logout Complete flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useLogoutComplete" type="LogoutCompleteMembers"> - Provides access to the Logout Complete context and functionality. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/logout-complete.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/logout-complete.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout.mdx deleted file mode 100644 index 816b4bf99..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/logout.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: "Logout" -description: "The Logout screen module provides access to the Logout flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useLogout" type="LogoutMembers"> - Provides access to the Logout context and functionality. -</ParamField> - -<ParamField body="confirmLogout" type="Function"> - Options for confirming logout / export interface ConfirmLogoutOptions extends CustomOptions { /** The authentication transaction state */ action: 'accept' | 'deny'; } Interface defining the available methods and properties for the logout screen / export interface LogoutMembers extends BaseMembers { Confirms the logout action (accept or deny) - - **Parameter:** The options containing the action to perform -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/logout.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/logout.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-begin-enroll-options.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-begin-enroll-options.mdx deleted file mode 100644 index 36a112132..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-begin-enroll-options.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: "Mfa Begin Enroll Options" -description: "The Mfa Begin Enroll Options screen module provides access to the Mfa Begin Enroll Options flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaBeginEnrollOptions" type="MfaBeginEnrollOptionsMembers"> - Provides access to the Mfa Begin Enroll Options context and functionality. -</ParamField> - -<ParamField body="enroll" type="Function"> - Options for continuing with factor enrollment / export interface MfaEnrollOptions { /** The action indicating which factor to enroll */ action: MfaEnrollFactorType; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } MFA Begin Enroll Options screen members interface / export interface MfaBeginEnrollOptionsMembers extends BaseMembers { Continues the enrollment process with the selected factor - - **Parameter:** The enrollment options including the selected factor -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-begin-enroll-options.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-country-codes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-country-codes.mdx deleted file mode 100644 index 09203d4b8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-country-codes.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Mfa Country Codes" -description: "The Mfa Country Codes screen module provides access to the Mfa Country Codes flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaCountryCodes" type="MfaCountryCodesMembers"> - Provides access to the Mfa Country Codes context and functionality. -</ParamField> - -<ParamField body="selectCountryCode" type="Function"> - Interface for screen data specific to mfa-country-codes screen / export interface ScreenMembersOnMfaCountryCodes extends ScreenMembers { data: { /** List of available phone prefixes */ phone_prefixes: PhonePrefix[]; } | null; } Options for selecting a country code / export interface SelectCountryCodeOptions { /** The country code (e.g. 'US', 'GB') */ country_code: string; /** The phone prefix (e.g. '+1', '+44') */ phone_prefix: string; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-country-codes screen / export interface MfaCountryCodesMembers extends BaseMembers { screen: ScreenMembersOnMfaCountryCodes; Selects a country code from the available options - - **Parameter:** The options containing the country code selection action -</ParamField> - -<ParamField body="goBack" type="Function"> - Interface for screen data specific to mfa-country-codes screen / export interface ScreenMembersOnMfaCountryCodes extends ScreenMembers { data: { /** List of available phone prefixes */ phone_prefixes: PhonePrefix[]; } | null; } Options for selecting a country code / export interface SelectCountryCodeOptions { /** The country code (e.g. 'US', 'GB') */ country_code: string; /** The phone prefix (e.g. '+1', '+44') */ phone_prefix: string; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-country-codes screen / export interface MfaCountryCodesMembers extends BaseMembers { screen: ScreenMembersOnMfaCountryCodes; Selects a country code from the available options - - **Parameter:** The options containing the country code selection action -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-country-codes.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-detect-browser-capabilities.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-detect-browser-capabilities.mdx deleted file mode 100644 index f4cc464be..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-detect-browser-capabilities.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: "Mfa Detect Browser Capabilities" -description: "The Mfa Detect Browser Capabilities screen module provides access to the Mfa Detect Browser Capabilities flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaDetectBrowserCapabilities" type="MfaDetectBrowserCapabilitiesMembers"> - Provides access to the Mfa Detect Browser Capabilities context and functionality. -</ParamField> - -<ParamField body="detectCapabilities" type="Function"> - Interface defining the available methods and properties for the mfa-detect-browser-capabilities screen / export interface MfaDetectBrowserCapabilitiesMembers extends BaseMembers { Picks an authenticator based on browser capabilities - - **Parameter:** The options containing browser capability flags -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-detect-browser-capabilities.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-challenge.mdx deleted file mode 100644 index 27fc922a8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-challenge.mdx +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: "Mfa Email Challenge" -description: "The Mfa Email Challenge screen module provides access to the Mfa Email Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaEmailChallenge" type="MfaEmailChallengeMembers"> - Provides access to the Mfa Email Challenge context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="resendCode" type="Function"> - Interface for the screen data specific to mfa-email-challenge screen / export interface ScreenMembersOnMfaEmailChallenge extends ScreenMembers { data: { email: string; showRememberDevice?: boolean; } | null; } Interface for untrusted data specific to mfa-email-challenge screen / export interface UntrustedDataMembersOnMfaEmailChallenge extends UntrustedDataMembers { submittedFormData: { rememberDevice: boolean; } | null; } Options for continuing with the email challenge / export interface ContinueOptions { /** The code entered by the user */ code: string; /** Indicates whether to remember the device */ rememberDevice?: boolean; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for resending the email code / export interface ResendCodeOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for trying another method / export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-email-challenge screen / export interface MfaEmailChallengeMembers extends BaseMembers { screen: ScreenMembersOnMfaEmailChallenge; untrustedData: UntrustedDataMembersOnMfaEmailChallenge; Continues with the email challenge using the provided code - - **Parameter:** The options containing the code and rememberDevice flag -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Interface for the screen data specific to mfa-email-challenge screen / export interface ScreenMembersOnMfaEmailChallenge extends ScreenMembers { data: { email: string; showRememberDevice?: boolean; } | null; } Interface for untrusted data specific to mfa-email-challenge screen / export interface UntrustedDataMembersOnMfaEmailChallenge extends UntrustedDataMembers { submittedFormData: { rememberDevice: boolean; } | null; } Options for continuing with the email challenge / export interface ContinueOptions { /** The code entered by the user */ code: string; /** Indicates whether to remember the device */ rememberDevice?: boolean; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for resending the email code / export interface ResendCodeOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for trying another method / export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-email-challenge screen / export interface MfaEmailChallengeMembers extends BaseMembers { screen: ScreenMembersOnMfaEmailChallenge; untrustedData: UntrustedDataMembersOnMfaEmailChallenge; Continues with the email challenge using the provided code - - **Parameter:** The options containing the code and rememberDevice flag -</ParamField> - -<ParamField body="pickEmail" type="Function"> - Interface for the screen data specific to mfa-email-challenge screen / export interface ScreenMembersOnMfaEmailChallenge extends ScreenMembers { data: { email: string; showRememberDevice?: boolean; } | null; } Interface for untrusted data specific to mfa-email-challenge screen / export interface UntrustedDataMembersOnMfaEmailChallenge extends UntrustedDataMembers { submittedFormData: { rememberDevice: boolean; } | null; } Options for continuing with the email challenge / export interface ContinueOptions { /** The code entered by the user */ code: string; /** Indicates whether to remember the device */ rememberDevice?: boolean; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for resending the email code / export interface ResendCodeOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for trying another method / export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-email-challenge screen / export interface MfaEmailChallengeMembers extends BaseMembers { screen: ScreenMembersOnMfaEmailChallenge; untrustedData: UntrustedDataMembersOnMfaEmailChallenge; Continues with the email challenge using the provided code - - **Parameter:** The options containing the code and rememberDevice flag -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-email-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-list.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-list.mdx deleted file mode 100644 index 02f20cdca..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-email-list.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Mfa Email List" -description: "The Mfa Email List screen module provides access to the Mfa Email List flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaEmailList" type="MfaEmailListMembers"> - Provides access to the Mfa Email List context and functionality. -</ParamField> - -<ParamField body="selectMfaEmail" type="Function"> - Interface for the screen data specific to mfa-email-list screen / export interface ScreenMembersOnMfaEmailList extends ScreenMembers { data: { /** List of enrolled email addresses */ enrolled_emails: string[]; } | null; } Options for selecting an email address / export interface SelectMfaEmailOptions { - - **Parameter:** The options containing the selection action -</ParamField> - -<ParamField body="goBack" type="Function"> - Interface for the screen data specific to mfa-email-list screen / export interface ScreenMembersOnMfaEmailList extends ScreenMembers { data: { /** List of enrolled email addresses */ enrolled_emails: string[]; } | null; } Options for selecting an email address / export interface SelectMfaEmailOptions { - - **Parameter:** The options containing the selection action -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-email-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-email-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-enroll-result.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-enroll-result.mdx deleted file mode 100644 index 515fff262..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-enroll-result.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: "Mfa Enroll Result" -description: "The Mfa Enroll Result screen module provides access to the Mfa Enroll Result flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaEnrollResult" type="MfaEnrollResultMembers"> - Provides access to the Mfa Enroll Result context and functionality. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-enroll-result.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-login-options.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-login-options.mdx deleted file mode 100644 index a8c5abd80..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-login-options.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Mfa Login Options" -description: "The Mfa Login Options screen module provides access to the Mfa Login Options flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaLoginOptions" type="MfaLoginOptionsMembers"> - Provides access to the Mfa Login Options context and functionality. -</ParamField> - -<ParamField body="enroll" type="Function"> - Interface for the screen data specific to mfa-login-options screen / export interface ScreenMembersOnMfaLoginOptions extends ScreenMembers { data: { /** List of enrolled MFA factors for the user */ enrolled_factors: string[]; } | null; } Options for continuing with a selected MFA factor / export interface LoginEnrollOptions { /** The action indicating which factor to use for login */ action: MfaLoginFactorType; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-login-options screen / export interface MfaLoginOptionsMembers extends BaseMembers { screen: ScreenMembersOnMfaLoginOptions; Continues the login process with the selected MFA factor - - **Parameter:** The options containing the selected factor -</ParamField> - -<ParamField body="returnToPrevious" type="Function"> - Interface for the screen data specific to mfa-login-options screen / export interface ScreenMembersOnMfaLoginOptions extends ScreenMembers { data: { /** List of enrolled MFA factors for the user */ enrolled_factors: string[]; } | null; } Options for continuing with a selected MFA factor / export interface LoginEnrollOptions { /** The action indicating which factor to use for login */ action: MfaLoginFactorType; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-login-options screen / export interface MfaLoginOptionsMembers extends BaseMembers { screen: ScreenMembersOnMfaLoginOptions; Continues the login process with the selected MFA factor - - **Parameter:** The options containing the selected factor -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-login-options.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-login-options.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-challenge.mdx deleted file mode 100644 index cc3f9ebfc..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-challenge.mdx +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: "Mfa Otp Challenge" -description: "The Mfa Otp Challenge screen module provides access to the Mfa Otp Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaOtpChallenge" type="MfaOtpChallengeMembers"> - Provides access to the Mfa Otp Challenge context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Interface for the screen data specific to mfa-otp-challenge screen / export interface ScreenMembersOnMfaOtpChallenge extends ScreenMembers { data: { showRememberDevice?: boolean; } | null; } Interface for untrusted data specific to mfa-otp-challenge screen / export interface UntrustedDataMembersOnMfaOtpChallenge extends UntrustedDataMembers { submittedFormData: { rememberDevice: boolean; } | null; } Options for continuing with the OTP challenge / export interface ContinueOptions { /** The code entered by the user */ code: string; /** Indicates whether to remember the browser */ rememberDevice?: boolean; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for trying another method / export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-otp-challenge screen / export interface MfaOtpChallengeMembers extends BaseMembers { screen: ScreenMembersOnMfaOtpChallenge; untrustedData: UntrustedDataMembersOnMfaOtpChallenge; Continues with the OTP challenge using the provided code - - **Parameter:** The options containing the code and rememberDevice flag -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-otp-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-code.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-code.mdx deleted file mode 100644 index 20bfcc2d9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-code.mdx +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: "Mfa Otp Enrollment Code" -description: "The Mfa Otp Enrollment Code screen module provides access to the Mfa Otp Enrollment Code flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaOtpEnrollmentCode" type="MfaOtpEnrollmentCodeMembers"> - Provides access to the Mfa Otp Enrollment Code context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Options for continuing with the MFA OTP enrollment code. / export interface ContinueOptions { The OTP code entered by the user. / code: string; Any additional custom options. / [key: string]: string | number | boolean | undefined; } Options for trying another MFA method. / export interface TryAnotherMethodOptions { Any additional custom options. / [key: string]: string | number | boolean | undefined; } Interface for the screen data specific to the mfa-otp-enrollment-code screen. / export interface ScreenMembersOnMfaOtpEnrollmentCode extends ScreenMembers { data: { The text code to display to the user. / text_code: string; } | null; } Interface defining the available methods and properties for the mfa-otp-enrollment-code screen. / export interface MfaOtpEnrollmentCodeMembers extends BaseMembers { The screen properties for the mfa-otp-enrollment-code screen. / screen: ScreenMembersOnMfaOtpEnrollmentCode; Continues the MFA OTP enrollment process by submitting the OTP code. - - **Parameter:** The options containing the OTP code. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-otp-enrollment-code.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-qr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-qr.mdx deleted file mode 100644 index a88ac6a76..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-otp-enrollment-qr.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -title: "Mfa Otp Enrollment Qr" -description: "The Mfa Otp Enrollment Qr screen module provides access to the Mfa Otp Enrollment Qr flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaOtpEnrollmentQr" type="MfaOtpEnrollmentQrMembers"> - Provides access to the Mfa Otp Enrollment Qr context and functionality. -</ParamField> - -<ParamField body="toggleView" type="Function"> - Interface for the screen data specific to mfa-otp-enrollment-qr screen / export interface ScreenMembersOnMfaOtpEnrollmentQr extends ScreenMembers { data: { qr_code: string; } | null; } Interface for the payload of the continue method - - **Parameter:** Optional custom options to include with the request -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Interface for the screen data specific to mfa-otp-enrollment-qr screen / export interface ScreenMembersOnMfaOtpEnrollmentQr extends ScreenMembers { data: { qr_code: string; } | null; } Interface for the payload of the continue method - - **Parameter:** Optional custom options to include with the request -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-otp-enrollment-qr.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-challenge.mdx deleted file mode 100644 index ea2fdb497..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-challenge.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Mfa Phone Challenge" -description: "The Mfa Phone Challenge screen module provides access to the Mfa Phone Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaPhoneChallenge" type="MfaPhoneChallengeMembers"> - Provides access to the Mfa Phone Challenge context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="pickPhone" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-phone-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-enrollment.mdx deleted file mode 100644 index ceb292615..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-phone-enrollment.mdx +++ /dev/null @@ -1,164 +0,0 @@ ---- -title: "Mfa Phone Enrollment" -description: "The Mfa Phone Enrollment screen module provides access to the Mfa Phone Enrollment flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaPhoneEnrollment" type="MfaPhoneEnrollmentMembers"> - Provides access to the Mfa Phone Enrollment context and functionality. -</ParamField> - -<ParamField body="pickCountryCode" type="Function"> - Options for continuing with the MFA phone enrollment. Extends `CustomOptions` to allow passing custom options alongside phone and type. / export interface ContinueOptions extends CustomOptions { phone: string; type: 'sms' | 'voice'; } export interface MfaPhoneEnrollmentMembers extends BaseMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; Selects the country code for the phone number. - - **Parameter:** Optional custom options to include with the request. -</ParamField> - -<ParamField body="continueEnrollment" type="Function"> - Options for continuing with the MFA phone enrollment. Extends `CustomOptions` to allow passing custom options alongside phone and type. / export interface ContinueOptions extends CustomOptions { phone: string; type: 'sms' | 'voice'; } export interface MfaPhoneEnrollmentMembers extends BaseMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; Selects the country code for the phone number. - - **Parameter:** Optional custom options to include with the request. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Options for continuing with the MFA phone enrollment. Extends `CustomOptions` to allow passing custom options alongside phone and type. / export interface ContinueOptions extends CustomOptions { phone: string; type: 'sms' | 'voice'; } export interface MfaPhoneEnrollmentMembers extends BaseMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; Selects the country code for the phone number. - - **Parameter:** Optional custom options to include with the request. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-phone-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-challenge-push.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-challenge-push.mdx deleted file mode 100644 index 9ab8d250e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-challenge-push.mdx +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: "Mfa Push Challenge Push" -description: "The Mfa Push Challenge Push screen module provides access to the Mfa Push Challenge Push flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaPushChallengePush" type="MfaPushChallengePushMembers"> - Provides access to the Mfa Push Challenge Push context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="resendPushNotification" type="Function"> - Interface for the screen data specific to mfa-push-challenge-push screen / export interface ScreenMembersOnMfaPushChallengePush extends ScreenMembers { data: { /** The name of the device receiving the push notification */ deviceName: string; /** Whether to show the remember device option */ showRememberDevice?: boolean; } | null; } Interface for untrusted data specific to mfa-push-challenge-push screen / export interface UntrustedDataMembersOnMfaPushChallengePush extends UntrustedDataMembers { submittedFormData: { rememberDevice: boolean; } | null; } export interface WithRememberOptions extends CustomOptions { rememberDevice?: boolean; } Interface defining the available methods and properties for the mfa-push-challenge-push screen / export interface MfaPushChallengePushMembers extends BaseMembers { screen: ScreenMembersOnMfaPushChallengePush; untrustedData: UntrustedDataMembersOnMfaPushChallengePush; Continues with the push notification challenge - - **Parameter:** Optional custom options to include with the request -</ParamField> - -<ParamField body="enterCodeManually" type="Function"> - Interface for the screen data specific to mfa-push-challenge-push screen / export interface ScreenMembersOnMfaPushChallengePush extends ScreenMembers { data: { /** The name of the device receiving the push notification */ deviceName: string; /** Whether to show the remember device option */ showRememberDevice?: boolean; } | null; } Interface for untrusted data specific to mfa-push-challenge-push screen / export interface UntrustedDataMembersOnMfaPushChallengePush extends UntrustedDataMembers { submittedFormData: { rememberDevice: boolean; } | null; } export interface WithRememberOptions extends CustomOptions { rememberDevice?: boolean; } Interface defining the available methods and properties for the mfa-push-challenge-push screen / export interface MfaPushChallengePushMembers extends BaseMembers { screen: ScreenMembersOnMfaPushChallengePush; untrustedData: UntrustedDataMembersOnMfaPushChallengePush; Continues with the push notification challenge - - **Parameter:** Optional custom options to include with the request -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Interface for the screen data specific to mfa-push-challenge-push screen / export interface ScreenMembersOnMfaPushChallengePush extends ScreenMembers { data: { /** The name of the device receiving the push notification */ deviceName: string; /** Whether to show the remember device option */ showRememberDevice?: boolean; } | null; } Interface for untrusted data specific to mfa-push-challenge-push screen / export interface UntrustedDataMembersOnMfaPushChallengePush extends UntrustedDataMembers { submittedFormData: { rememberDevice: boolean; } | null; } export interface WithRememberOptions extends CustomOptions { rememberDevice?: boolean; } Interface defining the available methods and properties for the mfa-push-challenge-push screen / export interface MfaPushChallengePushMembers extends BaseMembers { screen: ScreenMembersOnMfaPushChallengePush; untrustedData: UntrustedDataMembersOnMfaPushChallengePush; Continues with the push notification challenge - - **Parameter:** Optional custom options to include with the request -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-push-challenge-push.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-enrollment-qr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-enrollment-qr.mdx deleted file mode 100644 index 45cd9121f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-enrollment-qr.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: "Mfa Push Enrollment Qr" -description: "The Mfa Push Enrollment Qr screen module provides access to the Mfa Push Enrollment Qr flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaPushEnrollmentQr" type="MfaPushEnrollmentQrMembers"> - Provides access to the Mfa Push Enrollment Qr context and functionality. -</ParamField> - -<ParamField body="pickAuthenticator" type="Function"> - Interface for the screen data specific to mfa-push-enrollment-qr screen / export interface ScreenMembersOnMfaPushEnrollmentQr extends ScreenMembers { data: { qrCode: string; qrUri: string; showCodeCopy: boolean; } | null; } Interface defining the available methods and properties for the mfa-push-enrollment-qr screen / export interface MfaPushEnrollmentQrMembers extends BaseMembers { screen: ScreenMembersOnMfaPushEnrollmentQr; Navigates to the authenticator selection screen. - - **Parameter:** Optional custom options to include with the request -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-push-enrollment-qr.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-list.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-list.mdx deleted file mode 100644 index 48a0747d2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-list.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Mfa Push List" -description: "The Mfa Push List screen module provides access to the Mfa Push List flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaPushList" type="MfaPushListMembers"> - Provides access to the Mfa Push List context and functionality. -</ParamField> - -<ParamField body="selectMfaPushDevice" type="Function"> - Options for selecting an MFA push device. / export interface SelectMfaPushDeviceOptions { The index of the device to select from the list of enrolled devices. The index is 0-based. / deviceIndex: number; [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-push-list screen / export interface MfaPushListMembers extends BaseMembers { Selects a registered device from the list to initiate MFA push. - - **Parameter:** The options containing the device index. -</ParamField> - -<ParamField body="goBack" type="Function"> - Options for selecting an MFA push device. / export interface SelectMfaPushDeviceOptions { The index of the device to select from the list of enrolled devices. The index is 0-based. / deviceIndex: number; [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-push-list screen / export interface MfaPushListMembers extends BaseMembers { Selects a registered device from the list to initiate MFA push. - - **Parameter:** The options containing the device index. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-push-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-welcome.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-welcome.mdx deleted file mode 100644 index 7b4c62a61..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-push-welcome.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Mfa Push Welcome" -description: "The Mfa Push Welcome screen module provides access to the Mfa Push Welcome flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaPushWelcome" type="MfaPushWelcomeMembers"> - Provides access to the Mfa Push Welcome context and functionality. -</ParamField> - -<ParamField body="enroll" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="pickAuthenticator" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-push-welcome.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge-new-code.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge-new-code.mdx deleted file mode 100644 index d4f81e7d6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge-new-code.mdx +++ /dev/null @@ -1,150 +0,0 @@ ---- -title: "Mfa Recovery Code Challenge New Code" -description: "The Mfa Recovery Code Challenge New Code screen module provides access to the Mfa Recovery Code Challenge New Code flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaRecoveryCodeChallengeNewCode" type="MfaRecoveryCodeChallengeNewCodeMembers"> - Provides access to the Mfa Recovery Code Challenge New Code context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-recovery-code-challenge-new-code.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge.mdx deleted file mode 100644 index ba0f6655c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-challenge.mdx +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: "Mfa Recovery Code Challenge" -description: "The Mfa Recovery Code Challenge screen module provides access to the Mfa Recovery Code Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaRecoveryCodeChallenge" type="MfaRecoveryCodeChallengeMembers"> - Provides access to the Mfa Recovery Code Challenge context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Options for continuing with the MFA Recovery Code Challenge. / export interface ContinueOptions extends CustomOptions { code: string; } Interface describing the members of the Mfa Recovery Code Challenge screen. / export interface MfaRecoveryCodeChallengeMembers extends BaseMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; Continues with the provided recovery code. - - **Parameter:** - The continue options containing the recovery code and optional custom options. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-recovery-code-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-enrollment.mdx deleted file mode 100644 index a5e3525dc..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-recovery-code-enrollment.mdx +++ /dev/null @@ -1,150 +0,0 @@ ---- -title: "Mfa Recovery Code Enrollment" -description: "The Mfa Recovery Code Enrollment screen module provides access to the Mfa Recovery Code Enrollment flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaRecoveryCodeEnrollment" type="MfaRecoveryCodeEnrollmentMembers"> - Provides access to the Mfa Recovery Code Enrollment context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-recovery-code-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-challenge.mdx deleted file mode 100644 index 338fda045..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-challenge.mdx +++ /dev/null @@ -1,166 +0,0 @@ ---- -title: "Mfa Sms Challenge" -description: "The Mfa Sms Challenge screen module provides access to the Mfa Sms Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaSmsChallenge" type="MfaSmsChallengeMembers"> - Provides access to the Mfa Sms Challenge context and functionality. -</ParamField> - -<ParamField body="continueMfaSmsChallenge" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="pickSms" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="resendCode" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="getACall" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-sms-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-enrollment.mdx deleted file mode 100644 index b7944c131..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-enrollment.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Mfa Sms Enrollment" -description: "The Mfa Sms Enrollment screen module provides access to the Mfa Sms Enrollment flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaSmsEnrollment" type="MfaSmsEnrollmentMembers"> - Provides access to the Mfa Sms Enrollment context and functionality. -</ParamField> - -<ParamField body="pickCountryCode" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="continueEnrollment" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-sms-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-list.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-list.mdx deleted file mode 100644 index 81e981328..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-sms-list.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Mfa Sms List" -description: "The Mfa Sms List screen module provides access to the Mfa Sms List flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaSmsList" type="MfaSmsListMembers"> - Provides access to the Mfa Sms List context and functionality. -</ParamField> - -<ParamField body="selectPhoneNumber" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="backAction" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-sms-list.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-challenge.mdx deleted file mode 100644 index 297b64a92..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-challenge.mdx +++ /dev/null @@ -1,174 +0,0 @@ ---- -title: "Mfa Voice Challenge" -description: "The Mfa Voice Challenge screen module provides access to the Mfa Voice Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaVoiceChallenge" type="MfaVoiceChallengeMembers"> - Provides access to the Mfa Voice Challenge context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="pickPhone" type="Function"> - Options for submitting the voice challenge code. / export interface MfaVoiceChallengeContinueOptions { The verification code received via voice call. / code: string; Optional flag to remember the device for 30 days, skipping future MFA challenges. / rememberDevice?: boolean; Additional custom options to pass with the request. / [key: string]: string | number | boolean | undefined; } Extended screen members interface for the MFA Voice Challenge screen. / export interface ScreenMembersOnMfaVoiceChallenge extends ScreenMembers { Additional screen data specific to MFA voice challenge. / data: { The phone number where the voice code was sent. / phoneNumber?: string; Whether to show the remember device option. / showRememberDevice?: boolean; Whether to show the link to switch to SMS verification. / showLinkSms?: boolean; } | null; } Interface defining all members and operations available on the MFA Voice Challenge screen. / export interface MfaVoiceChallengeMembers extends BaseMembers { Screen-specific properties and data. / screen: ScreenMembersOnMfaVoiceChallenge; untrustedData: UntrustedDataMembersOnMfaVoiceChallenge; Submits the voice verification code to validate the MFA challenge. - - **Parameter:** - Object containing the verification code and optional parameters -</ParamField> - -<ParamField body="switchToSms" type="Function"> - Options for submitting the voice challenge code. / export interface MfaVoiceChallengeContinueOptions { The verification code received via voice call. / code: string; Optional flag to remember the device for 30 days, skipping future MFA challenges. / rememberDevice?: boolean; Additional custom options to pass with the request. / [key: string]: string | number | boolean | undefined; } Extended screen members interface for the MFA Voice Challenge screen. / export interface ScreenMembersOnMfaVoiceChallenge extends ScreenMembers { Additional screen data specific to MFA voice challenge. / data: { The phone number where the voice code was sent. / phoneNumber?: string; Whether to show the remember device option. / showRememberDevice?: boolean; Whether to show the link to switch to SMS verification. / showLinkSms?: boolean; } | null; } Interface defining all members and operations available on the MFA Voice Challenge screen. / export interface MfaVoiceChallengeMembers extends BaseMembers { Screen-specific properties and data. / screen: ScreenMembersOnMfaVoiceChallenge; untrustedData: UntrustedDataMembersOnMfaVoiceChallenge; Submits the voice verification code to validate the MFA challenge. - - **Parameter:** - Object containing the verification code and optional parameters -</ParamField> - -<ParamField body="resendCode" type="Function"> - Options for submitting the voice challenge code. / export interface MfaVoiceChallengeContinueOptions { The verification code received via voice call. / code: string; Optional flag to remember the device for 30 days, skipping future MFA challenges. / rememberDevice?: boolean; Additional custom options to pass with the request. / [key: string]: string | number | boolean | undefined; } Extended screen members interface for the MFA Voice Challenge screen. / export interface ScreenMembersOnMfaVoiceChallenge extends ScreenMembers { Additional screen data specific to MFA voice challenge. / data: { The phone number where the voice code was sent. / phoneNumber?: string; Whether to show the remember device option. / showRememberDevice?: boolean; Whether to show the link to switch to SMS verification. / showLinkSms?: boolean; } | null; } Interface defining all members and operations available on the MFA Voice Challenge screen. / export interface MfaVoiceChallengeMembers extends BaseMembers { Screen-specific properties and data. / screen: ScreenMembersOnMfaVoiceChallenge; untrustedData: UntrustedDataMembersOnMfaVoiceChallenge; Submits the voice verification code to validate the MFA challenge. - - **Parameter:** - Object containing the verification code and optional parameters -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Options for submitting the voice challenge code. / export interface MfaVoiceChallengeContinueOptions { The verification code received via voice call. / code: string; Optional flag to remember the device for 30 days, skipping future MFA challenges. / rememberDevice?: boolean; Additional custom options to pass with the request. / [key: string]: string | number | boolean | undefined; } Extended screen members interface for the MFA Voice Challenge screen. / export interface ScreenMembersOnMfaVoiceChallenge extends ScreenMembers { Additional screen data specific to MFA voice challenge. / data: { The phone number where the voice code was sent. / phoneNumber?: string; Whether to show the remember device option. / showRememberDevice?: boolean; Whether to show the link to switch to SMS verification. / showLinkSms?: boolean; } | null; } Interface defining all members and operations available on the MFA Voice Challenge screen. / export interface MfaVoiceChallengeMembers extends BaseMembers { Screen-specific properties and data. / screen: ScreenMembersOnMfaVoiceChallenge; untrustedData: UntrustedDataMembersOnMfaVoiceChallenge; Submits the voice verification code to validate the MFA challenge. - - **Parameter:** - Object containing the verification code and optional parameters -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-enrollment.mdx deleted file mode 100644 index 445ed4a2e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-voice-enrollment.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -title: "Mfa Voice Enrollment" -description: "The Mfa Voice Enrollment screen module provides access to the Mfa Voice Enrollment flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaVoiceEnrollment" type="MfaVoiceEnrollmentMembers"> - Provides access to the Mfa Voice Enrollment context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Payload for continuing the MFA Voice Enrollment flow. / export interface ContinueOptions extends CustomOptions { phone: string; } Interface describing the members of the Mfa Voice Enrollment screen. / export interface MfaVoiceEnrollmentMembers extends BaseMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; Continues with the voice enrollment process. - - **Parameter:** - The phone number and optional custom options. -</ParamField> - -<ParamField body="selectPhoneCountryCode" type="Function"> - Payload for continuing the MFA Voice Enrollment flow. / export interface ContinueOptions extends CustomOptions { phone: string; } Interface describing the members of the Mfa Voice Enrollment screen. / export interface MfaVoiceEnrollmentMembers extends BaseMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; Continues with the voice enrollment process. - - **Parameter:** - The phone number and optional custom options. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-voice-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-change-key-nickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-change-key-nickname.mdx deleted file mode 100644 index 2c1f0feda..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-change-key-nickname.mdx +++ /dev/null @@ -1,150 +0,0 @@ ---- -title: "Mfa Webauthn Change Key Nickname" -description: "The Mfa Webauthn Change Key Nickname screen module provides access to the Mfa Webauthn Change Key Nickname flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaWebAuthnChangeKeyNickname" type="MfaWebAuthnChangeKeyNicknameMembers"> - Provides access to the Mfa Webauthn Change Key Nickname context and functionality. -</ParamField> - -<ParamField body="continueWithNewNickname" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-webauthn-change-key-nickname.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-enrollment-success.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-enrollment-success.mdx deleted file mode 100644 index 34eef7402..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-enrollment-success.mdx +++ /dev/null @@ -1,150 +0,0 @@ ---- -title: "Mfa Webauthn Enrollment Success" -description: "The Mfa Webauthn Enrollment Success screen module provides access to the Mfa Webauthn Enrollment Success flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaWebAuthnEnrollmentSuccess" type="MfaWebAuthnEnrollmentSuccessMembers"> - Provides access to the Mfa Webauthn Enrollment Success context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-webauthn-enrollment-success.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-error.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-error.mdx deleted file mode 100644 index f2559e4ef..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-error.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Mfa Webauthn Error" -description: "The Mfa Webauthn Error screen module provides access to the Mfa Webauthn Error flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaWebAuthnError" type="MfaWebAuthnErrorMembers"> - Provides access to the Mfa Webauthn Error context and functionality. -</ParamField> - -<ParamField body="tryAgain" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="noThanks" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-webauthn-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-not-available-error.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-not-available-error.mdx deleted file mode 100644 index c6b3343aa..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-not-available-error.mdx +++ /dev/null @@ -1,150 +0,0 @@ ---- -title: "Mfa Webauthn Not Available Error" -description: "The Mfa Webauthn Not Available Error screen module provides access to the Mfa Webauthn Not Available Error flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaWebAuthnNotAvailableError" type="MfaWebAuthnNotAvailableErrorMembers"> - Provides access to the Mfa Webauthn Not Available Error context and functionality. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-webauthn-not-available-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-challenge.mdx deleted file mode 100644 index e19d6d373..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-challenge.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Mfa Webauthn Platform Challenge" -description: "The Mfa Webauthn Platform Challenge screen module provides access to the Mfa Webauthn Platform Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaWebAuthnPlatformChallenge" type="MfaWebAuthnPlatformChallengeMembers"> - Provides access to the Mfa Webauthn Platform Challenge context and functionality. -</ParamField> - -<ParamField body="verify" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="reportBrowserError" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-webauthn-platform-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-enrollment.mdx deleted file mode 100644 index fb19b295c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-platform-enrollment.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -title: "Mfa Webauthn Platform Enrollment" -description: "The Mfa Webauthn Platform Enrollment screen module provides access to the Mfa Webauthn Platform Enrollment flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaWebAuthnPlatformEnrollment" type="MfaWebAuthnPlatformEnrollmentMembers"> - Provides access to the Mfa Webauthn Platform Enrollment context and functionality. -</ParamField> - -<ParamField body="submitPasskeyCredential" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="reportBrowserError" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="snoozeEnrollment" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="refuseEnrollmentOnThisDevice" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-webauthn-platform-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-challenge.mdx deleted file mode 100644 index 8e667210b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-challenge.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Mfa Webauthn Roaming Challenge" -description: "The Mfa Webauthn Roaming Challenge screen module provides access to the Mfa Webauthn Roaming Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaWebAuthnRoamingChallenge" type="MfaWebAuthnRoamingChallengeMembers"> - Provides access to the Mfa Webauthn Roaming Challenge context and functionality. -</ParamField> - -<ParamField body="verify" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="reportWebAuthnError" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-enrollment.mdx deleted file mode 100644 index 9ad21a4ca..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/mfa-webauthn-roaming-enrollment.mdx +++ /dev/null @@ -1,164 +0,0 @@ ---- -title: "Mfa Webauthn Roaming Enrollment" -description: "The Mfa Webauthn Roaming Enrollment screen module provides access to the Mfa Webauthn Roaming Enrollment flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useMfaWebAuthnRoamingEnrollment" type="MfaWebAuthnRoamingEnrollmentMembers"> - Provides access to the Mfa Webauthn Roaming Enrollment context and functionality. -</ParamField> - -<ParamField body="enroll" type="Function"> - Interface for screen data specific to mfa-webauthn-roaming-enrollment screen. / export interface ScreenMembersOnMfaWebAuthnRoamingEnrollment extends ScreenMembers { webauthnType: string | null; publicKey: PasskeyCreate['public_key'] | null; } Options for submitting a WebAuthn browser error. / export interface ShowErrorOptions { The details of the WebAuthn error. / error: WebAuthnErrorDetails; Any additional custom options. / [key: string]: string | number | boolean | undefined | WebAuthnErrorDetails; } Options for trying another MFA method. / export interface TryAnotherMethodOptions { Any additional custom options. / [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-webauthn-roaming-enrollment screen. / export interface MfaWebAuthnRoamingEnrollmentMembers extends BaseMembers { screen: ScreenMembersOnMfaWebAuthnRoamingEnrollment; Initiates the WebAuthn credential creation and submits the result to the server. This corresponds to the user interacting with the FIDO Security Keys prompt. - - **Parameter:** Optional custom options to include with the request. -</ParamField> - -<ParamField body="showError" type="Function"> - Interface for screen data specific to mfa-webauthn-roaming-enrollment screen. / export interface ScreenMembersOnMfaWebAuthnRoamingEnrollment extends ScreenMembers { webauthnType: string | null; publicKey: PasskeyCreate['public_key'] | null; } Options for submitting a WebAuthn browser error. / export interface ShowErrorOptions { The details of the WebAuthn error. / error: WebAuthnErrorDetails; Any additional custom options. / [key: string]: string | number | boolean | undefined | WebAuthnErrorDetails; } Options for trying another MFA method. / export interface TryAnotherMethodOptions { Any additional custom options. / [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-webauthn-roaming-enrollment screen. / export interface MfaWebAuthnRoamingEnrollmentMembers extends BaseMembers { screen: ScreenMembersOnMfaWebAuthnRoamingEnrollment; Initiates the WebAuthn credential creation and submits the result to the server. This corresponds to the user interacting with the FIDO Security Keys prompt. - - **Parameter:** Optional custom options to include with the request. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Interface for screen data specific to mfa-webauthn-roaming-enrollment screen. / export interface ScreenMembersOnMfaWebAuthnRoamingEnrollment extends ScreenMembers { webauthnType: string | null; publicKey: PasskeyCreate['public_key'] | null; } Options for submitting a WebAuthn browser error. / export interface ShowErrorOptions { The details of the WebAuthn error. / error: WebAuthnErrorDetails; Any additional custom options. / [key: string]: string | number | boolean | undefined | WebAuthnErrorDetails; } Options for trying another MFA method. / export interface TryAnotherMethodOptions { Any additional custom options. / [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the mfa-webauthn-roaming-enrollment screen. / export interface MfaWebAuthnRoamingEnrollmentMembers extends BaseMembers { screen: ScreenMembersOnMfaWebAuthnRoamingEnrollment; Initiates the WebAuthn credential creation and submits the result to the server. This corresponds to the user interacting with the FIDO Security Keys prompt. - - **Parameter:** Optional custom options to include with the request. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/mfa-webauthn-roaming-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-picker.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-picker.mdx deleted file mode 100644 index 2b55aa3fb..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-picker.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Organization Picker" -description: "The Organization Picker screen module provides access to the Organization Picker flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useOrganizationPicker" type="OrganizationPickerMembers"> - Provides access to the Organization Picker context and functionality. -</ParamField> - -<ParamField body="selectOrganization" type="Function"> - Interface defining the available methods and properties for the organization-picker screen / export interface OrganizationPickerMembers extends BaseMembers { Selects an organization for the user. - - **Parameter:** The options containing the organization ID. -</ParamField> - -<ParamField body="skipOrganizationSelection" type="Function"> - Interface defining the available methods and properties for the organization-picker screen / export interface OrganizationPickerMembers extends BaseMembers { Selects an organization for the user. - - **Parameter:** The options containing the organization ID. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/organization-picker.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/organization-picker.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-selection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-selection.mdx deleted file mode 100644 index 016583803..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/organization-selection.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: "Organization Selection" -description: "The Organization Selection screen module provides access to the Organization Selection flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useOrganizationSelection" type="OrganizationSelectionMembers"> - Provides access to the Organization Selection context and functionality. -</ParamField> - -<ParamField body="continueWithOrganizationName" type="Function"> - Options for continuing with the selected organization name. / export interface ContinueWithOrganizationNameOptions { The organization name. / organizationName: string; Any additional custom options. / [key: string]: string | number | boolean | undefined; } Interface for the screen data specific to organization-selection screen. / export interface ScreenMembersOnOrganizationSelection extends ScreenMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; User: UserMembers; } Interface defining the available methods and properties for the organization-selection screen. / export interface OrganizationSelectionMembers extends BaseMembers { The screen properties. / screen: ScreenMembersOnOrganizationSelection; Continues with the selected organization name. - - **Parameter:** The options containing the organization name. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/organization-selection.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/organization-selection.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment-local.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment-local.mdx deleted file mode 100644 index 0a5ef39a7..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment-local.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Passkey Enrollment Local" -description: "The Passkey Enrollment Local screen module provides access to the Passkey Enrollment Local flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="usePasskeyEnrollmentLocal" type="PasskeyEnrollmentLocalMembers"> - Provides access to the Passkey Enrollment Local context and functionality. -</ParamField> - -<ParamField body="continuePasskeyEnrollment" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="abortPasskeyEnrollment" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/passkey-enrollment-local.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment.mdx deleted file mode 100644 index 0d75aed7f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/passkey-enrollment.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Passkey Enrollment" -description: "The Passkey Enrollment screen module provides access to the Passkey Enrollment flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="usePasskeyEnrollment" type="PasskeyEnrollmentMembers"> - Provides access to the Passkey Enrollment context and functionality. -</ParamField> - -<ParamField body="continuePasskeyEnrollment" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="abortPasskeyEnrollment" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/passkey-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-challenge.mdx deleted file mode 100644 index 5c8a050b2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-challenge.mdx +++ /dev/null @@ -1,166 +0,0 @@ ---- -title: "Phone Identifier Challenge" -description: "The Phone Identifier Challenge screen module provides access to the Phone Identifier Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="usePhoneIdentifierChallenge" type="PhoneIdentifierChallengeMembers"> - Provides access to the Phone Identifier Challenge context and functionality. -</ParamField> - -<ParamField body="submitPhoneChallenge" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="resendCode" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="returnToPrevious" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="switchToVoice" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="switchToText" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/phone-identifier-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-enrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-enrollment.mdx deleted file mode 100644 index fab846ccc..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/phone-identifier-enrollment.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Phone Identifier Enrollment" -description: "The Phone Identifier Enrollment screen module provides access to the Phone Identifier Enrollment flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="usePhoneIdentifierEnrollment" type="PhoneIdentifierEnrollmentMembers"> - Provides access to the Phone Identifier Enrollment context and functionality. -</ParamField> - -<ParamField body="continuePhoneEnrollment" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="returnToPrevious" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/phone-identifier-enrollment.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/redeem-ticket.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/redeem-ticket.mdx deleted file mode 100644 index d056b52e6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/redeem-ticket.mdx +++ /dev/null @@ -1,150 +0,0 @@ ---- -title: "Redeem Ticket" -description: "The Redeem Ticket screen module provides access to the Redeem Ticket flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useRedeemTicket" type="RedeemTicketMembers"> - Provides access to the Redeem Ticket context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/redeem-ticket.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/redeem-ticket.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-email.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-email.mdx deleted file mode 100644 index 249ac29ff..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-email.mdx +++ /dev/null @@ -1,150 +0,0 @@ ---- -title: "Reset Password Email" -description: "The Reset Password Email screen module provides access to the Reset Password Email flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useResetPasswordEmail" type="ResetPasswordEmailMembers"> - Provides access to the Reset Password Email context and functionality. -</ParamField> - -<ParamField body="resendEmail" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/reset-password-email.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-email.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-error.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-error.mdx deleted file mode 100644 index 4bd145cdd..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-error.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: "Reset Password Error" -description: "The Reset Password Error screen module provides access to the Reset Password Error flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useResetPasswordError" type="ResetPasswordErrorMembers"> - Provides access to the Reset Password Error context and functionality. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/reset-password-error.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-error.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-email-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-email-challenge.mdx deleted file mode 100644 index 4e55b011b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-email-challenge.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -title: "Reset Password Mfa Email Challenge" -description: "The Reset Password Mfa Email Challenge screen module provides access to the Reset Password Mfa Email Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useResetPasswordMfaEmailChallenge" type="ResetPasswordMfaEmailChallengeMembers"> - Provides access to the Reset Password Mfa Email Challenge context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="resendCode" type="Function"> - Interface for the screen data specific to reset-password-mfa-email-challenge screen / export interface ScreenMembersOnResetPasswordMfaEmailChallenge extends ScreenMembers { data: { email: string; } | null; } Options for continuing with the email challenge. / export interface ContinueOptions { /** The code entered by the user. */ code: string; /** Indicates whether to remember the device. */ rememberDevice?: boolean; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for resending the email code. / export interface ResendCodeOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for trying another method. / export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the reset-password-mfa-email-challenge screen / export interface ResetPasswordMfaEmailChallengeMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaEmailChallenge; Continues with the email challenge using the provided code. - - **Parameter:** The options containing the code and rememberDevice flag. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Interface for the screen data specific to reset-password-mfa-email-challenge screen / export interface ScreenMembersOnResetPasswordMfaEmailChallenge extends ScreenMembers { data: { email: string; } | null; } Options for continuing with the email challenge. / export interface ContinueOptions { /** The code entered by the user. */ code: string; /** Indicates whether to remember the device. */ rememberDevice?: boolean; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for resending the email code. / export interface ResendCodeOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for trying another method. / export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the reset-password-mfa-email-challenge screen / export interface ResetPasswordMfaEmailChallengeMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaEmailChallenge; Continues with the email challenge using the provided code. - - **Parameter:** The options containing the code and rememberDevice flag. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/reset-password-mfa-email-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-otp-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-otp-challenge.mdx deleted file mode 100644 index 60982e380..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-otp-challenge.mdx +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: "Reset Password Mfa Otp Challenge" -description: "The Reset Password Mfa Otp Challenge screen module provides access to the Reset Password Mfa Otp Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useResetPasswordMfaOtpChallenge" type="ResetPasswordMfaOtpChallengeMembers"> - Provides access to the Reset Password Mfa Otp Challenge context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Options for continuing with the OTP challenge. / export interface ContinueOptions { /** The code entered by the user. */ code: string; /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Options for trying another method. / export interface TryAnotherMethodOptions { /** Any additional custom options */ [key: string]: string | number | boolean | undefined; } Interface defining the available methods and properties for the reset-password-mfa-otp-challenge screen / export interface ResetPasswordMfaOtpChallengeMembers extends BaseMembers { Continues with the OTP challenge using the provided code. - - **Parameter:** The options containing the code. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/reset-password-mfa-otp-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-phone-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-phone-challenge.mdx deleted file mode 100644 index 700ca21d9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-phone-challenge.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Reset Password Mfa Phone Challenge" -description: "The Reset Password Mfa Phone Challenge screen module provides access to the Reset Password Mfa Phone Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useResetPasswordMfaPhoneChallenge" type="ResetPasswordMfaPhoneChallengeMembers"> - Provides access to the Reset Password Mfa Phone Challenge context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/reset-password-mfa-phone-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-push-challenge-push.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-push-challenge-push.mdx deleted file mode 100644 index 94f0eaab0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-push-challenge-push.mdx +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: "Reset Password Mfa Push Challenge Push" -description: "The Reset Password Mfa Push Challenge Push screen module provides access to the Reset Password Mfa Push Challenge Push flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useResetPasswordMfaPushChallengePush" type="ResetPasswordMfaPushChallengePushMembers"> - Provides access to the Reset Password Mfa Push Challenge Push context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="resendPushNotification" type="Function"> - Interface for the screen data specific to reset-password-mfa-push-challenge-push screen / export interface ScreenMembersOnResetPasswordMfaPushChallengePush extends ScreenMembers { data: { deviceName: string; rememberDevice?: boolean; } | null; } Interface defining the available methods and properties for the reset-password-mfa-push-challenge-push screen / export interface ResetPasswordMfaPushChallengePushMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaPushChallengePush; Continues with the push notification challenge - - **Parameter:** Optional custom options to include with the request -</ParamField> - -<ParamField body="enterCodeManually" type="Function"> - Interface for the screen data specific to reset-password-mfa-push-challenge-push screen / export interface ScreenMembersOnResetPasswordMfaPushChallengePush extends ScreenMembers { data: { deviceName: string; rememberDevice?: boolean; } | null; } Interface defining the available methods and properties for the reset-password-mfa-push-challenge-push screen / export interface ResetPasswordMfaPushChallengePushMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaPushChallengePush; Continues with the push notification challenge - - **Parameter:** Optional custom options to include with the request -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Interface for the screen data specific to reset-password-mfa-push-challenge-push screen / export interface ScreenMembersOnResetPasswordMfaPushChallengePush extends ScreenMembers { data: { deviceName: string; rememberDevice?: boolean; } | null; } Interface defining the available methods and properties for the reset-password-mfa-push-challenge-push screen / export interface ResetPasswordMfaPushChallengePushMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaPushChallengePush; Continues with the push notification challenge - - **Parameter:** Optional custom options to include with the request -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/reset-password-mfa-push-challenge-push.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-recovery-code-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-recovery-code-challenge.mdx deleted file mode 100644 index d6d95a48d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-recovery-code-challenge.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Reset Password Mfa Recovery Code Challenge" -description: "The Reset Password Mfa Recovery Code Challenge screen module provides access to the Reset Password Mfa Recovery Code Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useResetPasswordMfaRecoveryCodeChallenge" type="ResetPasswordMfaRecoveryCodeChallengeMembers"> - Provides access to the Reset Password Mfa Recovery Code Challenge context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Interface describing the members of the Mfa Recovery Code Challenge screen. / export interface ResetPasswordMfaRecoveryCodeChallengeMembers extends BaseMembers { client: ClientMembers; organization: OrganizationMembers; prompt: PromptMembers; screen: ScreenMembers; transaction: TransactionMembers; Continues with the provided recovery code. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/reset-password-mfa-recovery-code-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-sms-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-sms-challenge.mdx deleted file mode 100644 index f0a62610c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-sms-challenge.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -title: "Reset Password Mfa Sms Challenge" -description: "The Reset Password Mfa Sms Challenge screen module provides access to the Reset Password Mfa Sms Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useResetPasswordMfaSmsChallenge" type="ResetPasswordMfaSmsChallengeMembers"> - Provides access to the Reset Password Mfa Sms Challenge context and functionality. -</ParamField> - -<ParamField body="continueMfaSmsChallenge" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="resendCode" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="getACall" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/reset-password-mfa-sms-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-voice-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-voice-challenge.mdx deleted file mode 100644 index c143db252..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-voice-challenge.mdx +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: "Reset Password Mfa Voice Challenge" -description: "The Reset Password Mfa Voice Challenge screen module provides access to the Reset Password Mfa Voice Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useResetPasswordMfaVoiceChallenge" type="ResetPasswordMfaVoiceChallengeMembers"> - Provides access to the Reset Password Mfa Voice Challenge context and functionality. -</ParamField> - -<ParamField body="continueMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="switchToSms" type="Function"> - Interface for the screen data specific to reset-password-mfa-voice-challenge screen. / export interface ScreenMembersOnResetPasswordMfaVoiceChallenge extends ScreenMembers { data: { The phone number to send the voice call to. / phoneNumber: string; Whether to show the link to switch to SMS verification. / showLinkSms?: boolean; } | null; } Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers. / export interface ContinueOptions extends CustomOptions { The OTP code entered by the user. / code: string; } Interface defining the available methods and properties for the reset-password-mfa-voice-challenge screen. / export interface ResetPasswordMfaVoiceChallengeMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaVoiceChallenge; Continues with the voice challenge using the provided code. - - **Parameter:** - The options containing the code. -</ParamField> - -<ParamField body="resendCode" type="Function"> - Interface for the screen data specific to reset-password-mfa-voice-challenge screen. / export interface ScreenMembersOnResetPasswordMfaVoiceChallenge extends ScreenMembers { data: { The phone number to send the voice call to. / phoneNumber: string; Whether to show the link to switch to SMS verification. / showLinkSms?: boolean; } | null; } Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers. / export interface ContinueOptions extends CustomOptions { The OTP code entered by the user. / code: string; } Interface defining the available methods and properties for the reset-password-mfa-voice-challenge screen. / export interface ResetPasswordMfaVoiceChallengeMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaVoiceChallenge; Continues with the voice challenge using the provided code. - - **Parameter:** - The options containing the code. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Interface for the screen data specific to reset-password-mfa-voice-challenge screen. / export interface ScreenMembersOnResetPasswordMfaVoiceChallenge extends ScreenMembers { data: { The phone number to send the voice call to. / phoneNumber: string; Whether to show the link to switch to SMS verification. / showLinkSms?: boolean; } | null; } Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers. / export interface ContinueOptions extends CustomOptions { The OTP code entered by the user. / code: string; } Interface defining the available methods and properties for the reset-password-mfa-voice-challenge screen. / export interface ResetPasswordMfaVoiceChallengeMembers extends BaseMembers { screen: ScreenMembersOnResetPasswordMfaVoiceChallenge; Continues with the voice challenge using the provided code. - - **Parameter:** - The options containing the code. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/reset-password-mfa-voice-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-platform-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-platform-challenge.mdx deleted file mode 100644 index 11dc2303b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-platform-challenge.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Reset Password Mfa Webauthn Platform Challenge" -description: "The Reset Password Mfa Webauthn Platform Challenge screen module provides access to the Reset Password Mfa Webauthn Platform Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useResetPasswordMfaWebAuthnPlatformChallenge" type="ResetPasswordMfaWebAuthnPlatformChallengeMembers"> - Provides access to the Reset Password Mfa Webauthn Platform Challenge context and functionality. -</ParamField> - -<ParamField body="continueWithPasskey" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="reportBrowserError" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/reset-password-mfa-webauthn-platform-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-roaming-challenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-roaming-challenge.mdx deleted file mode 100644 index 61f7477e7..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-mfa-webauthn-roaming-challenge.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Reset Password Mfa Webauthn Roaming Challenge" -description: "The Reset Password Mfa Webauthn Roaming Challenge screen module provides access to the Reset Password Mfa Webauthn Roaming Challenge flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useResetPasswordMfaWebAuthnRoamingChallenge" type="ResetPasswordMfaWebAuthnRoamingChallengeMembers"> - Provides access to the Reset Password Mfa Webauthn Roaming Challenge context and functionality. -</ParamField> - -<ParamField body="showError" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="tryAnotherMethod" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-request.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-request.mdx deleted file mode 100644 index 6c7b1d50e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-request.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Reset Password Request" -description: "The Reset Password Request screen module provides access to the Reset Password Request flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useResetPasswordRequest" type="ResetPasswordRequestMembers"> - Provides access to the Reset Password Request context and functionality. -</ParamField> - -<ParamField body="resetPassword" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="backToLogin" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/reset-password-request.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-request.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-success.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-success.mdx deleted file mode 100644 index d02568ecb..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password-success.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: "Reset Password Success" -description: "The Reset Password Success screen module provides access to the Reset Password Success flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useResetPasswordSuccess" type="ResetPasswordSuccessMembers"> - Provides access to the Reset Password Success context and functionality. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/reset-password-success.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password-success.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password.mdx deleted file mode 100644 index a7295bdd9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/reset-password.mdx +++ /dev/null @@ -1,150 +0,0 @@ ---- -title: "Reset Password" -description: "The Reset Password screen module provides access to the Reset Password flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useResetPassword" type="ResetPasswordMembers"> - Provides access to the Reset Password context and functionality. -</ParamField> - -<ParamField body="resetPassword" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/reset-password.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/reset-password.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-id.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-id.mdx deleted file mode 100644 index d847905d6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-id.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Signup Id" -description: "The Signup Id screen module provides access to the Signup Id flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useSignupId" type="SignupIdMembers"> - Provides access to the Signup Id context and functionality. -</ParamField> - -<ParamField body="signup" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="federatedSignup" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="pickCountryCode" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/signup-id.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup-id.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-password.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-password.mdx deleted file mode 100644 index f876b5019..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup-password.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "Signup Password" -description: "The Signup Password screen module provides access to the Signup Password flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useSignupPassword" type="SignupPasswordMembers"> - Provides access to the Signup Password context and functionality. -</ParamField> - -<ParamField body="signup" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="federatedSignup" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/signup-password.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup-password.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup.mdx deleted file mode 100644 index f53372f6b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/screens/signup.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Signup" -description: "The Signup screen module provides access to the Signup flow." ---- - -## Variables - -<ParamField body="useUser" type="User"> - Hook to access user information and profile data. - - Returns User object containing profile information, attributes, and user-specific data - - ```jsx example - import { useUser } from '@auth0/auth0-acul-react/login-id'; - function UserProfile() { - const user = useUser(); - } - ``` -</ParamField> - -<ParamField body="useTenant" type="Tenant"> - Hook to access tenant configuration and settings. - - Returns Tenant object containing domain, region, and tenant-specific configuration - - ```jsx example - import { useTenant } from '@auth0/auth0-acul-react/login-id'; - function TenantInfo() { - const tenant = useTenant(); - } - ``` -</ParamField> - -<ParamField body="useBranding" type="Branding"> - Hook to access branding and theme configuration. - - Returns Branding object containing colors, logos, fonts, and visual customization settings - - ```jsx example - import { useBranding } from '@auth0/auth0-acul-react/login-id'; - function CustomTheme() { - const branding = useBranding(); - } - ``` -</ParamField> - -<ParamField body="useClient" type="Client"> - Hook to access Auth0 application (client) configuration. - - Returns Client object containing application settings, callbacks, and client-specific data - - ```jsx example - import { useClient } from '@auth0/auth0-acul-react/login-id'; - function AppInfo() { - const client = useClient(); - } - ``` -</ParamField> - -<ParamField body="useOrganization" type="Organization"> - Hook to access organization context and settings. - - Returns Organization object containing org-specific data, metadata, and configuration - - ```jsx example - import { useOrganization } from '@auth0/auth0-acul-react/login-id'; - function OrgSelector() { - const organization = useOrganization(); - if (!organization) { - return <p>No organization context</p>; - } - } - ``` -</ParamField> - -<ParamField body="usePrompt" type="Prompt"> - Hook to access prompt configuration and flow settings. - - Returns Prompt object containing flow configuration, screen settings, and prompt-specific data - - ```jsx example - import { usePrompt } from '@auth0/auth0-acul-react/login-id'; - function FlowInfo() { - const prompt = usePrompt(); - } - ``` -</ParamField> - -<ParamField body="useScreen" type="Screen"> - Hook to access current screen information and metadata. - - Returns Screen object containing current screen name, configuration, and screen-specific data - - ```jsx example - import { useScreen } from '@auth0/auth0-acul-react/login-id'; - function ScreenDebug() { - const screen = useScreen(); - } - ``` -</ParamField> - -<ParamField body="useTransaction" type="Transaction"> - Hook to access transaction state and authentication flow data. - - Returns Transaction object containing flow state, session data, and transaction-specific information - - ```jsx example - import { useTransaction } from '@auth0/auth0-acul-react/login-id'; - function TransactionInfo() { - const transaction = useTransaction(); - } - ``` -</ParamField> - -<ParamField body="useUntrustedData" type="UntrustedData"> - Hook to access untrusted data from URL parameters and form submissions. - - Returns Object containing untrusted user input that should be validated before use - - ```jsx example - import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; - function PrefilledForm() { - const untrustedData = useUntrustedData(); - } - ``` -</ParamField> - -## Functions - -<ParamField body="useSignup" type="SignupMembers"> - Provides access to the Signup context and functionality. -</ParamField> - -<ParamField body="signup" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="federatedSignup" type="Function"> - Function exported from this screen module. -</ParamField> - -<ParamField body="pickCountryCode" type="Function"> - Function exported from this screen module. -</ParamField> - -## References - -- useCurrentScreen → Hooks.useCurrentScreen -- useErrors → Hooks.useErrors -- useAuth0Themes → Hooks.useAuth0Themes -- UseErrorOptions → Hooks.UseErrorOptions -- UseErrorsResult → Hooks.UseErrorsResult -- ErrorsResult → Hooks.ErrorsResult -- ErrorKind → Hooks.ErrorKind - ---- - -**File:** [src/screens/signup.tsx](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/screens/signup.tsx) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Bucket.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Bucket.mdx deleted file mode 100644 index 63ba105cf..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Bucket.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Bucket" -description: "" ---- - -## Type Definition - -```typescript -type Bucket = { - server: ReadonlyArray<ErrorItem>; - client: ReadonlyArray<ErrorItem>; - developer: ReadonlyArray<ErrorItem>; -}; -``` - ---- - -**File:** [src/state/error-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/error-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ErrorKind.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ErrorKind.mdx deleted file mode 100644 index 8a06a84c4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ErrorKind.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "ErrorKind" -description: "" ---- - -## Type Definition - -```typescript -type ErrorKind = 'server' | 'client' | 'developer'; -``` - ---- - -**File:** [src/state/error-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/error-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Listener.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Listener.mdx deleted file mode 100644 index 1cf89ca41..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/Listener.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Listener" -description: "" ---- - -## Type Definition - -```typescript -type Listener = () => void; -``` - ---- - -**File:** [src/state/error-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/error-store.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ScreenConstructor.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ScreenConstructor.mdx deleted file mode 100644 index 3c69cec9a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/types/ScreenConstructor.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "ScreenConstructor" -description: "" ---- - -## Type Definition - -```typescript -type ScreenConstructor = { new (): T; screenIdentifier: string }; -``` - ---- - -**File:** [src/state/instance-store.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-react/src/state/instance-store.ts) From 3a7bdcdad5f3dea4d73619b84aa156ccf6d4555b Mon Sep 17 00:00:00 2001 From: gabrielraeder <gabrielraeder@outlook.com.br> Date: Thu, 13 Nov 2025 16:08:18 -0300 Subject: [PATCH 3/7] update links in react sdk --- main/docs.json | 606 +++++++++--------- .../react-sdk/API-Reference/Hooks/index.mdx | 15 + .../API-Reference/Hooks/useAuth0Themes.mdx | 4 +- .../API-Reference/Hooks/useCurrentScreen.mdx | 4 +- .../API-Reference/Hooks/useErrors.mdx | 10 +- .../Hooks/useLoginIdentifiers.mdx | 6 +- .../API-Reference/Hooks/useMfaPolling.mdx | 12 +- .../Hooks/usePasswordValidation.mdx | 6 +- .../API-Reference/Hooks/useResend.mdx | 6 +- .../Hooks/useSignupIdentifiers.mdx | 6 +- .../Hooks/useUsernameValidation.mdx | 6 +- .../Screens/accept-invitation/index.mdx | 76 +-- .../API-Reference/Screens/consent/index.mdx | 78 +-- .../Screens/customized-consent/index.mdx | 78 +-- .../device-code-activation-allowed/index.mdx | 74 +-- .../device-code-activation-denied/index.mdx | 74 +-- .../Screens/device-code-activation/index.mdx | 76 +-- .../device-code-confirmation/index.mdx | 78 +-- .../email-identifier-challenge/index.mdx | 82 +-- .../Screens/email-otp-challenge/index.mdx | 80 +-- .../email-verification-result/index.mdx | 74 +-- .../react-sdk/API-Reference/Screens/index.mdx | 82 +++ .../Screens/interstitial-captcha/index.mdx | 74 +-- .../login-email-verification/index.mdx | 80 +-- .../API-Reference/Screens/login-id/index.mdx | 84 +-- .../Screens/login-password/index.mdx | 78 +-- .../login-passwordless-email-code/index.mdx | 80 +-- .../login-passwordless-sms-otp/index.mdx | 80 +-- .../API-Reference/Screens/login/index.mdx | 82 +-- .../Screens/logout-aborted/index.mdx | 74 +-- .../Screens/logout-complete/index.mdx | 74 +-- .../API-Reference/Screens/logout/index.mdx | 76 +-- .../mfa-begin-enroll-options/index.mdx | 76 +-- .../Screens/mfa-country-codes/index.mdx | 78 +-- .../mfa-detect-browser-capabilities/index.mdx | 76 +-- .../Screens/mfa-email-challenge/index.mdx | 84 +-- .../Screens/mfa-email-list/index.mdx | 78 +-- .../Screens/mfa-enroll-result/index.mdx | 74 +-- .../Screens/mfa-login-options/index.mdx | 78 +-- .../Screens/mfa-otp-challenge/index.mdx | 78 +-- .../Screens/mfa-otp-enrollment-code/index.mdx | 78 +-- .../Screens/mfa-otp-enrollment-qr/index.mdx | 80 +-- .../Screens/mfa-phone-challenge/index.mdx | 80 +-- .../Screens/mfa-phone-enrollment/index.mdx | 80 +-- .../Screens/mfa-push-challenge-push/index.mdx | 84 +-- .../Screens/mfa-push-enrollment-qr/index.mdx | 78 +-- .../Screens/mfa-push-list/index.mdx | 78 +-- .../Screens/mfa-push-welcome/index.mdx | 78 +-- .../index.mdx | 76 +-- .../mfa-recovery-code-challenge/index.mdx | 78 +-- .../mfa-recovery-code-enrollment/index.mdx | 76 +-- .../Screens/mfa-sms-challenge/index.mdx | 86 +-- .../Screens/mfa-sms-enrollment/index.mdx | 78 +-- .../Screens/mfa-sms-list/index.mdx | 78 +-- .../Screens/mfa-voice-challenge/index.mdx | 86 +-- .../Screens/mfa-voice-enrollment/index.mdx | 80 +-- .../index.mdx | 76 +-- .../mfa-webauthn-enrollment-success/index.mdx | 76 +-- .../Screens/mfa-webauthn-error/index.mdx | 82 +-- .../index.mdx | 76 +-- .../mfa-webauthn-platform-challenge/index.mdx | 80 +-- .../index.mdx | 82 +-- .../mfa-webauthn-roaming-challenge/index.mdx | 80 +-- .../mfa-webauthn-roaming-enrollment/index.mdx | 80 +-- .../Screens/organization-picker/index.mdx | 76 +-- .../Screens/organization-selection/index.mdx | 76 +-- .../passkey-enrollment-local/index.mdx | 78 +-- .../Screens/passkey-enrollment/index.mdx | 78 +-- .../phone-identifier-challenge/index.mdx | 86 +-- .../phone-identifier-enrollment/index.mdx | 78 +-- .../Screens/redeem-ticket/index.mdx | 76 +-- .../Screens/reset-password-email/index.mdx | 76 +-- .../Screens/reset-password-error/index.mdx | 74 +-- .../index.mdx | 82 +-- .../index.mdx | 78 +-- .../index.mdx | 78 +-- .../index.mdx | 84 +-- .../index.mdx | 78 +-- .../index.mdx | 84 +-- .../index.mdx | 84 +-- .../index.mdx | 80 +-- .../index.mdx | 80 +-- .../Screens/reset-password-request/index.mdx | 80 +-- .../Screens/reset-password-success/index.mdx | 74 +-- .../Screens/reset-password/index.mdx | 78 +-- .../API-Reference/Screens/signup-id/index.mdx | 84 +-- .../Screens/signup-password/index.mdx | 80 +-- .../API-Reference/Screens/signup/index.mdx | 86 +-- .../Types/classes/ContextHooks.mdx | 2 +- .../react-sdk/API-Reference/Types/index.mdx | 596 ++++++++--------- .../interfaces/AcceptInvitationMembers.mdx | 58 +- .../Types/interfaces/AllowCredential.mdx | 4 +- .../Types/interfaces/BaseMembers.mdx | 188 +++--- .../Types/interfaces/BrandingMembers.mdx | 8 +- .../Types/interfaces/ConfirmLogoutOptions.mdx | 2 +- .../Types/interfaces/Connection.mdx | 2 +- .../Types/interfaces/ConsentMembers.mdx | 60 +- .../ContinueWithCodeOptionPayload.mdx | 2 +- .../Types/interfaces/CurrentScreenOptions.mdx | 4 +- .../Types/interfaces/CustomOptions.mdx | 58 +- .../interfaces/CustomizedConsentMembers.mdx | 60 +- .../DeviceCodeActivationAllowedMembers.mdx | 56 +- .../DeviceCodeActivationContinueOptions.mdx | 2 +- .../DeviceCodeActivationDeniedMembers.mdx | 56 +- .../DeviceCodeActivationMembers.mdx | 58 +- .../DeviceCodeConfirmationMembers.mdx | 60 +- .../EmailIdentifierChallengeMembers.mdx | 68 +- .../interfaces/EmailOTPChallengeMembers.mdx | 66 +- .../EmailVerificationResultMembers.mdx | 56 +- .../Types/interfaces/EnterpriseConnection.mdx | 8 +- .../API-Reference/Types/interfaces/Error.mdx | 6 +- .../Types/interfaces/ErrorItem.mdx | 18 +- .../Types/interfaces/ErrorsResult.mdx | 16 +- .../Types/interfaces/Identifier.mdx | 4 +- .../interfaces/InterstitialCaptchaMembers.mdx | 58 +- .../LoginEmailVerificationMembers.mdx | 66 +- .../Types/interfaces/LoginEnrollOptions.mdx | 4 +- .../Types/interfaces/LoginIdMembers.mdx | 68 +- .../Types/interfaces/LoginMembers.mdx | 66 +- .../Types/interfaces/LoginPasswordMembers.mdx | 60 +- .../LoginPasswordlessEmailCodeMembers.mdx | 66 +- .../LoginPasswordlessSmsOtpMembers.mdx | 66 +- .../Types/interfaces/LogoutAbortedMembers.mdx | 56 +- .../interfaces/LogoutCompleteMembers.mdx | 56 +- .../Types/interfaces/LogoutMembers.mdx | 58 +- .../MfaBeginEnrollOptionsMembers.mdx | 58 +- .../interfaces/MfaCountryCodesMembers.mdx | 60 +- .../MfaDetectBrowserCapabilitiesMembers.mdx | 58 +- .../interfaces/MfaEmailChallengeMembers.mdx | 70 +- .../Types/interfaces/MfaEmailListMembers.mdx | 60 +- .../Types/interfaces/MfaEnrollOptions.mdx | 4 +- .../interfaces/MfaEnrollResultMembers.mdx | 56 +- .../interfaces/MfaLoginOptionsMembers.mdx | 60 +- .../interfaces/MfaOtpChallengeMembers.mdx | 60 +- .../MfaOtpEnrollmentCodeMembers.mdx | 60 +- .../MfaOtpEnrollmentQrContinueOptions.mdx | 2 +- .../interfaces/MfaOtpEnrollmentQrMembers.mdx | 62 +- .../MfaPhoneChallengeContinueOptions.mdx | 2 +- .../interfaces/MfaPhoneChallengeMembers.mdx | 62 +- ...PhoneChallengePickAuthenticatorOptions.mdx | 2 +- .../MfaPhoneChallengePickPhoneOptions.mdx | 2 +- .../MfaPhoneEnrollmentContinueOptions.mdx | 2 +- .../interfaces/MfaPhoneEnrollmentMembers.mdx | 62 +- .../Types/interfaces/MfaPollingResult.mdx | 2 +- .../MfaPushChallengePushMembers.mdx | 72 +-- .../interfaces/MfaPushEnrollmentQrMembers.mdx | 64 +- .../Types/interfaces/MfaPushListMembers.mdx | 60 +- .../interfaces/MfaPushWelcomeMembers.mdx | 60 +- ...faRecoveryCodeChallengeContinueOptions.mdx | 2 +- .../MfaRecoveryCodeChallengeMembers.mdx | 60 +- ...eryCodeChallengeNewCodeContinueOptions.mdx | 2 +- ...MfaRecoveryCodeChallengeNewCodeMembers.mdx | 58 +- ...aRecoveryCodeEnrollmentContinueOptions.mdx | 2 +- .../MfaRecoveryCodeEnrollmentMembers.mdx | 58 +- .../interfaces/MfaSmsChallengeMembers.mdx | 72 +-- .../interfaces/MfaSmsEnrollmentMembers.mdx | 60 +- .../Types/interfaces/MfaSmsListMembers.mdx | 60 +- .../interfaces/MfaVoiceChallengeMembers.mdx | 72 +-- .../MfaVoiceEnrollmentContinueOptions.mdx | 2 +- .../interfaces/MfaVoiceEnrollmentMembers.mdx | 62 +- ...bAuthnChangeKeyNicknameContinueOptions.mdx | 2 +- .../MfaWebAuthnChangeKeyNicknameMembers.mdx | 58 +- .../MfaWebAuthnEnrollmentSuccessMembers.mdx | 58 +- .../interfaces/MfaWebAuthnErrorMembers.mdx | 64 +- .../MfaWebAuthnNotAvailableErrorMembers.mdx | 58 +- .../MfaWebAuthnPlatformChallengeMembers.mdx | 62 +- ...thnPlatformChallengeReportErrorOptions.mdx | 4 +- ...atformChallengeTryAnotherMethodOptions.mdx | 2 +- .../MfaWebAuthnPlatformEnrollmentMembers.mdx | 64 +- .../MfaWebAuthnRoamingChallengeMembers.mdx | 62 +- ...uthnRoamingChallengeReportErrorOptions.mdx | 4 +- ...oamingChallengeTryAnotherMethodOptions.mdx | 2 +- .../MfaWebAuthnRoamingEnrollmentMembers.mdx | 62 +- .../Types/interfaces/OrganizationMembers.mdx | 4 +- .../interfaces/OrganizationPickerMembers.mdx | 58 +- .../OrganizationSelectionMembers.mdx | 58 +- .../Types/interfaces/Organizations.mdx | 4 +- .../Types/interfaces/OtpCodeOptions.mdx | 2 +- .../interfaces/PasskeyCreateResponse.mdx | 4 +- .../PasskeyEnrollmentLocalMembers.mdx | 60 +- .../interfaces/PasskeyEnrollmentMembers.mdx | 60 +- .../Types/interfaces/PasswordPolicy.mdx | 4 +- .../interfaces/PasswordValidationResult.mdx | 10 +- .../PhoneIdentifierChallengeMembers.mdx | 72 +-- .../PhoneIdentifierEnrollmentMembers.mdx | 60 +- .../Types/interfaces/RedeemTicketMembers.mdx | 58 +- .../interfaces/ResendCodeOptionsPayload.mdx | 2 +- .../interfaces/ResetPasswordEmailMembers.mdx | 58 +- .../interfaces/ResetPasswordErrorMembers.mdx | 56 +- .../Types/interfaces/ResetPasswordMembers.mdx | 62 +- .../ResetPasswordMfaEmailChallengeMembers.mdx | 68 +- .../ResetPasswordMfaOtpChallengeMembers.mdx | 60 +- ...sswordMfaPhoneChallengeContinueOptions.mdx | 2 +- .../ResetPasswordMfaPhoneChallengeMembers.mdx | 60 +- ...aPhoneChallengeTryAnotherMethodOptions.mdx | 2 +- ...setPasswordMfaPushChallengePushMembers.mdx | 72 +-- ...asswordMfaRecoveryCodeChallengeMembers.mdx | 60 +- .../ResetPasswordMfaSmsChallengeMembers.mdx | 70 +- ...sswordMfaVoiceChallengeContinueOptions.mdx | 2 +- .../ResetPasswordMfaVoiceChallengeMembers.mdx | 70 +- ...bAuthnPlatformChallengeContinueOptions.mdx | 2 +- ...ordMfaWebAuthnPlatformChallengeMembers.mdx | 62 +- ...thnPlatformChallengeReportErrorOptions.mdx | 4 +- ...atformChallengeTryAnotherMethodOptions.mdx | 2 +- ...wordMfaWebAuthnRoamingChallengeMembers.mdx | 62 +- ...bAuthnRoamingChallengeShowErrorOptions.mdx | 4 +- ...oamingChallengeTryAnotherMethodOptions.mdx | 2 +- ...nRoamingChallengeUseSecurityKeyOptions.mdx | 2 +- .../ResetPasswordRequestMembers.mdx | 64 +- .../ResetPasswordSuccessMembers.mdx | 56 +- .../Types/interfaces/ScreenMembers.mdx | 118 ++-- .../ScreenMembersOnAcceptInvitation.mdx | 24 +- .../interfaces/ScreenMembersOnConsent.mdx | 30 +- .../ScreenMembersOnCustomizedConsent.mdx | 34 +- .../ScreenMembersOnDeviceCodeConfirmation.mdx | 24 +- ...creenMembersOnEmailIdentifierChallenge.mdx | 24 +- .../ScreenMembersOnEmailOTPChallenge.mdx | 26 +- ...ScreenMembersOnEmailVerificationResult.mdx | 24 +- .../Types/interfaces/ScreenMembersOnLogin.mdx | 24 +- .../interfaces/ScreenMembersOnLoginId.mdx | 30 +- .../ScreenMembersOnLoginPassword.mdx | 24 +- ...eenMembersOnLoginPasswordlessEmailCode.mdx | 24 +- ...ScreenMembersOnLoginPasswordlessSmsOtp.mdx | 24 +- .../ScreenMembersOnMfaCountryCodes.mdx | 32 +- .../ScreenMembersOnMfaEmailChallenge.mdx | 24 +- .../ScreenMembersOnMfaEmailList.mdx | 24 +- .../ScreenMembersOnMfaEnrollResult.mdx | 24 +- .../ScreenMembersOnMfaLoginOptions.mdx | 24 +- .../ScreenMembersOnMfaOtpChallenge.mdx | 24 +- .../ScreenMembersOnMfaOtpEnrollmentCode.mdx | 24 +- .../ScreenMembersOnMfaOtpEnrollmentQr.mdx | 24 +- .../ScreenMembersOnMfaPhoneChallenge.mdx | 24 +- .../ScreenMembersOnMfaPushChallengePush.mdx | 24 +- .../ScreenMembersOnMfaPushEnrollmentQr.mdx | 24 +- .../ScreenMembersOnMfaPushWelcome.mdx | 26 +- ...mbersOnMfaRecoveryCodeChallengeNewCode.mdx | 24 +- ...reenMembersOnMfaRecoveryCodeEnrollment.mdx | 24 +- .../ScreenMembersOnMfaSmsChallenge.mdx | 24 +- .../ScreenMembersOnMfaSmsEnrollment.mdx | 24 +- .../ScreenMembersOnMfaVoiceChallenge.mdx | 24 +- ...nMembersOnMfaWebAuthnChangeKeyNickname.mdx | 24 +- ...nMembersOnMfaWebAuthnEnrollmentSuccess.mdx | 32 +- .../ScreenMembersOnMfaWebAuthnError.mdx | 32 +- ...nMembersOnMfaWebAuthnPlatformChallenge.mdx | 30 +- ...MembersOnMfaWebAuthnPlatformEnrollment.mdx | 26 +- ...enMembersOnMfaWebAuthnRoamingChallenge.mdx | 30 +- ...nMembersOnMfaWebAuthnRoamingEnrollment.mdx | 26 +- .../ScreenMembersOnOrganizationSelection.mdx | 50 +- .../ScreenMembersOnPasskeyEnrollment.mdx | 26 +- .../ScreenMembersOnPasskeyEnrollmentLocal.mdx | 26 +- ...creenMembersOnPhoneIdentifierChallenge.mdx | 24 +- ...reenMembersOnPhoneIdentifierEnrollment.mdx | 24 +- .../ScreenMembersOnResetPassword.mdx | 24 +- .../ScreenMembersOnResetPasswordEmail.mdx | 24 +- .../ScreenMembersOnResetPasswordError.mdx | 24 +- ...embersOnResetPasswordMfaEmailChallenge.mdx | 24 +- ...embersOnResetPasswordMfaPhoneChallenge.mdx | 24 +- ...ersOnResetPasswordMfaPushChallengePush.mdx | 24 +- ...nMembersOnResetPasswordMfaSmsChallenge.mdx | 24 +- ...embersOnResetPasswordMfaVoiceChallenge.mdx | 24 +- ...etPasswordMfaWebAuthnPlatformChallenge.mdx | 30 +- ...setPasswordMfaWebAuthnRoamingChallenge.mdx | 30 +- .../ScreenMembersOnResetPasswordRequest.mdx | 24 +- .../ScreenMembersOnResetPasswordSuccess.mdx | 26 +- .../interfaces/ScreenMembersOnSignup.mdx | 26 +- .../interfaces/ScreenMembersOnSignupId.mdx | 26 +- .../ScreenMembersOnSignupPassword.mdx | 24 +- .../Types/interfaces/ShowErrorOptions.mdx | 6 +- .../Types/interfaces/SignupIdMembers.mdx | 70 +- .../Types/interfaces/SignupMembers.mdx | 76 +-- .../interfaces/SignupPasswordMembers.mdx | 64 +- .../Types/interfaces/StartResendOptions.mdx | 4 +- .../SubmitPasskeyCredentialOptions.mdx | 2 +- .../Types/interfaces/TransactionMembers.mdx | 32 +- .../interfaces/TransactionMembersOnLogin.mdx | 40 +- .../TransactionMembersOnLoginId.mdx | 40 +- .../TransactionMembersOnLoginPassword.mdx | 44 +- ...ionMembersOnLoginPasswordlessEmailCode.mdx | 32 +- ...actionMembersOnLoginPasswordlessSmsOtp.mdx | 32 +- .../TransactionMembersOnResetPassword.mdx | 36 +- ...ansactionMembersOnResetPasswordRequest.mdx | 40 +- .../interfaces/TransactionMembersOnSignup.mdx | 48 +- .../TransactionMembersOnSignupId.mdx | 44 +- .../TransactionMembersOnSignupPassword.mdx | 44 +- .../Types/interfaces/UntrustedDataMembers.mdx | 10 +- ...ntrustedDataMembersOnMfaEmailChallenge.mdx | 6 +- .../UntrustedDataMembersOnMfaOtpChallenge.mdx | 6 +- ...ustedDataMembersOnMfaPushChallengePush.mdx | 6 +- .../UntrustedDataMembersOnMfaSmsChallenge.mdx | 6 +- ...ntrustedDataMembersOnMfaVoiceChallenge.mdx | 6 +- .../Types/interfaces/UseErrorsResult.mdx | 4 +- .../Types/interfaces/UseResendOptions.mdx | 2 +- .../Types/interfaces/UseResendReturn.mdx | 2 +- .../Types/interfaces/UserMembers.mdx | 16 +- .../interfaces/UsernameValidationResult.mdx | 6 +- .../VerifyPlatformAuthenticatorOptions.mdx | 2 +- .../interfaces/VerifySecurityKeyOptions.mdx | 2 +- .../WebAuthnEnrollSuccessContinueOptions.mdx | 2 +- .../Types/interfaces/WithRememberOptions.mdx | 2 +- .../Types/type-aliases/MfaPollingOptions.mdx | 4 +- .../react-sdk/API-Reference/index.mdx | 6 +- 301 files changed, 7343 insertions(+), 7238 deletions(-) create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/index.mdx diff --git a/main/docs.json b/main/docs.json index 0d96d16c1..55e8e950e 100644 --- a/main/docs.json +++ b/main/docs.json @@ -1704,6 +1704,7 @@ { "group": "Hooks", "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/index", "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useAuth0Themes", "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useCurrentScreen", "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useErrors", @@ -1718,6 +1719,7 @@ { "group": "Screens", "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/index", "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index", "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index", "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index", @@ -1797,306 +1799,312 @@ ] }, { - "group": "Classes", - "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks" - ] - }, - { - "group": "Interfaces", - "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AbortEnrollmentOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AuthorizationDetail", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOTPOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinuePayloadOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithOrganizationNameOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CredentialResponse", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledDevice", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledEmail", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledPhoneNumber", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPasswordOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPayloadOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPasswordPayloadOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPayloadOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPayloadOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpTryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodePayloadOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectCountryCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaEmailOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaPushDeviceOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectOrganizationOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPayloadOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCaptchaOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitOTPOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodMfaOtpChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodPayloadOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationError", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions" - ] - }, - { - "group": "Type Aliases", + "group": "Types", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/AuthenticatorTransport", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaEnrollFactorType", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaLoginFactorType", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/OnStatusChangeCallback", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ScreenIdentifierType", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType" + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/index", + { + "group": "Classes", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks" + ] + }, + { + "group": "Interfaces", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AbortEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AuthorizationDetail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOTPOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinuePayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithOrganizationNameOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CredentialResponse", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledDevice", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledEmail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledPhoneNumber", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPasswordPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodePayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectCountryCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaEmailOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaPushDeviceOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectOrganizationOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCaptchaOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitOTPOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodMfaOtpChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationError", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions" + ] + }, + { + "group": "Type Aliases", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/AuthenticatorTransport", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaEnrollFactorType", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaLoginFactorType", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/OnStatusChangeCallback", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ScreenIdentifierType", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType" + ] + } ] } ] diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/index.mdx new file mode 100644 index 000000000..b14398064 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/index.mdx @@ -0,0 +1,15 @@ +--- +title: "Hooks" +--- + +## Functions + +- [useAuth0Themes](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes): React hook to get the current theme options with flattened configuration from branding context. +- [useCurrentScreen](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen): React hook that gets the current screen context and state. +- [useErrors](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors): React hook for reading and managing errors in ACUL (Advanced Customization of Universal Login). With all validation and server-side errors. It groups errors into three kinds: - `server` — errors returned by Auth0 or your own backend. - `client` — errors from client-side validation (e.g., invalid form input). - `developer` — errors caused by incorrect integration or SDK misuse. +- [useLoginIdentifiers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useLoginIdentifiers): Returns a list of active identifier types (such as `'email'`, `'phone'`, or `'username'`) currently in use in the authentication flow or login process. +- [useMfaPolling](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useMfaPolling): React hook to manage MFA push polling (e.g., waiting for a push notification approval) on an Auth0 Advanced Customization of Universal Login (ACUL) screen. +- [useResend](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend): This React hook manages "resend" actions (e.g., resending a verification code) on ACUL screens. +- [useSignupIdentifiers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useSignupIdentifiers): Returns a list of enabled identifiers (email, phone, or username), each with its `required` status, based on the current screen's signup identifiers. +- [usePasswordValidation](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/usePasswordValidation): This React hook validates a password against the current Auth0 password policy and returns a structured result describing whether the password satisfies each rule. +- [useUsernameValidation](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useUsernameValidation): React hook for validating a username against the current Auth0 username policy. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useAuth0Themes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useAuth0Themes.mdx index a69a630db..b3654bb87 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useAuth0Themes.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useAuth0Themes.mdx @@ -2,7 +2,7 @@ title: "useAuth0Themes" --- -> **useAuth0Themes**(): [`FlattenedTheme`](../../Types/interfaces/FlattenedTheme) \| `null` +> **useAuth0Themes**(): [`FlattenedTheme`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme) \| `null` Defined in: [packages/auth0-acul-react/src/hooks/common/auth0-themes.ts:50](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/auth0-themes.ts#L50) @@ -10,7 +10,7 @@ React hook to get the current theme options with flattened configuration from br ## Returns -[`FlattenedTheme`](../../Types/interfaces/FlattenedTheme) \| `null` +[`FlattenedTheme`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme) \| `null` FlattenedTheme object containing colors, fonts, borders, pageBackground, and widget configurations, or null if no branding is available diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useCurrentScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useCurrentScreen.mdx index 87547ae7d..a61fdc65a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useCurrentScreen.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useCurrentScreen.mdx @@ -2,7 +2,7 @@ title: "useCurrentScreen" --- -> **useCurrentScreen**(): [`CurrentScreenOptions`](../../Types/interfaces/CurrentScreenOptions) \| `null` +> **useCurrentScreen**(): [`CurrentScreenOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions) \| `null` Defined in: [packages/auth0-acul-react/src/hooks/common/current-screen.ts:76](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/current-screen.ts#L76) @@ -32,7 +32,7 @@ Returns `CurrentScreenOptions` object with the following properties, or `null` i ## Returns -[`CurrentScreenOptions`](../../Types/interfaces/CurrentScreenOptions) \| `null` +[`CurrentScreenOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions) \| `null` Current screen context data, or `null` if not available diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useErrors.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useErrors.mdx index 433e3a70f..0a8037bd1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useErrors.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useErrors.mdx @@ -2,7 +2,7 @@ title: "useErrors" --- -> **useErrors**(`options`): [`UseErrorsResult`](../../Types/interfaces/UseErrorsResult) +> **useErrors**(`options`): [`UseErrorsResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult) Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:134](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L134) @@ -16,14 +16,14 @@ With all validation and server-side errors. It groups errors into three kinds: ### options -[`UseErrorOptions`](../../Types/interfaces/UseErrorOptions) = `{}` +[`UseErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions) = `{}` ## Returns -[`UseErrorsResult`](../../Types/interfaces/UseErrorsResult) +[`UseErrorsResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult) -An object of type [UseErrorsResult](../../Types/interfaces/UseErrorsResult), containing: -- `errors` — the full error list of type [ErrorsResult](../../Types/interfaces/ErrorsResult), with helpers: +An object of type [UseErrorsResult](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult), containing: +- `errors` — the full error list of type [ErrorsResult](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult), with helpers: - `errors.byKind(kind, filter?)` — filter by error kind and optionally by field. - `errors.byField(field, filter?)` — filter by field and optionally by kind. - `hasError` — `true` if any error is currently present. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useLoginIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useLoginIdentifiers.mdx index bf11b7143..8c7c6e079 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useLoginIdentifiers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useLoginIdentifiers.mdx @@ -2,7 +2,7 @@ title: "useLoginIdentifiers" --- -> **useLoginIdentifiers**(): [`IdentifierType`](../../Types/type-aliases/IdentifierType)[] +> **useLoginIdentifiers**(): [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] Defined in: [packages/auth0-acul-react/src/hooks/utility/login-identifiers.ts:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/login-identifiers.ts#L34) @@ -11,9 +11,9 @@ currently in use in the authentication flow or login process. ## Returns -[`IdentifierType`](../../Types/type-aliases/IdentifierType)[] +[`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] -An array of [IdentifierType](../../Types/type-aliases/IdentifierType) representing active identifiers. +An array of [IdentifierType](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType) representing active identifiers. ## Supported Screens diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useMfaPolling.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useMfaPolling.mdx index 32e4a246b..e419f3072 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useMfaPolling.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useMfaPolling.mdx @@ -2,7 +2,7 @@ title: "useMfaPolling" --- -> **useMfaPolling**(`options?`): [`MfaPollingResult`](../../Types/interfaces/MfaPollingResult) +> **useMfaPolling**(`options?`): [`MfaPollingResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult) Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:106](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L106) @@ -27,16 +27,16 @@ the MFA push challenge endpoint until one of the following occurs: ### options? -[`MfaPollingOptions`](../../Types/type-aliases/MfaPollingOptions) +[`MfaPollingOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions) -[MfaPollingOptions](../../Types/type-aliases/MfaPollingOptions) specifying the polling interval, +[MfaPollingOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions) specifying the polling interval, success callback (`onCompleted`), and optional error handler (`onError`). ## Returns -[`MfaPollingResult`](../../Types/interfaces/MfaPollingResult) +[`MfaPollingResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult) -object [MfaPollingResult](../../Types/interfaces/MfaPollingResult) containing: +object [MfaPollingResult](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult) containing: - `isRunning` — `true` while polling is active. - `startPolling()` — starts or resumes polling. - `stopPolling()` — stops polling immediately. @@ -72,7 +72,7 @@ export function MfaPushStatus() { ## Remarks -- The `onError` callback receives an [ULError](../../Types/interfaces/Error) object +- The `onError` callback receives an [ULError](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error) object with `status` and `responseText` describing the server response. - Internal rate-limit responses (`429`) are automatically handled: polling waits for the reset window before retrying. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/usePasswordValidation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/usePasswordValidation.mdx index 8445ee899..dc24a0dae 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/usePasswordValidation.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/usePasswordValidation.mdx @@ -2,7 +2,7 @@ title: "usePasswordValidation" --- -> **usePasswordValidation**(`password`, `options?`): [`PasswordValidationResult`](../../Types/interfaces/PasswordValidationResult) +> **usePasswordValidation**(`password`, `options?`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult) Defined in: [packages/auth0-acul-react/src/hooks/utility/validate-password.ts:43](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/validate-password.ts#L43) @@ -30,9 +30,9 @@ If `true`, validation errors are stored in the global error manager under the `p ## Returns -[`PasswordValidationResult`](../../Types/interfaces/PasswordValidationResult) +[`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult) -A [PasswordValidationResult](../../Types/interfaces/PasswordValidationResult) object containing: +A [PasswordValidationResult](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult) object containing: - `isValid` — `true` if the password satisfies all configured rules. - `results` — an array of per-rule results with `code`, `label`, `status`, and `isValid`. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useResend.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useResend.mdx index 416008ca0..814401717 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useResend.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useResend.mdx @@ -2,7 +2,7 @@ title: "useResend" --- -> **useResend**(`options?`): [`UseResendReturn`](../../Types/interfaces/UseResendReturn) +> **useResend**(`options?`): [`UseResendReturn`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn) Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:87](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L87) @@ -17,13 +17,13 @@ This hook: ### options? -[`UseResendOptions`](../../Types/interfaces/UseResendOptions) +[`UseResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions) Optional configuration such as `timeoutSeconds` and `onTimeout`. ## Returns -[`UseResendReturn`](../../Types/interfaces/UseResendReturn) +[`UseResendReturn`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn) An object with: - `remaining` — seconds left until the next resend is permitted. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useSignupIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useSignupIdentifiers.mdx index 003924e1c..51560828a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useSignupIdentifiers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useSignupIdentifiers.mdx @@ -2,7 +2,7 @@ title: "useSignupIdentifiers" --- -> **useSignupIdentifiers**(): \[\] \| [`Identifier`](../../Types/interfaces/Identifier)[] +> **useSignupIdentifiers**(): \[\] \| [`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier)[] Defined in: [packages/auth0-acul-react/src/hooks/utility/signup-identifiers.ts:42](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/signup-identifiers.ts#L42) @@ -11,9 +11,9 @@ based on the current screen's signup identifiers. ## Returns -\[\] \| [`Identifier`](../../Types/interfaces/Identifier)[] +\[\] \| [`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier)[] -An array of [Identifier](../../Types/interfaces/Identifier) objects, where each contains a `type` (identifier type) +An array of [Identifier](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier) objects, where each contains a `type` (identifier type) and a `required` flag indicating whether it is mandatory for signup. ## Supported Screens diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useUsernameValidation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useUsernameValidation.mdx index a353e5d2a..44be74332 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useUsernameValidation.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useUsernameValidation.mdx @@ -2,7 +2,7 @@ title: "useUsernameValidation" --- -> **useUsernameValidation**(`username`, `options?`): [`UsernameValidationResult`](../../Types/interfaces/UsernameValidationResult) +> **useUsernameValidation**(`username`, `options?`): [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult) Defined in: [packages/auth0-acul-react/src/hooks/utility/validate-username.ts:65](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/validate-username.ts#L65) @@ -33,9 +33,9 @@ When `true`, validation errors are stored in the ## Returns -[`UsernameValidationResult`](../../Types/interfaces/UsernameValidationResult) +[`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult) -A [UsernameValidationResult](../../Types/interfaces/UsernameValidationResult) object with: +A [UsernameValidationResult](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult) object with: - `isValid` — `true` if the username satisfies all configured rules. - `errors` — an array of per-rule validation errors with `code`, `message`, and `isValid`. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index.mdx index 3d6ccdebf..450c61260 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index.mdx @@ -4,8 +4,8 @@ title: "accept-invitation" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnAcceptInvitation">ScreenMembersOnAcceptInvitation</a>}> -> **useScreen**: () => [`ScreenMembersOnAcceptInvitation`](../../../../Types/interfaces/ScreenMembersOnAcceptInvitation) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation">ScreenMembersOnAcceptInvitation</a>}> +> **useScreen**: () => [`ScreenMembersOnAcceptInvitation`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation) Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnAcceptInvitation`](../../../../Types/interfaces/ScreenMembersOnAcceptInvitation) +[`ScreenMembersOnAcceptInvitation`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,36 +226,36 @@ Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:34](htt **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useAcceptInvitation' type={<a href="../../../../Types/interfaces/AcceptInvitationMembers">AcceptInvitationMembers</a>}> -> **useAcceptInvitation**(): [`AcceptInvitationMembers`](../../../../Types/interfaces/AcceptInvitationMembers) +<ParamField body='useAcceptInvitation' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers">AcceptInvitationMembers</a>}> +> **useAcceptInvitation**(): [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers) Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L49) **Returns** -[`AcceptInvitationMembers`](../../../../Types/interfaces/AcceptInvitationMembers) +[`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index.mdx index def634479..ef330bf21 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index.mdx @@ -4,8 +4,8 @@ title: "consent" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L21) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L22) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L23) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L24) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnConsent">ScreenMembersOnConsent</a>}> -> **useScreen**: () => [`ScreenMembersOnConsent`](../../../../Types/interfaces/ScreenMembersOnConsent) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent">ScreenMembersOnConsent</a>}> +> **useScreen**: () => [`ScreenMembersOnConsent`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent) Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L25) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnConsent`](../../../../Types/interfaces/ScreenMembersOnConsent) +[`ScreenMembersOnConsent`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L20) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L26) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L27) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L19) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:31](https://githu **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:32](https://githu **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useConsent' type={<a href="../../../../Types/interfaces/ConsentMembers">ConsentMembers</a>}> -> **useConsent**(): [`ConsentMembers`](../../../../Types/interfaces/ConsentMembers) +<ParamField body='useConsent' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers">ConsentMembers</a>}> +> **useConsent**(): [`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers) Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:46](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L46) **Returns** -[`ConsentMembers`](../../../../Types/interfaces/ConsentMembers) +[`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index.mdx index 515798745..a62484306 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index.mdx @@ -4,8 +4,8 @@ title: "customized-consent" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnCustomizedConsent">ScreenMembersOnCustomizedConsent</a>}> -> **useScreen**: () => [`ScreenMembersOnCustomizedConsent`](../../../../Types/interfaces/ScreenMembersOnCustomizedConsent) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent">ScreenMembersOnCustomizedConsent</a>}> +> **useScreen**: () => [`ScreenMembersOnCustomizedConsent`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent) Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnCustomizedConsent`](../../../../Types/interfaces/ScreenMembersOnCustomizedConsent) +[`ScreenMembersOnCustomizedConsent`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:34](ht **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:35](ht **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useCustomizedConsent' type={<a href="../../../../Types/interfaces/CustomizedConsentMembers">CustomizedConsentMembers</a>}> -> **useCustomizedConsent**(): [`CustomizedConsentMembers`](../../../../Types/interfaces/CustomizedConsentMembers) +<ParamField body='useCustomizedConsent' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers">CustomizedConsentMembers</a>}> +> **useCustomizedConsent**(): [`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers) Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L49) **Returns** -[`CustomizedConsentMembers`](../../../../Types/interfaces/CustomizedConsentMembers) +[`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index.mdx index ae0b3a4f3..8c6cf1e10 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index.mdx @@ -4,8 +4,8 @@ title: "device-code-activation-allowed" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L17) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L18) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L19) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L20) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L21) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L16) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L22) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L23) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L15) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -217,29 +217,29 @@ function UserProfile() { ## Functions -<ParamField body='useDeviceCodeActivationAllowed' type={<a href="../../../../Types/interfaces/DeviceCodeActivationAllowedMembers">DeviceCodeActivationAllowedMembers</a>}> -> **useDeviceCodeActivationAllowed**(): [`DeviceCodeActivationAllowedMembers`](../../../../Types/interfaces/DeviceCodeActivationAllowedMembers) +<ParamField body='useDeviceCodeActivationAllowed' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers">DeviceCodeActivationAllowedMembers</a>}> +> **useDeviceCodeActivationAllowed**(): [`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L38) **Returns** -[`DeviceCodeActivationAllowedMembers`](../../../../Types/interfaces/DeviceCodeActivationAllowedMembers) +[`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index.mdx index ebdaa969f..2a8981e79 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index.mdx @@ -4,8 +4,8 @@ title: "device-code-activation-denied" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L17) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L18) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L19) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L20) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L21) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L16) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L22) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L23) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L15) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -217,29 +217,29 @@ function UserProfile() { ## Functions -<ParamField body='useDeviceCodeActivationDenied' type={<a href="../../../../Types/interfaces/DeviceCodeActivationDeniedMembers">DeviceCodeActivationDeniedMembers</a>}> -> **useDeviceCodeActivationDenied**(): [`DeviceCodeActivationDeniedMembers`](../../../../Types/interfaces/DeviceCodeActivationDeniedMembers) +<ParamField body='useDeviceCodeActivationDenied' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers">DeviceCodeActivationDeniedMembers</a>}> +> **useDeviceCodeActivationDenied**(): [`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L38) **Returns** -[`DeviceCodeActivationDeniedMembers`](../../../../Types/interfaces/DeviceCodeActivationDeniedMembers) +[`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index.mdx index a686d5974..a768b46c5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index.mdx @@ -4,8 +4,8 @@ title: "device-code-activation" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,36 +226,36 @@ Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:34 **payload** -[`DeviceCodeActivationContinueOptions`](../../../../Types/interfaces/DeviceCodeActivationContinueOptions) +[`DeviceCodeActivationContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useDeviceCodeActivation' type={<a href="../../../../Types/interfaces/DeviceCodeActivationMembers">DeviceCodeActivationMembers</a>}> -> **useDeviceCodeActivation**(): [`DeviceCodeActivationMembers`](../../../../Types/interfaces/DeviceCodeActivationMembers) +<ParamField body='useDeviceCodeActivation' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers">DeviceCodeActivationMembers</a>}> +> **useDeviceCodeActivation**(): [`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L48) **Returns** -[`DeviceCodeActivationMembers`](../../../../Types/interfaces/DeviceCodeActivationMembers) +[`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index.mdx index 528abee6e..ba78e0857 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index.mdx @@ -4,8 +4,8 @@ title: "device-code-confirmation" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnDeviceCodeConfirmation">ScreenMembersOnDeviceCodeConfirmation</a>}> -> **useScreen**: () => [`ScreenMembersOnDeviceCodeConfirmation`](../../../../Types/interfaces/ScreenMembersOnDeviceCodeConfirmation) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation">ScreenMembersOnDeviceCodeConfirmation</a>}> +> **useScreen**: () => [`ScreenMembersOnDeviceCodeConfirmation`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation) Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnDeviceCodeConfirmation`](../../../../Types/interfaces/ScreenMembersOnDeviceCodeConfirmation) +[`ScreenMembersOnDeviceCodeConfirmation`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx: **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx: **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useDeviceCodeConfirmation' type={<a href="../../../../Types/interfaces/DeviceCodeConfirmationMembers">DeviceCodeConfirmationMembers</a>}> -> **useDeviceCodeConfirmation**(): [`DeviceCodeConfirmationMembers`](../../../../Types/interfaces/DeviceCodeConfirmationMembers) +<ParamField body='useDeviceCodeConfirmation' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers">DeviceCodeConfirmationMembers</a>}> +> **useDeviceCodeConfirmation**(): [`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers) Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L49) **Returns** -[`DeviceCodeConfirmationMembers`](../../../../Types/interfaces/DeviceCodeConfirmationMembers) +[`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index.mdx index 8621d424a..539637542 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index.mdx @@ -4,8 +4,8 @@ title: "email-identifier-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnEmailIdentifierChallenge">ScreenMembersOnEmailIdentifierChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnEmailIdentifierChallenge`](../../../../Types/interfaces/ScreenMembersOnEmailIdentifierChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge">ScreenMembersOnEmailIdentifierChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnEmailIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge) Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnEmailIdentifierChallenge`](../../../../Types/interfaces/ScreenMembersOnEmailIdentifierChallenge) +[`ScreenMembersOnEmailIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.ts **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.ts **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -258,38 +258,38 @@ Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.ts **payload** -[`EmailChallengeOptions`](../../../../Types/interfaces/EmailChallengeOptions) +[`EmailChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailChallengeOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useEmailIdentifierChallenge' type={<a href="../../../../Types/interfaces/EmailIdentifierChallengeMembers">EmailIdentifierChallengeMembers</a>}> -> **useEmailIdentifierChallenge**(): [`EmailIdentifierChallengeMembers`](../../../../Types/interfaces/EmailIdentifierChallengeMembers) +<ParamField body='useEmailIdentifierChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers">EmailIdentifierChallengeMembers</a>}> +> **useEmailIdentifierChallenge**(): [`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:56](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L56) **Returns** -[`EmailIdentifierChallengeMembers`](../../../../Types/interfaces/EmailIdentifierChallengeMembers) +[`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend">useResend</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index.mdx index 9517fd874..234f9a5e1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index.mdx @@ -4,8 +4,8 @@ title: "email-otp-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnEmailOTPChallenge">ScreenMembersOnEmailOTPChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnEmailOTPChallenge`](../../../../Types/interfaces/ScreenMembersOnEmailOTPChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge">ScreenMembersOnEmailOTPChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnEmailOTPChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge) Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnEmailOTPChallenge`](../../../../Types/interfaces/ScreenMembersOnEmailOTPChallenge) +[`ScreenMembersOnEmailOTPChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:36](h **options?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,38 +242,38 @@ Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:35](h **options** -[`OtpCodeOptions`](../../../../Types/interfaces/OtpCodeOptions) +[`OtpCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useEmailOTPChallenge' type={<a href="../../../../Types/interfaces/EmailOTPChallengeMembers">EmailOTPChallengeMembers</a>}> -> **useEmailOTPChallenge**(): [`EmailOTPChallengeMembers`](../../../../Types/interfaces/EmailOTPChallengeMembers) +<ParamField body='useEmailOTPChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers">EmailOTPChallengeMembers</a>}> +> **useEmailOTPChallenge**(): [`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L53) **Returns** -[`EmailOTPChallengeMembers`](../../../../Types/interfaces/EmailOTPChallengeMembers) +[`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend">useResend</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index.mdx index e8136cfd1..8583b8746 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index.mdx @@ -4,8 +4,8 @@ title: "email-verification-result" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L17) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L18) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L19) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L20) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnEmailVerificationResult">ScreenMembersOnEmailVerificationResult</a>}> -> **useScreen**: () => [`ScreenMembersOnEmailVerificationResult`](../../../../Types/interfaces/ScreenMembersOnEmailVerificationResult) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult">ScreenMembersOnEmailVerificationResult</a>}> +> **useScreen**: () => [`ScreenMembersOnEmailVerificationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult) Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L21) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnEmailVerificationResult`](../../../../Types/interfaces/ScreenMembersOnEmailVerificationResult) +[`ScreenMembersOnEmailVerificationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L16) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L22) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L23) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L15) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -217,29 +217,29 @@ function UserProfile() { ## Functions -<ParamField body='useEmailVerificationResult' type={<a href="../../../../Types/interfaces/EmailVerificationResultMembers">EmailVerificationResultMembers</a>}> -> **useEmailVerificationResult**(): [`EmailVerificationResultMembers`](../../../../Types/interfaces/EmailVerificationResultMembers) +<ParamField body='useEmailVerificationResult' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers">EmailVerificationResultMembers</a>}> +> **useEmailVerificationResult**(): [`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers) Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L38) **Returns** -[`EmailVerificationResultMembers`](../../../../Types/interfaces/EmailVerificationResultMembers) +[`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/index.mdx new file mode 100644 index 000000000..87e21fc61 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/index.mdx @@ -0,0 +1,82 @@ +--- +title: "Screens" +--- + +## Namespaces + +- [accept-invitation](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation) +- [consent](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent) +- [customized-consent](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent) +- [device-code-activation-allowed](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed) +- [device-code-activation-denied](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied) +- [device-code-activation](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation) +- [device-code-confirmation](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation) +- [email-identifier-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge) +- [email-otp-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge) +- [email-verification-result](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result) +- [interstitial-captcha](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha) +- [login-email-verification](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification) +- [login-id](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id) +- [login-password](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password) +- [login-passwordless-email-code](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code) +- [login-passwordless-sms-otp](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp) +- [login](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login) +- [logout-aborted](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted) +- [logout-complete](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete) +- [logout](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout) +- [mfa-begin-enroll-options](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options) +- [mfa-country-codes](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes) +- [mfa-detect-browser-capabilities](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities) +- [mfa-email-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge) +- [mfa-email-list](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list) +- [mfa-enroll-result](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result) +- [mfa-login-options](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options) +- [mfa-otp-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge) +- [mfa-otp-enrollment-code](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code) +- [mfa-otp-enrollment-qr](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr) +- [mfa-phone-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge) +- [mfa-phone-enrollment](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment) +- [mfa-push-challenge-push](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push) +- [mfa-push-enrollment-qr](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr) +- [mfa-push-list](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list) +- [mfa-push-welcome](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome) +- [mfa-recovery-code-challenge-new-code](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code) +- [mfa-recovery-code-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge) +- [mfa-recovery-code-enrollment](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment) +- [mfa-sms-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge) +- [mfa-sms-enrollment](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment) +- [mfa-sms-list](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list) +- [mfa-voice-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge) +- [mfa-voice-enrollment](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment) +- [mfa-webauthn-change-key-nickname](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname) +- [mfa-webauthn-enrollment-success](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success) +- [mfa-webauthn-error](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error) +- [mfa-webauthn-not-available-error](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error) +- [mfa-webauthn-platform-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge) +- [mfa-webauthn-platform-enrollment](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment) +- [mfa-webauthn-roaming-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge) +- [mfa-webauthn-roaming-enrollment](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment) +- [organization-picker](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker) +- [organization-selection](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection) +- [passkey-enrollment-local](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local) +- [passkey-enrollment](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment) +- [phone-identifier-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge) +- [phone-identifier-enrollment](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment) +- [redeem-ticket](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket) +- [reset-password-email](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email) +- [reset-password-error](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error) +- [reset-password-mfa-email-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge) +- [reset-password-mfa-otp-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge) +- [reset-password-mfa-phone-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge) +- [reset-password-mfa-push-challenge-push](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push) +- [reset-password-mfa-recovery-code-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge) +- [reset-password-mfa-sms-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge) +- [reset-password-mfa-voice-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge) +- [reset-password-mfa-webauthn-platform-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge) +- [reset-password-mfa-webauthn-roaming-challenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge) +- [reset-password-request](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request) +- [reset-password-success](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success) +- [reset-password](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password) +- [signup-id](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id) +- [signup-password](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password) +- [signup](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index.mdx index 64fee2017..030c934e7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index.mdx @@ -4,8 +4,8 @@ title: "interstitial-captcha" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L17) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L18) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L19) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L20) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L21) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L16) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L22) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L23) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L15) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -217,29 +217,29 @@ function UserProfile() { ## Functions -<ParamField body='useInterstitialCaptcha' type={<a href="../../../../Types/interfaces/InterstitialCaptchaMembers">InterstitialCaptchaMembers</a>}> -> **useInterstitialCaptcha**(): [`InterstitialCaptchaMembers`](../../../../Types/interfaces/InterstitialCaptchaMembers) +<ParamField body='useInterstitialCaptcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers">InterstitialCaptchaMembers</a>}> +> **useInterstitialCaptcha**(): [`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers) Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L38) **Returns** -[`InterstitialCaptchaMembers`](../../../../Types/interfaces/InterstitialCaptchaMembers) +[`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index.mdx index c3e9a930d..3a5fd4417 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index.mdx @@ -4,8 +4,8 @@ title: "login-email-verification" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx: **payload** -[`ContinueWithCodeOptionPayload`](../../../../Types/interfaces/ContinueWithCodeOptionPayload) +[`ContinueWithCodeOptionPayload`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload) **Returns** @@ -242,38 +242,38 @@ Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx: **payload?** -[`ResendCodeOptionsPayload`](../../../../Types/interfaces/ResendCodeOptionsPayload) +[`ResendCodeOptionsPayload`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useLoginEmailVerification' type={<a href="../../../../Types/interfaces/LoginEmailVerificationMembers">LoginEmailVerificationMembers</a>}> -> **useLoginEmailVerification**(): [`LoginEmailVerificationMembers`](../../../../Types/interfaces/LoginEmailVerificationMembers) +<ParamField body='useLoginEmailVerification' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers">LoginEmailVerificationMembers</a>}> +> **useLoginEmailVerification**(): [`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers) Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L54) **Returns** -[`LoginEmailVerificationMembers`](../../../../Types/interfaces/LoginEmailVerificationMembers) +[`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend">useResend</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index.mdx index 0fc7f06f7..b433e1959 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index.mdx @@ -4,8 +4,8 @@ title: "login-id" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L26) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L27) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L28) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L29) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnLoginId">ScreenMembersOnLoginId</a>}> -> **useScreen**: () => [`ScreenMembersOnLoginId`](../../../../Types/interfaces/ScreenMembersOnLoginId) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId">ScreenMembersOnLoginId</a>}> +> **useScreen**: () => [`ScreenMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId) Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L30) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnLoginId`](../../../../Types/interfaces/ScreenMembersOnLoginId) +[`ScreenMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L25) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnLoginId">TransactionMembersOnLoginId</a>}> -> **useTransaction**: () => [`TransactionMembersOnLoginId`](../../../../Types/interfaces/TransactionMembersOnLoginId) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId">TransactionMembersOnLoginId</a>}> +> **useTransaction**: () => [`TransactionMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId) Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L31) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembersOnLoginId`](../../../../Types/interfaces/TransactionMembersOnLoginId) +[`TransactionMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L32) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L24) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:37](https://gith **payload** -[`FederatedLoginOptions`](../../../../Types/interfaces/FederatedLoginOptions) +[`FederatedLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:36](https://gith **payload** -[`LoginOptions`](../../../../Types/interfaces/LoginOptions) +[`LoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginOptions) **Returns** @@ -258,7 +258,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:39](https://gith **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -274,38 +274,38 @@ Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:40](https://gith **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useLoginId' type={<a href="../../../../Types/interfaces/LoginIdMembers">LoginIdMembers</a>}> -> **useLoginId**(): [`LoginIdMembers`](../../../../Types/interfaces/LoginIdMembers) +<ParamField body='useLoginId' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers">LoginIdMembers</a>}> +> **useLoginId**(): [`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers) Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L58) **Returns** -[`LoginIdMembers`](../../../../Types/interfaces/LoginIdMembers) +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useLoginIdentifiers">useLoginIdentifiers</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useLoginIdentifiers">useLoginIdentifiers</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index.mdx index 209286dc4..6b8406919 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index.mdx @@ -4,8 +4,8 @@ title: "login-password" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnLoginPassword">ScreenMembersOnLoginPassword</a>}> -> **useScreen**: () => [`ScreenMembersOnLoginPassword`](../../../../Types/interfaces/ScreenMembersOnLoginPassword) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword">ScreenMembersOnLoginPassword</a>}> +> **useScreen**: () => [`ScreenMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword) Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnLoginPassword`](../../../../Types/interfaces/ScreenMembersOnLoginPassword) +[`ScreenMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnLoginPassword">TransactionMembersOnLoginPassword</a>}> -> **useTransaction**: () => [`TransactionMembersOnLoginPassword`](../../../../Types/interfaces/TransactionMembersOnLoginPassword) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword">TransactionMembersOnLoginPassword</a>}> +> **useTransaction**: () => [`TransactionMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword) Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembersOnLoginPassword`](../../../../Types/interfaces/TransactionMembersOnLoginPassword) +[`TransactionMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:36](https: **payload** -[`FederatedLoginPasswordOptions`](../../../../Types/interfaces/FederatedLoginPasswordOptions) +[`FederatedLoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPasswordOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:35](https: **payload** -[`LoginPasswordOptions`](../../../../Types/interfaces/LoginPasswordOptions) +[`LoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useLoginPassword' type={<a href="../../../../Types/interfaces/LoginPasswordMembers">LoginPasswordMembers</a>}> -> **useLoginPassword**(): [`LoginPasswordMembers`](../../../../Types/interfaces/LoginPasswordMembers) +<ParamField body='useLoginPassword' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers">LoginPasswordMembers</a>}> +> **useLoginPassword**(): [`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers) Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L51) **Returns** -[`LoginPasswordMembers`](../../../../Types/interfaces/LoginPasswordMembers) +[`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index.mdx index 1f64bb0ee..7e50dbd73 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index.mdx @@ -4,8 +4,8 @@ title: "login-passwordless-email-code" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode">ScreenMembersOnLoginPasswordlessEmailCode</a>}> -> **useScreen**: () => [`ScreenMembersOnLoginPasswordlessEmailCode`](../../../../Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode">ScreenMembersOnLoginPasswordlessEmailCode</a>}> +> **useScreen**: () => [`ScreenMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnLoginPasswordlessEmailCode`](../../../../Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode) +[`ScreenMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode">TransactionMembersOnLoginPasswordlessEmailCode</a>}> -> **useTransaction**: () => [`TransactionMembersOnLoginPasswordlessEmailCode`](../../../../Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode">TransactionMembersOnLoginPasswordlessEmailCode</a>}> +> **useTransaction**: () => [`TransactionMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembersOnLoginPasswordlessEmailCode`](../../../../Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode) +[`TransactionMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,38 +242,38 @@ Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code **payload** -[`SubmitCodeOptions`](../../../../Types/interfaces/SubmitCodeOptions) +[`SubmitCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useLoginPasswordlessEmailCode' type={<a href="../../../../Types/interfaces/LoginPasswordlessEmailCodeMembers">LoginPasswordlessEmailCodeMembers</a>}> -> **useLoginPasswordlessEmailCode**(): [`LoginPasswordlessEmailCodeMembers`](../../../../Types/interfaces/LoginPasswordlessEmailCodeMembers) +<ParamField body='useLoginPasswordlessEmailCode' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers">LoginPasswordlessEmailCodeMembers</a>}> +> **useLoginPasswordlessEmailCode**(): [`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L53) **Returns** -[`LoginPasswordlessEmailCodeMembers`](../../../../Types/interfaces/LoginPasswordlessEmailCodeMembers) +[`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend">useResend</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index.mdx index 7498dc10b..2c8727996 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index.mdx @@ -4,8 +4,8 @@ title: "login-passwordless-sms-otp" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp">ScreenMembersOnLoginPasswordlessSmsOtp</a>}> -> **useScreen**: () => [`ScreenMembersOnLoginPasswordlessSmsOtp`](../../../../Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp">ScreenMembersOnLoginPasswordlessSmsOtp</a>}> +> **useScreen**: () => [`ScreenMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnLoginPasswordlessSmsOtp`](../../../../Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp) +[`ScreenMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp">TransactionMembersOnLoginPasswordlessSmsOtp</a>}> -> **useTransaction**: () => [`TransactionMembersOnLoginPasswordlessSmsOtp`](../../../../Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp">TransactionMembersOnLoginPasswordlessSmsOtp</a>}> +> **useTransaction**: () => [`TransactionMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembersOnLoginPasswordlessSmsOtp`](../../../../Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp) +[`TransactionMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.ts **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,38 +242,38 @@ Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.ts **payload** -[`SubmitOTPOptions`](../../../../Types/interfaces/SubmitOTPOptions) +[`SubmitOTPOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitOTPOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useLoginPasswordlessSmsOtp' type={<a href="../../../../Types/interfaces/LoginPasswordlessSmsOtpMembers">LoginPasswordlessSmsOtpMembers</a>}> -> **useLoginPasswordlessSmsOtp**(): [`LoginPasswordlessSmsOtpMembers`](../../../../Types/interfaces/LoginPasswordlessSmsOtpMembers) +<ParamField body='useLoginPasswordlessSmsOtp' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers">LoginPasswordlessSmsOtpMembers</a>}> +> **useLoginPasswordlessSmsOtp**(): [`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers) Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L53) **Returns** -[`LoginPasswordlessSmsOtpMembers`](../../../../Types/interfaces/LoginPasswordlessSmsOtpMembers) +[`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend">useResend</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index.mdx index 1d2202a86..39276616e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index.mdx @@ -4,8 +4,8 @@ title: "login" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/login.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L26) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/login.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L27) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/login.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L28) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/login.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L29) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnLogin">ScreenMembersOnLogin</a>}> -> **useScreen**: () => [`ScreenMembersOnLogin`](../../../../Types/interfaces/ScreenMembersOnLogin) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin">ScreenMembersOnLogin</a>}> +> **useScreen**: () => [`ScreenMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin) Defined in: [packages/auth0-acul-react/src/screens/login.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L30) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnLogin`](../../../../Types/interfaces/ScreenMembersOnLogin) +[`ScreenMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/login.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L25) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnLogin">TransactionMembersOnLogin</a>}> -> **useTransaction**: () => [`TransactionMembersOnLogin`](../../../../Types/interfaces/TransactionMembersOnLogin) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin">TransactionMembersOnLogin</a>}> +> **useTransaction**: () => [`TransactionMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin) Defined in: [packages/auth0-acul-react/src/screens/login.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L31) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembersOnLogin`](../../../../Types/interfaces/TransactionMembersOnLogin) +[`TransactionMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/login.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L32) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/login.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L24) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login.tsx:37](https://github. **payload** -[`FederatedLoginPayloadOptions`](../../../../Types/interfaces/FederatedLoginPayloadOptions) +[`FederatedLoginPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPayloadOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login.tsx:36](https://github. **payload** -[`LoginPayloadOptions`](../../../../Types/interfaces/LoginPayloadOptions) +[`LoginPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPayloadOptions) **Returns** @@ -258,38 +258,38 @@ Defined in: [packages/auth0-acul-react/src/screens/login.tsx:39](https://github. **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useLogin' type={<a href="../../../../Types/interfaces/LoginMembers">LoginMembers</a>}> -> **useLogin**(): [`LoginMembers`](../../../../Types/interfaces/LoginMembers) +<ParamField body='useLogin' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers">LoginMembers</a>}> +> **useLogin**(): [`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers) Defined in: [packages/auth0-acul-react/src/screens/login.tsx:57](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L57) **Returns** -[`LoginMembers`](../../../../Types/interfaces/LoginMembers) +[`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useLoginIdentifiers">useLoginIdentifiers</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useLoginIdentifiers">useLoginIdentifiers</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index.mdx index 3e8373fa4..eeef16434 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index.mdx @@ -4,8 +4,8 @@ title: "logout-aborted" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L17) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L18) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L19) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L20) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L21) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L16) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L22) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L23) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L15) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -217,29 +217,29 @@ function UserProfile() { ## Functions -<ParamField body='useLogoutAborted' type={<a href="../../../../Types/interfaces/LogoutAbortedMembers">LogoutAbortedMembers</a>}> -> **useLogoutAborted**(): [`LogoutAbortedMembers`](../../../../Types/interfaces/LogoutAbortedMembers) +<ParamField body='useLogoutAborted' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers">LogoutAbortedMembers</a>}> +> **useLogoutAborted**(): [`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L38) **Returns** -[`LogoutAbortedMembers`](../../../../Types/interfaces/LogoutAbortedMembers) +[`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index.mdx index 0e45a700c..8d2ee3773 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index.mdx @@ -4,8 +4,8 @@ title: "logout-complete" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L17) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L18) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L19) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L20) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L21) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L16) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L22) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L23) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L15) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -217,29 +217,29 @@ function UserProfile() { ## Functions -<ParamField body='useLogoutComplete' type={<a href="../../../../Types/interfaces/LogoutCompleteMembers">LogoutCompleteMembers</a>}> -> **useLogoutComplete**(): [`LogoutCompleteMembers`](../../../../Types/interfaces/LogoutCompleteMembers) +<ParamField body='useLogoutComplete' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers">LogoutCompleteMembers</a>}> +> **useLogoutComplete**(): [`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers) Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L38) **Returns** -[`LogoutCompleteMembers`](../../../../Types/interfaces/LogoutCompleteMembers) +[`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index.mdx index 3a4830c30..4c0b6b78e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index.mdx @@ -4,8 +4,8 @@ title: "logout" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L21) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L22) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L23) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L24) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L25) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L20) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L26) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L27) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L19) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,36 +226,36 @@ Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:31](https://github **payload** -[`ConfirmLogoutOptions`](../../../../Types/interfaces/ConfirmLogoutOptions) +[`ConfirmLogoutOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useLogout' type={<a href="../../../../Types/interfaces/LogoutMembers">LogoutMembers</a>}> -> **useLogout**(): [`LogoutMembers`](../../../../Types/interfaces/LogoutMembers) +<ParamField body='useLogout' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers">LogoutMembers</a>}> +> **useLogout**(): [`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers) Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:46](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L46) **Returns** -[`LogoutMembers`](../../../../Types/interfaces/LogoutMembers) +[`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index.mdx index 7dcb2d136..2e55b40af 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index.mdx @@ -4,8 +4,8 @@ title: "mfa-begin-enroll-options" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,36 +226,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx: **payload** -[`MfaEnrollOptions`](../../../../Types/interfaces/MfaEnrollOptions) +[`MfaEnrollOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaBeginEnrollOptions' type={<a href="../../../../Types/interfaces/MfaBeginEnrollOptionsMembers">MfaBeginEnrollOptionsMembers</a>}> -> **useMfaBeginEnrollOptions**(): [`MfaBeginEnrollOptionsMembers`](../../../../Types/interfaces/MfaBeginEnrollOptionsMembers) +<ParamField body='useMfaBeginEnrollOptions' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers">MfaBeginEnrollOptionsMembers</a>}> +> **useMfaBeginEnrollOptions**(): [`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L48) **Returns** -[`MfaBeginEnrollOptionsMembers`](../../../../Types/interfaces/MfaBeginEnrollOptionsMembers) +[`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index.mdx index 545b696f5..acf3f1a31 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index.mdx @@ -4,8 +4,8 @@ title: "mfa-country-codes" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaCountryCodes">ScreenMembersOnMfaCountryCodes</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaCountryCodes`](../../../../Types/interfaces/ScreenMembersOnMfaCountryCodes) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes">ScreenMembersOnMfaCountryCodes</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaCountryCodes`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes) Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaCountryCodes`](../../../../Types/interfaces/ScreenMembersOnMfaCountryCodes) +[`ScreenMembersOnMfaCountryCodes`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:37](htt **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:35](htt **payload** -[`SelectCountryCodeOptions`](../../../../Types/interfaces/SelectCountryCodeOptions) +[`SelectCountryCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectCountryCodeOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaCountryCodes' type={<a href="../../../../Types/interfaces/MfaCountryCodesMembers">MfaCountryCodesMembers</a>}> -> **useMfaCountryCodes**(): [`MfaCountryCodesMembers`](../../../../Types/interfaces/MfaCountryCodesMembers) +<ParamField body='useMfaCountryCodes' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers">MfaCountryCodesMembers</a>}> +> **useMfaCountryCodes**(): [`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L51) **Returns** -[`MfaCountryCodesMembers`](../../../../Types/interfaces/MfaCountryCodesMembers) +[`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index.mdx index 4ae85e913..64b189cd4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index.mdx @@ -4,8 +4,8 @@ title: "mfa-detect-browser-capabilities" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,36 +226,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabiliti **payload** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaDetectBrowserCapabilities' type={<a href="../../../../Types/interfaces/MfaDetectBrowserCapabilitiesMembers">MfaDetectBrowserCapabilitiesMembers</a>}> -> **useMfaDetectBrowserCapabilities**(): [`MfaDetectBrowserCapabilitiesMembers`](../../../../Types/interfaces/MfaDetectBrowserCapabilitiesMembers) +<ParamField body='useMfaDetectBrowserCapabilities' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers">MfaDetectBrowserCapabilitiesMembers</a>}> +> **useMfaDetectBrowserCapabilities**(): [`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L49) **Returns** -[`MfaDetectBrowserCapabilitiesMembers`](../../../../Types/interfaces/MfaDetectBrowserCapabilitiesMembers) +[`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index.mdx index 0302e9f4e..9ca9e5a81 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index.mdx @@ -4,8 +4,8 @@ title: "mfa-email-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L27) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L28) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L29) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L30) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaEmailChallenge">ScreenMembersOnMfaEmailChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaEmailChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaEmailChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge">ScreenMembersOnMfaEmailChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L31) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaEmailChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaEmailChallenge) +[`ScreenMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L26) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L32) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge">UntrustedDataMembersOnMfaEmailChallenge</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembersOnMfaEmailChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge">UntrustedDataMembersOnMfaEmailChallenge</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L33) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembersOnMfaEmailChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge) +[`UntrustedDataMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L25) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:37](h **payload** -[`ContinuePayloadOptions`](../../../../Types/interfaces/ContinuePayloadOptions) +[`ContinuePayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinuePayloadOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:41](h **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -258,7 +258,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:38](h **payload?** -[`ResendCodePayloadOptions`](../../../../Types/interfaces/ResendCodePayloadOptions) +[`ResendCodePayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodePayloadOptions) **Returns** @@ -274,38 +274,38 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:39](h **payload?** -[`TryAnotherMethodPayloadOptions`](../../../../Types/interfaces/TryAnotherMethodPayloadOptions) +[`TryAnotherMethodPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodPayloadOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaEmailChallenge' type={<a href="../../../../Types/interfaces/MfaEmailChallengeMembers">MfaEmailChallengeMembers</a>}> -> **useMfaEmailChallenge**(): [`MfaEmailChallengeMembers`](../../../../Types/interfaces/MfaEmailChallengeMembers) +<ParamField body='useMfaEmailChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers">MfaEmailChallengeMembers</a>}> +> **useMfaEmailChallenge**(): [`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L58) **Returns** -[`MfaEmailChallengeMembers`](../../../../Types/interfaces/MfaEmailChallengeMembers) +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend">useResend</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index.mdx index 8294f2dfb..57249a030 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index.mdx @@ -4,8 +4,8 @@ title: "mfa-email-list" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaEmailList">ScreenMembersOnMfaEmailList</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaEmailList`](../../../../Types/interfaces/ScreenMembersOnMfaEmailList) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList">ScreenMembersOnMfaEmailList</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaEmailList`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaEmailList`](../../../../Types/interfaces/ScreenMembersOnMfaEmailList) +[`ScreenMembersOnMfaEmailList`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:37](https: **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:35](https: **payload** -[`SelectMfaEmailOptions`](../../../../Types/interfaces/SelectMfaEmailOptions) +[`SelectMfaEmailOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaEmailOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaEmailList' type={<a href="../../../../Types/interfaces/MfaEmailListMembers">MfaEmailListMembers</a>}> -> **useMfaEmailList**(): [`MfaEmailListMembers`](../../../../Types/interfaces/MfaEmailListMembers) +<ParamField body='useMfaEmailList' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers">MfaEmailListMembers</a>}> +> **useMfaEmailList**(): [`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L51) **Returns** -[`MfaEmailListMembers`](../../../../Types/interfaces/MfaEmailListMembers) +[`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index.mdx index 6a7927a0f..bd6a33139 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index.mdx @@ -4,8 +4,8 @@ title: "mfa-enroll-result" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L17) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L18) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L19) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L20) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaEnrollResult">ScreenMembersOnMfaEnrollResult</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaEnrollResult`](../../../../Types/interfaces/ScreenMembersOnMfaEnrollResult) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult">ScreenMembersOnMfaEnrollResult</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaEnrollResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult) Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L21) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaEnrollResult`](../../../../Types/interfaces/ScreenMembersOnMfaEnrollResult) +[`ScreenMembersOnMfaEnrollResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L16) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L22) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L23) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L15) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -217,29 +217,29 @@ function UserProfile() { ## Functions -<ParamField body='useMfaEnrollResult' type={<a href="../../../../Types/interfaces/MfaEnrollResultMembers">MfaEnrollResultMembers</a>}> -> **useMfaEnrollResult**(): [`MfaEnrollResultMembers`](../../../../Types/interfaces/MfaEnrollResultMembers) +<ParamField body='useMfaEnrollResult' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers">MfaEnrollResultMembers</a>}> +> **useMfaEnrollResult**(): [`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L38) **Returns** -[`MfaEnrollResultMembers`](../../../../Types/interfaces/MfaEnrollResultMembers) +[`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index.mdx index fe60b9d46..8ebf52731 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index.mdx @@ -4,8 +4,8 @@ title: "mfa-login-options" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaLoginOptions">ScreenMembersOnMfaLoginOptions</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaLoginOptions`](../../../../Types/interfaces/ScreenMembersOnMfaLoginOptions) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions">ScreenMembersOnMfaLoginOptions</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions) Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaLoginOptions`](../../../../Types/interfaces/ScreenMembersOnMfaLoginOptions) +[`ScreenMembersOnMfaLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:35](htt **payload** -[`LoginEnrollOptions`](../../../../Types/interfaces/LoginEnrollOptions) +[`LoginEnrollOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:36](htt **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaLoginOptions' type={<a href="../../../../Types/interfaces/MfaLoginOptionsMembers">MfaLoginOptionsMembers</a>}> -> **useMfaLoginOptions**(): [`MfaLoginOptionsMembers`](../../../../Types/interfaces/MfaLoginOptionsMembers) +<ParamField body='useMfaLoginOptions' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers">MfaLoginOptionsMembers</a>}> +> **useMfaLoginOptions**(): [`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L51) **Returns** -[`MfaLoginOptionsMembers`](../../../../Types/interfaces/MfaLoginOptionsMembers) +[`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index.mdx index 67e520cc6..9ca8dfc7f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index.mdx @@ -4,8 +4,8 @@ title: "mfa-otp-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaOtpChallenge">ScreenMembersOnMfaOtpChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaOtpChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaOtpChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge">ScreenMembersOnMfaOtpChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaOtpChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaOtpChallenge) +[`ScreenMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge">UntrustedDataMembersOnMfaOtpChallenge</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembersOnMfaOtpChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge">UntrustedDataMembersOnMfaOtpChallenge</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembersOnMfaOtpChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge) +[`UntrustedDataMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:35](htt **payload** -[`ContinueOTPOptions`](../../../../Types/interfaces/ContinueOTPOptions) +[`ContinueOTPOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOTPOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:36](htt **payload?** -[`TryAnotherMethodMfaOtpChallengeOptions`](../../../../Types/interfaces/TryAnotherMethodMfaOtpChallengeOptions) +[`TryAnotherMethodMfaOtpChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodMfaOtpChallengeOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaOtpChallenge' type={<a href="../../../../Types/interfaces/MfaOtpChallengeMembers">MfaOtpChallengeMembers</a>}> -> **useMfaOtpChallenge**(): [`MfaOtpChallengeMembers`](../../../../Types/interfaces/MfaOtpChallengeMembers) +<ParamField body='useMfaOtpChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers">MfaOtpChallengeMembers</a>}> +> **useMfaOtpChallenge**(): [`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L51) **Returns** -[`MfaOtpChallengeMembers`](../../../../Types/interfaces/MfaOtpChallengeMembers) +[`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index.mdx index 308525819..19714c08e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index.mdx @@ -4,8 +4,8 @@ title: "mfa-otp-enrollment-code" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode">ScreenMembersOnMfaOtpEnrollmentCode</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaOtpEnrollmentCode`](../../../../Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode">ScreenMembersOnMfaOtpEnrollmentCode</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaOtpEnrollmentCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaOtpEnrollmentCode`](../../../../Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode) +[`ScreenMembersOnMfaOtpEnrollmentCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:3 **payload** -[`MfaOtpContinueOptions`](../../../../Types/interfaces/MfaOtpContinueOptions) +[`MfaOtpContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpContinueOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:3 **payload?** -[`MfaOtpTryAnotherMethodOptions`](../../../../Types/interfaces/MfaOtpTryAnotherMethodOptions) +[`MfaOtpTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpTryAnotherMethodOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaOtpEnrollmentCode' type={<a href="../../../../Types/interfaces/MfaOtpEnrollmentCodeMembers">MfaOtpEnrollmentCodeMembers</a>}> -> **useMfaOtpEnrollmentCode**(): [`MfaOtpEnrollmentCodeMembers`](../../../../Types/interfaces/MfaOtpEnrollmentCodeMembers) +<ParamField body='useMfaOtpEnrollmentCode' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers">MfaOtpEnrollmentCodeMembers</a>}> +> **useMfaOtpEnrollmentCode**(): [`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L51) **Returns** -[`MfaOtpEnrollmentCodeMembers`](../../../../Types/interfaces/MfaOtpEnrollmentCodeMembers) +[`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index.mdx index c6e44a071..72900b2d2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index.mdx @@ -4,8 +4,8 @@ title: "mfa-otp-enrollment-qr" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr">ScreenMembersOnMfaOtpEnrollmentQr</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaOtpEnrollmentQr`](../../../../Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr">ScreenMembersOnMfaOtpEnrollmentQr</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaOtpEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaOtpEnrollmentQr`](../../../../Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr) +[`ScreenMembersOnMfaOtpEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:36] **payload** -[`MfaOtpEnrollmentQrContinueOptions`](../../../../Types/interfaces/MfaOtpEnrollmentQrContinueOptions) +[`MfaOtpEnrollmentQrContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:35] **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -258,36 +258,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:37] **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaOtpEnrollmentQr' type={<a href="../../../../Types/interfaces/MfaOtpEnrollmentQrMembers">MfaOtpEnrollmentQrMembers</a>}> -> **useMfaOtpEnrollmentQr**(): [`MfaOtpEnrollmentQrMembers`](../../../../Types/interfaces/MfaOtpEnrollmentQrMembers) +<ParamField body='useMfaOtpEnrollmentQr' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers">MfaOtpEnrollmentQrMembers</a>}> +> **useMfaOtpEnrollmentQr**(): [`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L52) **Returns** -[`MfaOtpEnrollmentQrMembers`](../../../../Types/interfaces/MfaOtpEnrollmentQrMembers) +[`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index.mdx index d3afbcdce..d601b09f7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index.mdx @@ -4,8 +4,8 @@ title: "mfa-phone-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L26) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L27) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L28) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L29) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaPhoneChallenge">ScreenMembersOnMfaPhoneChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaPhoneChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaPhoneChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge">ScreenMembersOnMfaPhoneChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L30) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaPhoneChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaPhoneChallenge) +[`ScreenMembersOnMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L25) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L31) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L32) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L24) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:36](h **payload** -[`MfaPhoneChallengeContinueOptions`](../../../../Types/interfaces/MfaPhoneChallengeContinueOptions) +[`MfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:37](h **payload?** -[`MfaPhoneChallengePickPhoneOptions`](../../../../Types/interfaces/MfaPhoneChallengePickPhoneOptions) +[`MfaPhoneChallengePickPhoneOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions) **Returns** @@ -258,36 +258,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:38](h **payload?** -[`MfaPhoneChallengePickAuthenticatorOptions`](../../../../Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions) +[`MfaPhoneChallengePickAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaPhoneChallenge' type={<a href="../../../../Types/interfaces/MfaPhoneChallengeMembers">MfaPhoneChallengeMembers</a>}> -> **useMfaPhoneChallenge**(): [`MfaPhoneChallengeMembers`](../../../../Types/interfaces/MfaPhoneChallengeMembers) +<ParamField body='useMfaPhoneChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers">MfaPhoneChallengeMembers</a>}> +> **useMfaPhoneChallenge**(): [`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L53) **Returns** -[`MfaPhoneChallengeMembers`](../../../../Types/interfaces/MfaPhoneChallengeMembers) +[`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index.mdx index 494496bf8..c3e9f2e6c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index.mdx @@ -4,8 +4,8 @@ title: "mfa-phone-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:37]( **payload** -[`MfaPhoneEnrollmentContinueOptions`](../../../../Types/interfaces/MfaPhoneEnrollmentContinueOptions) +[`MfaPhoneEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:35]( **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -258,36 +258,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:39]( **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaPhoneEnrollment' type={<a href="../../../../Types/interfaces/MfaPhoneEnrollmentMembers">MfaPhoneEnrollmentMembers</a>}> -> **useMfaPhoneEnrollment**(): [`MfaPhoneEnrollmentMembers`](../../../../Types/interfaces/MfaPhoneEnrollmentMembers) +<ParamField body='useMfaPhoneEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers">MfaPhoneEnrollmentMembers</a>}> +> **useMfaPhoneEnrollment**(): [`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L54) **Returns** -[`MfaPhoneEnrollmentMembers`](../../../../Types/interfaces/MfaPhoneEnrollmentMembers) +[`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index.mdx index 1ec475087..9c906acd5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index.mdx @@ -4,8 +4,8 @@ title: "mfa-push-challenge-push" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaPushChallengePush">ScreenMembersOnMfaPushChallengePush</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaPushChallengePush`](../../../../Types/interfaces/ScreenMembersOnMfaPushChallengePush) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush">ScreenMembersOnMfaPushChallengePush</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaPushChallengePush`](../../../../Types/interfaces/ScreenMembersOnMfaPushChallengePush) +[`ScreenMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush">UntrustedDataMembersOnMfaPushChallengePush</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembersOnMfaPushChallengePush`](../../../../Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush">UntrustedDataMembersOnMfaPushChallengePush</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembersOnMfaPushChallengePush`](../../../../Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush) +[`UntrustedDataMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:3 **payload?** -[`WithRememberOptions`](../../../../Types/interfaces/WithRememberOptions) +[`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:3 **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -258,7 +258,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:3 **payload?** -[`WithRememberOptions`](../../../../Types/interfaces/WithRememberOptions) +[`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions) **Returns** @@ -274,38 +274,38 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:4 **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaPushChallengePush' type={<a href="../../../../Types/interfaces/MfaPushChallengePushMembers">MfaPushChallengePushMembers</a>}> -> **useMfaPushChallengePush**(): [`MfaPushChallengePushMembers`](../../../../Types/interfaces/MfaPushChallengePushMembers) +<ParamField body='useMfaPushChallengePush' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers">MfaPushChallengePushMembers</a>}> +> **useMfaPushChallengePush**(): [`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L59) **Returns** -[`MfaPushChallengePushMembers`](../../../../Types/interfaces/MfaPushChallengePushMembers) +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useMfaPolling">useMfaPolling</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useMfaPolling">useMfaPolling</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index.mdx index 0190b8ea0..47e029a92 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index.mdx @@ -4,8 +4,8 @@ title: "mfa-push-enrollment-qr" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr">ScreenMembersOnMfaPushEnrollmentQr</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaPushEnrollmentQr`](../../../../Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr">ScreenMembersOnMfaPushEnrollmentQr</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaPushEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaPushEnrollmentQr`](../../../../Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr) +[`ScreenMembersOnMfaPushEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,38 +226,38 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:34 **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaPushEnrollmentQr' type={<a href="../../../../Types/interfaces/MfaPushEnrollmentQrMembers">MfaPushEnrollmentQrMembers</a>}> -> **useMfaPushEnrollmentQr**(): [`MfaPushEnrollmentQrMembers`](../../../../Types/interfaces/MfaPushEnrollmentQrMembers) +<ParamField body='useMfaPushEnrollmentQr' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers">MfaPushEnrollmentQrMembers</a>}> +> **useMfaPushEnrollmentQr**(): [`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L52) **Returns** -[`MfaPushEnrollmentQrMembers`](../../../../Types/interfaces/MfaPushEnrollmentQrMembers) +[`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useMfaPolling">useMfaPolling</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useMfaPolling">useMfaPolling</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index.mdx index 9c3dc5a15..f590b27cf 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index.mdx @@ -4,8 +4,8 @@ title: "mfa-push-list" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:37](https:/ **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:35](https:/ **payload** -[`SelectMfaPushDeviceOptions`](../../../../Types/interfaces/SelectMfaPushDeviceOptions) +[`SelectMfaPushDeviceOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaPushDeviceOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaPushList' type={<a href="../../../../Types/interfaces/MfaPushListMembers">MfaPushListMembers</a>}> -> **useMfaPushList**(): [`MfaPushListMembers`](../../../../Types/interfaces/MfaPushListMembers) +<ParamField body='useMfaPushList' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers">MfaPushListMembers</a>}> +> **useMfaPushList**(): [`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L51) **Returns** -[`MfaPushListMembers`](../../../../Types/interfaces/MfaPushListMembers) +[`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index.mdx index c29736bf1..d95d4f404 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index.mdx @@ -4,8 +4,8 @@ title: "mfa-push-welcome" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L21) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L22) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L23) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L24) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaPushWelcome">ScreenMembersOnMfaPushWelcome</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaPushWelcome`](../../../../Types/interfaces/ScreenMembersOnMfaPushWelcome) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome">ScreenMembersOnMfaPushWelcome</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaPushWelcome`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L25) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaPushWelcome`](../../../../Types/interfaces/ScreenMembersOnMfaPushWelcome) +[`ScreenMembersOnMfaPushWelcome`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L20) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L26) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L27) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L19) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:31](http **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:32](http **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaPushWelcome' type={<a href="../../../../Types/interfaces/MfaPushWelcomeMembers">MfaPushWelcomeMembers</a>}> -> **useMfaPushWelcome**(): [`MfaPushWelcomeMembers`](../../../../Types/interfaces/MfaPushWelcomeMembers) +<ParamField body='useMfaPushWelcome' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers">MfaPushWelcomeMembers</a>}> +> **useMfaPushWelcome**(): [`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:47](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L47) **Returns** -[`MfaPushWelcomeMembers`](../../../../Types/interfaces/MfaPushWelcomeMembers) +[`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index.mdx index eafd616d3..c56402f89 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index.mdx @@ -4,8 +4,8 @@ title: "mfa-recovery-code-challenge-new-code" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L26) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L27) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L28) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L29) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode">ScreenMembersOnMfaRecoveryCodeChallengeNewCode</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](../../../../Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode">ScreenMembersOnMfaRecoveryCodeChallengeNewCode</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L30) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](../../../../Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode) +[`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L25) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L31) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L32) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L24) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,36 +226,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-n **payload?** -[`MfaRecoveryCodeChallengeNewCodeContinueOptions`](../../../../Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions) +[`MfaRecoveryCodeChallengeNewCodeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaRecoveryCodeChallengeNewCode' type={<a href="../../../../Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers">MfaRecoveryCodeChallengeNewCodeMembers</a>}> -> **useMfaRecoveryCodeChallengeNewCode**(): [`MfaRecoveryCodeChallengeNewCodeMembers`](../../../../Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers) +<ParamField body='useMfaRecoveryCodeChallengeNewCode' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers">MfaRecoveryCodeChallengeNewCodeMembers</a>}> +> **useMfaRecoveryCodeChallengeNewCode**(): [`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:50](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L50) **Returns** -[`MfaRecoveryCodeChallengeNewCodeMembers`](../../../../Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers) +[`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index.mdx index 4d27021e1..951851e5b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index.mdx @@ -4,8 +4,8 @@ title: "mfa-recovery-code-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.t **payload** -[`MfaRecoveryCodeChallengeContinueOptions`](../../../../Types/interfaces/MfaRecoveryCodeChallengeContinueOptions) +[`MfaRecoveryCodeChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.t **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaRecoveryCodeChallenge' type={<a href="../../../../Types/interfaces/MfaRecoveryCodeChallengeMembers">MfaRecoveryCodeChallengeMembers</a>}> -> **useMfaRecoveryCodeChallenge**(): [`MfaRecoveryCodeChallengeMembers`](../../../../Types/interfaces/MfaRecoveryCodeChallengeMembers) +<ParamField body='useMfaRecoveryCodeChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers">MfaRecoveryCodeChallengeMembers</a>}> +> **useMfaRecoveryCodeChallenge**(): [`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L51) **Returns** -[`MfaRecoveryCodeChallengeMembers`](../../../../Types/interfaces/MfaRecoveryCodeChallengeMembers) +[`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index.mdx index 5e4e260f4..f5f9be027 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index.mdx @@ -4,8 +4,8 @@ title: "mfa-recovery-code-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment">ScreenMembersOnMfaRecoveryCodeEnrollment</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaRecoveryCodeEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment">ScreenMembersOnMfaRecoveryCodeEnrollment</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaRecoveryCodeEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaRecoveryCodeEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment) +[`ScreenMembersOnMfaRecoveryCodeEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,36 +226,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment. **payload** -[`MfaRecoveryCodeEnrollmentContinueOptions`](../../../../Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions) +[`MfaRecoveryCodeEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaRecoveryCodeEnrollment' type={<a href="../../../../Types/interfaces/MfaRecoveryCodeEnrollmentMembers">MfaRecoveryCodeEnrollmentMembers</a>}> -> **useMfaRecoveryCodeEnrollment**(): [`MfaRecoveryCodeEnrollmentMembers`](../../../../Types/interfaces/MfaRecoveryCodeEnrollmentMembers) +<ParamField body='useMfaRecoveryCodeEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers">MfaRecoveryCodeEnrollmentMembers</a>}> +> **useMfaRecoveryCodeEnrollment**(): [`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L49) **Returns** -[`MfaRecoveryCodeEnrollmentMembers`](../../../../Types/interfaces/MfaRecoveryCodeEnrollmentMembers) +[`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index.mdx index 9dadb0abd..06f3e2cc3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index.mdx @@ -4,8 +4,8 @@ title: "mfa-sms-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaSmsChallenge">ScreenMembersOnMfaSmsChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaSmsChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaSmsChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge">ScreenMembersOnMfaSmsChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaSmsChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaSmsChallenge) +[`ScreenMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge">UntrustedDataMembersOnMfaSmsChallenge</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembersOnMfaSmsChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge">UntrustedDataMembersOnMfaSmsChallenge</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembersOnMfaSmsChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge) +[`UntrustedDataMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:35](htt **payload** -[`MfaSmsChallengeOptions`](../../../../Types/interfaces/MfaSmsChallengeOptions) +[`MfaSmsChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:41](htt **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -258,7 +258,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:37](htt **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -274,7 +274,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:38](htt **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -290,38 +290,38 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:39](htt **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaSmsChallenge' type={<a href="../../../../Types/interfaces/MfaSmsChallengeMembers">MfaSmsChallengeMembers</a>}> -> **useMfaSmsChallenge**(): [`MfaSmsChallengeMembers`](../../../../Types/interfaces/MfaSmsChallengeMembers) +<ParamField body='useMfaSmsChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers">MfaSmsChallengeMembers</a>}> +> **useMfaSmsChallenge**(): [`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L58) **Returns** -[`MfaSmsChallengeMembers`](../../../../Types/interfaces/MfaSmsChallengeMembers) +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend">useResend</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index.mdx index 933f557f7..7dac04800 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index.mdx @@ -4,8 +4,8 @@ title: "mfa-sms-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaSmsEnrollment">ScreenMembersOnMfaSmsEnrollment</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaSmsEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaSmsEnrollment) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment">ScreenMembersOnMfaSmsEnrollment</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaSmsEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaSmsEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaSmsEnrollment) +[`ScreenMembersOnMfaSmsEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -248,7 +248,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:34](ht **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -264,36 +264,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:38](ht **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaSmsEnrollment' type={<a href="../../../../Types/interfaces/MfaSmsEnrollmentMembers">MfaSmsEnrollmentMembers</a>}> -> **useMfaSmsEnrollment**(): [`MfaSmsEnrollmentMembers`](../../../../Types/interfaces/MfaSmsEnrollmentMembers) +<ParamField body='useMfaSmsEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers">MfaSmsEnrollmentMembers</a>}> +> **useMfaSmsEnrollment**(): [`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L53) **Returns** -[`MfaSmsEnrollmentMembers`](../../../../Types/interfaces/MfaSmsEnrollmentMembers) +[`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index.mdx index 6b3a25b8a..73f0e8d9a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index.mdx @@ -4,8 +4,8 @@ title: "mfa-sms-list" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:37](https:// **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:35](https:// **payload?** -[`MfaSmsListOptions`](../../../../Types/interfaces/MfaSmsListOptions) +[`MfaSmsListOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaSmsList' type={<a href="../../../../Types/interfaces/MfaSmsListMembers">MfaSmsListMembers</a>}> -> **useMfaSmsList**(): [`MfaSmsListMembers`](../../../../Types/interfaces/MfaSmsListMembers) +<ParamField body='useMfaSmsList' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers">MfaSmsListMembers</a>}> +> **useMfaSmsList**(): [`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L51) **Returns** -[`MfaSmsListMembers`](../../../../Types/interfaces/MfaSmsListMembers) +[`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index.mdx index c5ce0c227..af4dbd01f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index.mdx @@ -4,8 +4,8 @@ title: "mfa-voice-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaVoiceChallenge">ScreenMembersOnMfaVoiceChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaVoiceChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaVoiceChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge">ScreenMembersOnMfaVoiceChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaVoiceChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaVoiceChallenge) +[`ScreenMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge">UntrustedDataMembersOnMfaVoiceChallenge</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembersOnMfaVoiceChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge">UntrustedDataMembersOnMfaVoiceChallenge</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembersOnMfaVoiceChallenge`](../../../../Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge) +[`UntrustedDataMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:35](h **payload** -[`MfaVoiceChallengeContinueOptions`](../../../../Types/interfaces/MfaVoiceChallengeContinueOptions) +[`MfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeContinueOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:37](h **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -258,7 +258,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:39](h **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -274,7 +274,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:38](h **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -290,38 +290,38 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:40](h **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaVoiceChallenge' type={<a href="../../../../Types/interfaces/MfaVoiceChallengeMembers">MfaVoiceChallengeMembers</a>}> -> **useMfaVoiceChallenge**(): [`MfaVoiceChallengeMembers`](../../../../Types/interfaces/MfaVoiceChallengeMembers) +<ParamField body='useMfaVoiceChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers">MfaVoiceChallengeMembers</a>}> +> **useMfaVoiceChallenge**(): [`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L58) **Returns** -[`MfaVoiceChallengeMembers`](../../../../Types/interfaces/MfaVoiceChallengeMembers) +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend">useResend</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index.mdx index 8deaa0a1f..453bad7f8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index.mdx @@ -4,8 +4,8 @@ title: "mfa-voice-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:35]( **payload** -[`MfaVoiceEnrollmentContinueOptions`](../../../../Types/interfaces/MfaVoiceEnrollmentContinueOptions) +[`MfaVoiceEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:38]( **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -258,36 +258,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:36]( **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaVoiceEnrollment' type={<a href="../../../../Types/interfaces/MfaVoiceEnrollmentMembers">MfaVoiceEnrollmentMembers</a>}> -> **useMfaVoiceEnrollment**(): [`MfaVoiceEnrollmentMembers`](../../../../Types/interfaces/MfaVoiceEnrollmentMembers) +<ParamField body='useMfaVoiceEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers">MfaVoiceEnrollmentMembers</a>}> +> **useMfaVoiceEnrollment**(): [`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L53) **Returns** -[`MfaVoiceEnrollmentMembers`](../../../../Types/interfaces/MfaVoiceEnrollmentMembers) +[`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index.mdx index b05a226e4..46ffc76a9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index.mdx @@ -4,8 +4,8 @@ title: "mfa-webauthn-change-key-nickname" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname">ScreenMembersOnMfaWebAuthnChangeKeyNickname</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname">ScreenMembersOnMfaWebAuthnChangeKeyNickname</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname) +[`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,36 +226,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickn **payload** -[`MfaWebAuthnChangeKeyNicknameContinueOptions`](../../../../Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions) +[`MfaWebAuthnChangeKeyNicknameContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaWebAuthnChangeKeyNickname' type={<a href="../../../../Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers">MfaWebAuthnChangeKeyNicknameMembers</a>}> -> **useMfaWebAuthnChangeKeyNickname**(): [`MfaWebAuthnChangeKeyNicknameMembers`](../../../../Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers) +<ParamField body='useMfaWebAuthnChangeKeyNickname' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers">MfaWebAuthnChangeKeyNicknameMembers</a>}> +> **useMfaWebAuthnChangeKeyNickname**(): [`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L49) **Returns** -[`MfaWebAuthnChangeKeyNicknameMembers`](../../../../Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers) +[`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index.mdx index 3df26d093..c37bced55 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index.mdx @@ -4,8 +4,8 @@ title: "mfa-webauthn-enrollment-success" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess">ScreenMembersOnMfaWebAuthnEnrollmentSuccess</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess">ScreenMembersOnMfaWebAuthnEnrollmentSuccess</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess) +[`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,36 +226,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-succe **payload?** -[`WebAuthnEnrollSuccessContinueOptions`](../../../../Types/interfaces/WebAuthnEnrollSuccessContinueOptions) +[`WebAuthnEnrollSuccessContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaWebAuthnEnrollmentSuccess' type={<a href="../../../../Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers">MfaWebAuthnEnrollmentSuccessMembers</a>}> -> **useMfaWebAuthnEnrollmentSuccess**(): [`MfaWebAuthnEnrollmentSuccessMembers`](../../../../Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers) +<ParamField body='useMfaWebAuthnEnrollmentSuccess' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers">MfaWebAuthnEnrollmentSuccessMembers</a>}> +> **useMfaWebAuthnEnrollmentSuccess**(): [`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L48) **Returns** -[`MfaWebAuthnEnrollmentSuccessMembers`](../../../../Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers) +[`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index.mdx index 05a00b8aa..44062688d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index.mdx @@ -4,8 +4,8 @@ title: "mfa-webauthn-error" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnError">ScreenMembersOnMfaWebAuthnError</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnError`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnError) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError">ScreenMembersOnMfaWebAuthnError</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnError`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaWebAuthnError`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnError) +[`ScreenMembersOnMfaWebAuthnError`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:38](ht **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:34](ht **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -258,21 +258,21 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:36](ht **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaWebAuthnError' type={<a href="../../../../Types/interfaces/MfaWebAuthnErrorMembers">MfaWebAuthnErrorMembers</a>}> -> **useMfaWebAuthnError**(): [`MfaWebAuthnErrorMembers`](../../../../Types/interfaces/MfaWebAuthnErrorMembers) +<ParamField body='useMfaWebAuthnError' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers">MfaWebAuthnErrorMembers</a>}> +> **useMfaWebAuthnError**(): [`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L52) **Returns** -[`MfaWebAuthnErrorMembers`](../../../../Types/interfaces/MfaWebAuthnErrorMembers) +[`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers) </ParamField> <ParamField body='usePassword' type={<span>void | Promise<void></span>}> @@ -284,7 +284,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:35](ht **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -294,16 +294,16 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:35](ht ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index.mdx index 9d5a0ec5d..0fae02c99 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index.mdx @@ -4,8 +4,8 @@ title: "mfa-webauthn-not-available-error" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,36 +226,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-er **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaWebAuthnNotAvailableError' type={<a href="../../../../Types/interfaces/MfaWebAuthnNotAvailableErrorMembers">MfaWebAuthnNotAvailableErrorMembers</a>}> -> **useMfaWebAuthnNotAvailableError**(): [`MfaWebAuthnNotAvailableErrorMembers`](../../../../Types/interfaces/MfaWebAuthnNotAvailableErrorMembers) +<ParamField body='useMfaWebAuthnNotAvailableError' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers">MfaWebAuthnNotAvailableErrorMembers</a>}> +> **useMfaWebAuthnNotAvailableError**(): [`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L49) **Returns** -[`MfaWebAuthnNotAvailableErrorMembers`](../../../../Types/interfaces/MfaWebAuthnNotAvailableErrorMembers) +[`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index.mdx index a6d41c390..019d7fe1d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index.mdx @@ -4,8 +4,8 @@ title: "mfa-webauthn-platform-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L26) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L27) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L28) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L29) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge">ScreenMembersOnMfaWebAuthnPlatformChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnPlatformChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge">ScreenMembersOnMfaWebAuthnPlatformChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L30) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaWebAuthnPlatformChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge) +[`ScreenMembersOnMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L25) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L31) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L32) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L24) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challen **options** -[`MfaWebAuthnPlatformChallengeReportErrorOptions`](../../../../Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions) +[`MfaWebAuthnPlatformChallengeReportErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions) **Returns** @@ -242,21 +242,21 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challen **options?** -[`MfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](../../../../Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions) +[`MfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaWebAuthnPlatformChallenge' type={<a href="../../../../Types/interfaces/MfaWebAuthnPlatformChallengeMembers">MfaWebAuthnPlatformChallengeMembers</a>}> -> **useMfaWebAuthnPlatformChallenge**(): [`MfaWebAuthnPlatformChallengeMembers`](../../../../Types/interfaces/MfaWebAuthnPlatformChallengeMembers) +<ParamField body='useMfaWebAuthnPlatformChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers">MfaWebAuthnPlatformChallengeMembers</a>}> +> **useMfaWebAuthnPlatformChallenge**(): [`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:55](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L55) **Returns** -[`MfaWebAuthnPlatformChallengeMembers`](../../../../Types/interfaces/MfaWebAuthnPlatformChallengeMembers) +[`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers) </ParamField> <ParamField body='verify' type={<span>void | Promise<void></span>}> @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challen **options?** -[`VerifyPlatformAuthenticatorOptions`](../../../../Types/interfaces/VerifyPlatformAuthenticatorOptions) +[`VerifyPlatformAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions) **Returns** @@ -278,16 +278,16 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challen ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index.mdx index 6ffc1897f..5204e1ff6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index.mdx @@ -4,8 +4,8 @@ title: "mfa-webauthn-platform-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L28) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L29) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L30) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L31) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment">ScreenMembersOnMfaWebAuthnPlatformEnrollment</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment">ScreenMembersOnMfaWebAuthnPlatformEnrollment</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L32) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment) +[`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L27) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L33) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L34) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L26) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollm **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollm **payload** -[`ReportBrowserErrorOptions`](../../../../Types/interfaces/ReportBrowserErrorOptions) +[`ReportBrowserErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions) **Returns** @@ -258,7 +258,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollm **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -274,36 +274,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollm **payload?** -[`SubmitPasskeyCredentialOptions`](../../../../Types/interfaces/SubmitPasskeyCredentialOptions) +[`SubmitPasskeyCredentialOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaWebAuthnPlatformEnrollment' type={<a href="../../../../Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers">MfaWebAuthnPlatformEnrollmentMembers</a>}> -> **useMfaWebAuthnPlatformEnrollment**(): [`MfaWebAuthnPlatformEnrollmentMembers`](../../../../Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers) +<ParamField body='useMfaWebAuthnPlatformEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers">MfaWebAuthnPlatformEnrollmentMembers</a>}> +> **useMfaWebAuthnPlatformEnrollment**(): [`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L59) **Returns** -[`MfaWebAuthnPlatformEnrollmentMembers`](../../../../Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers) +[`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index.mdx index b25532b1e..3de87b4e6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index.mdx @@ -4,8 +4,8 @@ title: "mfa-webauthn-roaming-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L26) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L27) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L28) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L29) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge">ScreenMembersOnMfaWebAuthnRoamingChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnRoamingChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge">ScreenMembersOnMfaWebAuthnRoamingChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L30) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaWebAuthnRoamingChallenge`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge) +[`ScreenMembersOnMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L25) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L31) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L32) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L24) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challeng **options** -[`MfaWebAuthnRoamingChallengeReportErrorOptions`](../../../../Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions) +[`MfaWebAuthnRoamingChallengeReportErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions) **Returns** @@ -242,21 +242,21 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challeng **options?** -[`MfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](../../../../Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions) +[`MfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaWebAuthnRoamingChallenge' type={<a href="../../../../Types/interfaces/MfaWebAuthnRoamingChallengeMembers">MfaWebAuthnRoamingChallengeMembers</a>}> -> **useMfaWebAuthnRoamingChallenge**(): [`MfaWebAuthnRoamingChallengeMembers`](../../../../Types/interfaces/MfaWebAuthnRoamingChallengeMembers) +<ParamField body='useMfaWebAuthnRoamingChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers">MfaWebAuthnRoamingChallengeMembers</a>}> +> **useMfaWebAuthnRoamingChallenge**(): [`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L54) **Returns** -[`MfaWebAuthnRoamingChallengeMembers`](../../../../Types/interfaces/MfaWebAuthnRoamingChallengeMembers) +[`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers) </ParamField> <ParamField body='verify' type={<span>void | Promise<void></span>}> @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challeng **options?** -[`VerifySecurityKeyOptions`](../../../../Types/interfaces/VerifySecurityKeyOptions) +[`VerifySecurityKeyOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions) **Returns** @@ -278,16 +278,16 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challeng ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index.mdx index 1cfe88a82..e0eba5ff3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index.mdx @@ -4,8 +4,8 @@ title: "mfa-webauthn-roaming-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L26) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L27) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L28) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L29) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment">ScreenMembersOnMfaWebAuthnRoamingEnrollment</a>}> -> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment">ScreenMembersOnMfaWebAuthnRoamingEnrollment</a>}> +> **useScreen**: () => [`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L30) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](../../../../Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment) +[`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L25) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L31) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L32) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L24) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollme **payload** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollme **payload** -[`ShowErrorOptions`](../../../../Types/interfaces/ShowErrorOptions) +[`ShowErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions) **Returns** @@ -258,36 +258,36 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollme **payload?** -[`MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions`](../../../../Types/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions) +[`MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useMfaWebAuthnRoamingEnrollment' type={<a href="../../../../Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers">MfaWebAuthnRoamingEnrollmentMembers</a>}> -> **useMfaWebAuthnRoamingEnrollment**(): [`MfaWebAuthnRoamingEnrollmentMembers`](../../../../Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers) +<ParamField body='useMfaWebAuthnRoamingEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers">MfaWebAuthnRoamingEnrollmentMembers</a>}> +> **useMfaWebAuthnRoamingEnrollment**(): [`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers) Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L53) **Returns** -[`MfaWebAuthnRoamingEnrollmentMembers`](../../../../Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers) +[`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index.mdx index 553cba034..90f8c84a3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index.mdx @@ -4,8 +4,8 @@ title: "organization-picker" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -248,36 +248,36 @@ Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:36](h **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useOrganizationPicker' type={<a href="../../../../Types/interfaces/OrganizationPickerMembers">OrganizationPickerMembers</a>}> -> **useOrganizationPicker**(): [`OrganizationPickerMembers`](../../../../Types/interfaces/OrganizationPickerMembers) +<ParamField body='useOrganizationPicker' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers">OrganizationPickerMembers</a>}> +> **useOrganizationPicker**(): [`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L51) **Returns** -[`OrganizationPickerMembers`](../../../../Types/interfaces/OrganizationPickerMembers) +[`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index.mdx index aaab782c6..ccff4ab71 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index.mdx @@ -4,8 +4,8 @@ title: "organization-selection" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnOrganizationSelection">ScreenMembersOnOrganizationSelection</a>}> -> **useScreen**: () => [`ScreenMembersOnOrganizationSelection`](../../../../Types/interfaces/ScreenMembersOnOrganizationSelection) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection">ScreenMembersOnOrganizationSelection</a>}> +> **useScreen**: () => [`ScreenMembersOnOrganizationSelection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection) Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnOrganizationSelection`](../../../../Types/interfaces/ScreenMembersOnOrganizationSelection) +[`ScreenMembersOnOrganizationSelection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,36 +226,36 @@ Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:34 **payload** -[`ContinueWithOrganizationNameOptions`](../../../../Types/interfaces/ContinueWithOrganizationNameOptions) +[`ContinueWithOrganizationNameOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithOrganizationNameOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useOrganizationSelection' type={<a href="../../../../Types/interfaces/OrganizationSelectionMembers">OrganizationSelectionMembers</a>}> -> **useOrganizationSelection**(): [`OrganizationSelectionMembers`](../../../../Types/interfaces/OrganizationSelectionMembers) +<ParamField body='useOrganizationSelection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers">OrganizationSelectionMembers</a>}> +> **useOrganizationSelection**(): [`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers) Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L49) **Returns** -[`OrganizationSelectionMembers`](../../../../Types/interfaces/OrganizationSelectionMembers) +[`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index.mdx index c1225d6b2..34aef81a5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index.mdx @@ -4,8 +4,8 @@ title: "passkey-enrollment-local" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal">ScreenMembersOnPasskeyEnrollmentLocal</a>}> -> **useScreen**: () => [`ScreenMembersOnPasskeyEnrollmentLocal`](../../../../Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal">ScreenMembersOnPasskeyEnrollmentLocal</a>}> +> **useScreen**: () => [`ScreenMembersOnPasskeyEnrollmentLocal`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnPasskeyEnrollmentLocal`](../../../../Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal) +[`ScreenMembersOnPasskeyEnrollmentLocal`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx: **payload** -[`AbortEnrollmentOptions`](../../../../Types/interfaces/AbortEnrollmentOptions) +[`AbortEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AbortEnrollmentOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx: **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='usePasskeyEnrollmentLocal' type={<a href="../../../../Types/interfaces/PasskeyEnrollmentLocalMembers">PasskeyEnrollmentLocalMembers</a>}> -> **usePasskeyEnrollmentLocal**(): [`PasskeyEnrollmentLocalMembers`](../../../../Types/interfaces/PasskeyEnrollmentLocalMembers) +<ParamField body='usePasskeyEnrollmentLocal' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers">PasskeyEnrollmentLocalMembers</a>}> +> **usePasskeyEnrollmentLocal**(): [`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L52) **Returns** -[`PasskeyEnrollmentLocalMembers`](../../../../Types/interfaces/PasskeyEnrollmentLocalMembers) +[`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index.mdx index f1ee5a265..eb88d86a7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index.mdx @@ -4,8 +4,8 @@ title: "passkey-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnPasskeyEnrollment">ScreenMembersOnPasskeyEnrollment</a>}> -> **useScreen**: () => [`ScreenMembersOnPasskeyEnrollment`](../../../../Types/interfaces/ScreenMembersOnPasskeyEnrollment) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment">ScreenMembersOnPasskeyEnrollment</a>}> +> **useScreen**: () => [`ScreenMembersOnPasskeyEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnPasskeyEnrollment`](../../../../Types/interfaces/ScreenMembersOnPasskeyEnrollment) +[`ScreenMembersOnPasskeyEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:36](ht **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:34](ht **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='usePasskeyEnrollment' type={<a href="../../../../Types/interfaces/PasskeyEnrollmentMembers">PasskeyEnrollmentMembers</a>}> -> **usePasskeyEnrollment**(): [`PasskeyEnrollmentMembers`](../../../../Types/interfaces/PasskeyEnrollmentMembers) +<ParamField body='usePasskeyEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers">PasskeyEnrollmentMembers</a>}> +> **usePasskeyEnrollment**(): [`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers) Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L51) **Returns** -[`PasskeyEnrollmentMembers`](../../../../Types/interfaces/PasskeyEnrollmentMembers) +[`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index.mdx index eb153bcd2..990cfe379 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index.mdx @@ -4,8 +4,8 @@ title: "phone-identifier-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge">ScreenMembersOnPhoneIdentifierChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnPhoneIdentifierChallenge`](../../../../Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge">ScreenMembersOnPhoneIdentifierChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnPhoneIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnPhoneIdentifierChallenge`](../../../../Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge) +[`ScreenMembersOnPhoneIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.ts **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.ts **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -258,7 +258,7 @@ Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.ts **payload** -[`PhoneChallengeOptions`](../../../../Types/interfaces/PhoneChallengeOptions) +[`PhoneChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneChallengeOptions) **Returns** @@ -274,7 +274,7 @@ Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.ts **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -290,38 +290,38 @@ Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.ts **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='usePhoneIdentifierChallenge' type={<a href="../../../../Types/interfaces/PhoneIdentifierChallengeMembers">PhoneIdentifierChallengeMembers</a>}> -> **usePhoneIdentifierChallenge**(): [`PhoneIdentifierChallengeMembers`](../../../../Types/interfaces/PhoneIdentifierChallengeMembers) +<ParamField body='usePhoneIdentifierChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers">PhoneIdentifierChallengeMembers</a>}> +> **usePhoneIdentifierChallenge**(): [`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L59) **Returns** -[`PhoneIdentifierChallengeMembers`](../../../../Types/interfaces/PhoneIdentifierChallengeMembers) +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend">useResend</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index.mdx index 8ac50aacf..7c9553faa 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index.mdx @@ -4,8 +4,8 @@ title: "phone-identifier-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment">ScreenMembersOnPhoneIdentifierEnrollment</a>}> -> **useScreen**: () => [`ScreenMembersOnPhoneIdentifierEnrollment`](../../../../Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment">ScreenMembersOnPhoneIdentifierEnrollment</a>}> +> **useScreen**: () => [`ScreenMembersOnPhoneIdentifierEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnPhoneIdentifierEnrollment`](../../../../Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment) +[`ScreenMembersOnPhoneIdentifierEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.t **payload** -[`PhoneEnrollmentOptions`](../../../../Types/interfaces/PhoneEnrollmentOptions) +[`PhoneEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.t **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='usePhoneIdentifierEnrollment' type={<a href="../../../../Types/interfaces/PhoneIdentifierEnrollmentMembers">PhoneIdentifierEnrollmentMembers</a>}> -> **usePhoneIdentifierEnrollment**(): [`PhoneIdentifierEnrollmentMembers`](../../../../Types/interfaces/PhoneIdentifierEnrollmentMembers) +<ParamField body='usePhoneIdentifierEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers">PhoneIdentifierEnrollmentMembers</a>}> +> **usePhoneIdentifierEnrollment**(): [`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers) Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L52) **Returns** -[`PhoneIdentifierEnrollmentMembers`](../../../../Types/interfaces/PhoneIdentifierEnrollmentMembers) +[`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index.mdx index b1acf4bcc..2f53e7775 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index.mdx @@ -4,8 +4,8 @@ title: "redeem-ticket" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L21) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L22) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L23) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L24) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L25) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L20) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L26) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L27) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L19) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,36 +226,36 @@ Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:31](https:/ **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useRedeemTicket' type={<a href="../../../../Types/interfaces/RedeemTicketMembers">RedeemTicketMembers</a>}> -> **useRedeemTicket**(): [`RedeemTicketMembers`](../../../../Types/interfaces/RedeemTicketMembers) +<ParamField body='useRedeemTicket' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers">RedeemTicketMembers</a>}> +> **useRedeemTicket**(): [`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers) Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:45](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L45) **Returns** -[`RedeemTicketMembers`](../../../../Types/interfaces/RedeemTicketMembers) +[`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index.mdx index 968224d0d..412d5a511 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index.mdx @@ -4,8 +4,8 @@ title: "reset-password-email" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordEmail">ScreenMembersOnResetPasswordEmail</a>}> -> **useScreen**: () => [`ScreenMembersOnResetPasswordEmail`](../../../../Types/interfaces/ScreenMembersOnResetPasswordEmail) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail">ScreenMembersOnResetPasswordEmail</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordEmail`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail) Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnResetPasswordEmail`](../../../../Types/interfaces/ScreenMembersOnResetPasswordEmail) +[`ScreenMembersOnResetPasswordEmail`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,36 +226,36 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:34]( **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useResetPasswordEmail' type={<a href="../../../../Types/interfaces/ResetPasswordEmailMembers">ResetPasswordEmailMembers</a>}> -> **useResetPasswordEmail**(): [`ResetPasswordEmailMembers`](../../../../Types/interfaces/ResetPasswordEmailMembers) +<ParamField body='useResetPasswordEmail' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers">ResetPasswordEmailMembers</a>}> +> **useResetPasswordEmail**(): [`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L48) **Returns** -[`ResetPasswordEmailMembers`](../../../../Types/interfaces/ResetPasswordEmailMembers) +[`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index.mdx index 7f972a93c..0f59e1660 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index.mdx @@ -4,8 +4,8 @@ title: "reset-password-error" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L17) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L18) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L19) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L20) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordError">ScreenMembersOnResetPasswordError</a>}> -> **useScreen**: () => [`ScreenMembersOnResetPasswordError`](../../../../Types/interfaces/ScreenMembersOnResetPasswordError) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError">ScreenMembersOnResetPasswordError</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordError`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError) Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L21) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnResetPasswordError`](../../../../Types/interfaces/ScreenMembersOnResetPasswordError) +[`ScreenMembersOnResetPasswordError`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L16) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L22) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L23) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L15) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -217,29 +217,29 @@ function UserProfile() { ## Functions -<ParamField body='useResetPasswordError' type={<a href="../../../../Types/interfaces/ResetPasswordErrorMembers">ResetPasswordErrorMembers</a>}> -> **useResetPasswordError**(): [`ResetPasswordErrorMembers`](../../../../Types/interfaces/ResetPasswordErrorMembers) +<ParamField body='useResetPasswordError' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers">ResetPasswordErrorMembers</a>}> +> **useResetPasswordError**(): [`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L38) **Returns** -[`ResetPasswordErrorMembers`](../../../../Types/interfaces/ResetPasswordErrorMembers) +[`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index.mdx index fe43d78ee..7092268e0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index.mdx @@ -4,8 +4,8 @@ title: "reset-password-mfa-email-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L28) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L29) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L30) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L31) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge">ScreenMembersOnResetPasswordMfaEmailChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaEmailChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge">ScreenMembersOnResetPasswordMfaEmailChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L32) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnResetPasswordMfaEmailChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge) +[`ScreenMembersOnResetPasswordMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L27) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L33) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L34) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L26) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-chal **payload** -[`ContinueOptions`](../../../../Types/interfaces/ContinueOptions) +[`ContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-chal **payload?** -[`ResendCodeOptions`](../../../../Types/interfaces/ResendCodeOptions) +[`ResendCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptions) **Returns** @@ -258,38 +258,38 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-chal **payload?** -[`TryAnotherMethodOptions`](../../../../Types/interfaces/TryAnotherMethodOptions) +[`TryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useResetPasswordMfaEmailChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaEmailChallengeMembers">ResetPasswordMfaEmailChallengeMembers</a>}> -> **useResetPasswordMfaEmailChallenge**(): [`ResetPasswordMfaEmailChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaEmailChallengeMembers) +<ParamField body='useResetPasswordMfaEmailChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers">ResetPasswordMfaEmailChallengeMembers</a>}> +> **useResetPasswordMfaEmailChallenge**(): [`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L58) **Returns** -[`ResetPasswordMfaEmailChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaEmailChallengeMembers) +[`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend">useResend</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index.mdx index 4fa9e5aa9..33e15df1a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index.mdx @@ -4,8 +4,8 @@ title: "reset-password-mfa-otp-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challe **payload** -[`ResetPasswordMfaOtpChallengeContinueOptions`](../../../../Types/interfaces/ResetPasswordMfaOtpChallengeContinueOptions) +[`ResetPasswordMfaOtpChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeContinueOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challe **payload?** -[`ResetPasswordMfaOtpChallengeTryAnotherMethodOptions`](../../../../Types/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions) +[`ResetPasswordMfaOtpChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useResetPasswordMfaOtpChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaOtpChallengeMembers">ResetPasswordMfaOtpChallengeMembers</a>}> -> **useResetPasswordMfaOtpChallenge**(): [`ResetPasswordMfaOtpChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaOtpChallengeMembers) +<ParamField body='useResetPasswordMfaOtpChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers">ResetPasswordMfaOtpChallengeMembers</a>}> +> **useResetPasswordMfaOtpChallenge**(): [`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L51) **Returns** -[`ResetPasswordMfaOtpChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaOtpChallengeMembers) +[`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index.mdx index 26d5c77ce..716c3a47c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index.mdx @@ -4,8 +4,8 @@ title: "reset-password-mfa-phone-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L27) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L28) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L29) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L30) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge">ScreenMembersOnResetPasswordMfaPhoneChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaPhoneChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge">ScreenMembersOnResetPasswordMfaPhoneChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L31) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnResetPasswordMfaPhoneChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge) +[`ScreenMembersOnResetPasswordMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L26) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L32) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L33) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L25) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-chal **payload** -[`ResetPasswordMfaPhoneChallengeContinueOptions`](../../../../Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions) +[`ResetPasswordMfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions) **Returns** @@ -242,36 +242,36 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-chal **payload** -[`ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions`](../../../../Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions) +[`ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useResetPasswordMfaPhoneChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaPhoneChallengeMembers">ResetPasswordMfaPhoneChallengeMembers</a>}> -> **useResetPasswordMfaPhoneChallenge**(): [`ResetPasswordMfaPhoneChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaPhoneChallengeMembers) +<ParamField body='useResetPasswordMfaPhoneChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers">ResetPasswordMfaPhoneChallengeMembers</a>}> +> **useResetPasswordMfaPhoneChallenge**(): [`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L53) **Returns** -[`ResetPasswordMfaPhoneChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaPhoneChallengeMembers) +[`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index.mdx index 18ac34ef6..3813f1739 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index.mdx @@ -4,8 +4,8 @@ title: "reset-password-mfa-push-challenge-push" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L26) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L27) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L28) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L29) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush">ScreenMembersOnResetPasswordMfaPushChallengePush</a>}> -> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaPushChallengePush`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush">ScreenMembersOnResetPasswordMfaPushChallengePush</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L30) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnResetPasswordMfaPushChallengePush`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush) +[`ScreenMembersOnResetPasswordMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L25) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L31) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L32) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L24) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-chall **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-chall **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -258,7 +258,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-chall **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -274,38 +274,38 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-chall **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useResetPasswordMfaPushChallengePush' type={<a href="../../../../Types/interfaces/ResetPasswordMfaPushChallengePushMembers">ResetPasswordMfaPushChallengePushMembers</a>}> -> **useResetPasswordMfaPushChallengePush**(): [`ResetPasswordMfaPushChallengePushMembers`](../../../../Types/interfaces/ResetPasswordMfaPushChallengePushMembers) +<ParamField body='useResetPasswordMfaPushChallengePush' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers">ResetPasswordMfaPushChallengePushMembers</a>}> +> **useResetPasswordMfaPushChallengePush**(): [`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L59) **Returns** -[`ResetPasswordMfaPushChallengePushMembers`](../../../../Types/interfaces/ResetPasswordMfaPushChallengePushMembers) +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useMfaPolling">useMfaPolling</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useMfaPolling">useMfaPolling</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index.mdx index f70f75b89..754cc20c2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index.mdx @@ -4,8 +4,8 @@ title: "reset-password-mfa-recovery-code-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L26) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L27) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L28) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L29) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembers">ScreenMembers</a>}> -> **useScreen**: () => [`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L30) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembers`](../../../../Types/interfaces/ScreenMembers) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L25) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L31) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L32) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L24) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -230,7 +230,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-c **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -246,36 +246,36 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-c **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useResetPasswordMfaRecoveryCodeChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers">ResetPasswordMfaRecoveryCodeChallengeMembers</a>}> -> **useResetPasswordMfaRecoveryCodeChallenge**(): [`ResetPasswordMfaRecoveryCodeChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers) +<ParamField body='useResetPasswordMfaRecoveryCodeChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers">ResetPasswordMfaRecoveryCodeChallengeMembers</a>}> +> **useResetPasswordMfaRecoveryCodeChallenge**(): [`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L54) **Returns** -[`ResetPasswordMfaRecoveryCodeChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers) +[`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index.mdx index c004e198b..e0b68b247 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index.mdx @@ -4,8 +4,8 @@ title: "reset-password-mfa-sms-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge">ScreenMembersOnResetPasswordMfaSmsChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaSmsChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge">ScreenMembersOnResetPasswordMfaSmsChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnResetPasswordMfaSmsChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge) +[`ScreenMembersOnResetPasswordMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challe **payload** -[`ResetPasswordMfaSmsChallengeOptions`](../../../../Types/interfaces/ResetPasswordMfaSmsChallengeOptions) +[`ResetPasswordMfaSmsChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challe **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -258,7 +258,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challe **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -274,38 +274,38 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challe **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useResetPasswordMfaSmsChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaSmsChallengeMembers">ResetPasswordMfaSmsChallengeMembers</a>}> -> **useResetPasswordMfaSmsChallenge**(): [`ResetPasswordMfaSmsChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaSmsChallengeMembers) +<ParamField body='useResetPasswordMfaSmsChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers">ResetPasswordMfaSmsChallengeMembers</a>}> +> **useResetPasswordMfaSmsChallenge**(): [`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:57](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L57) **Returns** -[`ResetPasswordMfaSmsChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaSmsChallengeMembers) +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend">useResend</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index.mdx index eeba1d255..cfa1339ce 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index.mdx @@ -4,8 +4,8 @@ title: "reset-password-mfa-voice-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L27) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L28) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L29) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L30) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge">ScreenMembersOnResetPasswordMfaVoiceChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaVoiceChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge">ScreenMembersOnResetPasswordMfaVoiceChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L31) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnResetPasswordMfaVoiceChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge) +[`ScreenMembersOnResetPasswordMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L26) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L32) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L33) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L25) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-chal **payload** -[`ResetPasswordMfaVoiceChallengeContinueOptions`](../../../../Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions) +[`ResetPasswordMfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-chal **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -258,7 +258,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-chal **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -274,38 +274,38 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-chal **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useResetPasswordMfaVoiceChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaVoiceChallengeMembers">ResetPasswordMfaVoiceChallengeMembers</a>}> -> **useResetPasswordMfaVoiceChallenge**(): [`ResetPasswordMfaVoiceChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaVoiceChallengeMembers) +<ParamField body='useResetPasswordMfaVoiceChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers">ResetPasswordMfaVoiceChallengeMembers</a>}> +> **useResetPasswordMfaVoiceChallenge**(): [`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L58) **Returns** -[`ResetPasswordMfaVoiceChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaVoiceChallengeMembers) +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useResend">useResend</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend">useResend</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index.mdx index d6e315cab..ba7ecc03f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index.mdx @@ -4,8 +4,8 @@ title: "reset-password-mfa-webauthn-platform-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L28) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L29) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L30) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L31) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge">ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge">ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L32) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge) +[`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L27) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L33) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L34) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L26) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-p **options?** -[`ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions) +[`ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-p **options** -[`ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions) +[`ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions) **Returns** @@ -258,36 +258,36 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-p **options?** -[`ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions) +[`ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useResetPasswordMfaWebAuthnPlatformChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers">ResetPasswordMfaWebAuthnPlatformChallengeMembers</a>}> -> **useResetPasswordMfaWebAuthnPlatformChallenge**(): [`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers) +<ParamField body='useResetPasswordMfaWebAuthnPlatformChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers">ResetPasswordMfaWebAuthnPlatformChallengeMembers</a>}> +> **useResetPasswordMfaWebAuthnPlatformChallenge**(): [`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L58) **Returns** -[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers) +[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index.mdx index 0c6811681..4a531195b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index.mdx @@ -4,8 +4,8 @@ title: "reset-password-mfa-webauthn-roaming-challenge" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L28) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L29) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L30) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L31) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge">ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge</a>}> -> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge">ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L32) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](../../../../Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge) +[`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L27) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L33) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L34) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L26) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-r **options** -[`ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions) +[`ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions) **Returns** @@ -242,21 +242,21 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-r **options?** -[`ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions) +[`ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useResetPasswordMfaWebAuthnRoamingChallenge' type={<a href="../../../../Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers">ResetPasswordMfaWebAuthnRoamingChallengeMembers</a>}> -> **useResetPasswordMfaWebAuthnRoamingChallenge**(): [`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers) +<ParamField body='useResetPasswordMfaWebAuthnRoamingChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers">ResetPasswordMfaWebAuthnRoamingChallengeMembers</a>}> +> **useResetPasswordMfaWebAuthnRoamingChallenge**(): [`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:57](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L57) **Returns** -[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers) +[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers) </ParamField> <ParamField body='useSecurityKey' type={<span>void | Promise<void></span>}> @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-r **options?** -[`ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions`](../../../../Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions) +[`ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions) **Returns** @@ -278,16 +278,16 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-r ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index.mdx index ab6401304..6f845ac17 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index.mdx @@ -4,8 +4,8 @@ title: "reset-password-request" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordRequest">ScreenMembersOnResetPasswordRequest</a>}> -> **useScreen**: () => [`ScreenMembersOnResetPasswordRequest`](../../../../Types/interfaces/ScreenMembersOnResetPasswordRequest) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest">ScreenMembersOnResetPasswordRequest</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest) Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnResetPasswordRequest`](../../../../Types/interfaces/ScreenMembersOnResetPasswordRequest) +[`ScreenMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnResetPasswordRequest">TransactionMembersOnResetPasswordRequest</a>}> -> **useTransaction**: () => [`TransactionMembersOnResetPasswordRequest`](../../../../Types/interfaces/TransactionMembersOnResetPasswordRequest) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest">TransactionMembersOnResetPasswordRequest</a>}> +> **useTransaction**: () => [`TransactionMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest) Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembersOnResetPasswordRequest`](../../../../Types/interfaces/TransactionMembersOnResetPasswordRequest) +[`TransactionMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:37 **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -242,38 +242,38 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:35 **payload** -[`ResetPasswordRequestOptions`](../../../../Types/interfaces/ResetPasswordRequestOptions) +[`ResetPasswordRequestOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useResetPasswordRequest' type={<a href="../../../../Types/interfaces/ResetPasswordRequestMembers">ResetPasswordRequestMembers</a>}> -> **useResetPasswordRequest**(): [`ResetPasswordRequestMembers`](../../../../Types/interfaces/ResetPasswordRequestMembers) +<ParamField body='useResetPasswordRequest' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers">ResetPasswordRequestMembers</a>}> +> **useResetPasswordRequest**(): [`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L54) **Returns** -[`ResetPasswordRequestMembers`](../../../../Types/interfaces/ResetPasswordRequestMembers) +[`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useLoginIdentifiers">useLoginIdentifiers</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useLoginIdentifiers">useLoginIdentifiers</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index.mdx index c836b2867..e2b2a615d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index.mdx @@ -4,8 +4,8 @@ title: "reset-password-success" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L17) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L18) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L19) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L20) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPasswordSuccess">ScreenMembersOnResetPasswordSuccess</a>}> -> **useScreen**: () => [`ScreenMembersOnResetPasswordSuccess`](../../../../Types/interfaces/ScreenMembersOnResetPasswordSuccess) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess">ScreenMembersOnResetPasswordSuccess</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPasswordSuccess`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess) Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L21) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnResetPasswordSuccess`](../../../../Types/interfaces/ScreenMembersOnResetPasswordSuccess) +[`ScreenMembersOnResetPasswordSuccess`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L16) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembers">TransactionMembers</a>}> -> **useTransaction**: () => [`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L22) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembers`](../../../../Types/interfaces/TransactionMembers) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L23) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L15) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -217,29 +217,29 @@ function UserProfile() { ## Functions -<ParamField body='useResetPasswordSuccess' type={<a href="../../../../Types/interfaces/ResetPasswordSuccessMembers">ResetPasswordSuccessMembers</a>}> -> **useResetPasswordSuccess**(): [`ResetPasswordSuccessMembers`](../../../../Types/interfaces/ResetPasswordSuccessMembers) +<ParamField body='useResetPasswordSuccess' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers">ResetPasswordSuccessMembers</a>}> +> **useResetPasswordSuccess**(): [`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L38) **Returns** -[`ResetPasswordSuccessMembers`](../../../../Types/interfaces/ResetPasswordSuccessMembers) +[`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index.mdx index 4206d928f..123a118bc 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index.mdx @@ -4,8 +4,8 @@ title: "reset-password" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L24) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L25) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L26) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L27) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnResetPassword">ScreenMembersOnResetPassword</a>}> -> **useScreen**: () => [`ScreenMembersOnResetPassword`](../../../../Types/interfaces/ScreenMembersOnResetPassword) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword">ScreenMembersOnResetPassword</a>}> +> **useScreen**: () => [`ScreenMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword) Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L28) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnResetPassword`](../../../../Types/interfaces/ScreenMembersOnResetPassword) +[`ScreenMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L23) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnResetPassword">TransactionMembersOnResetPassword</a>}> -> **useTransaction**: () => [`TransactionMembersOnResetPassword`](../../../../Types/interfaces/TransactionMembersOnResetPassword) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword">TransactionMembersOnResetPassword</a>}> +> **useTransaction**: () => [`TransactionMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword) Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L29) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembersOnResetPassword`](../../../../Types/interfaces/TransactionMembersOnResetPassword) +[`TransactionMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L30) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L22) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,38 +226,38 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:34](https: **payload** -[`ResetPasswordOptions`](../../../../Types/interfaces/ResetPasswordOptions) +[`ResetPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useResetPassword' type={<a href="../../../../Types/interfaces/ResetPasswordMembers">ResetPasswordMembers</a>}> -> **useResetPassword**(): [`ResetPasswordMembers`](../../../../Types/interfaces/ResetPasswordMembers) +<ParamField body='useResetPassword' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers">ResetPasswordMembers</a>}> +> **useResetPassword**(): [`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers) Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L52) **Returns** -[`ResetPasswordMembers`](../../../../Types/interfaces/ResetPasswordMembers) +[`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/usePasswordValidation">usePasswordValidation</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/usePasswordValidation">usePasswordValidation</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index.mdx index 7d911d89e..4207fd299 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index.mdx @@ -4,8 +4,8 @@ title: "signup-id" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L26) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L27) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L28) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L29) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnSignupId">ScreenMembersOnSignupId</a>}> -> **useScreen**: () => [`ScreenMembersOnSignupId`](../../../../Types/interfaces/ScreenMembersOnSignupId) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId">ScreenMembersOnSignupId</a>}> +> **useScreen**: () => [`ScreenMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId) Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L30) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnSignupId`](../../../../Types/interfaces/ScreenMembersOnSignupId) +[`ScreenMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L25) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a>}> -> **useTransaction**: () => [`TransactionMembersOnSignupId`](../../../../Types/interfaces/TransactionMembersOnSignupId) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a>}> +> **useTransaction**: () => [`TransactionMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId) Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L31) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembersOnSignupId`](../../../../Types/interfaces/TransactionMembersOnSignupId) +[`TransactionMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L32) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L24) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:37](https://git **payload** -[`FederatedSignupOptions`](../../../../Types/interfaces/FederatedSignupOptions) +[`FederatedSignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:39](https://git **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -258,40 +258,40 @@ Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:36](https://git **payload** -[`SignupOptions`](../../../../Types/interfaces/SignupOptions) +[`SignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useSignupId' type={<a href="../../../../Types/interfaces/SignupIdMembers">SignupIdMembers</a>}> -> **useSignupId**(): [`SignupIdMembers`](../../../../Types/interfaces/SignupIdMembers) +<ParamField body='useSignupId' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers">SignupIdMembers</a>}> +> **useSignupId**(): [`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:60](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L60) **Returns** -[`SignupIdMembers`](../../../../Types/interfaces/SignupIdMembers) +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/useSignupIdentifiers">useSignupIdentifiers</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useSignupIdentifiers">useSignupIdentifiers</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useUsernameValidation">useUsernameValidation</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useUsernameValidation">useUsernameValidation</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index.mdx index c856746bb..3c2c446b7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index.mdx @@ -4,8 +4,8 @@ title: "signup-password" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L25) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L26) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L27) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L28) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnSignupPassword">ScreenMembersOnSignupPassword</a>}> -> **useScreen**: () => [`ScreenMembersOnSignupPassword`](../../../../Types/interfaces/ScreenMembersOnSignupPassword) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword">ScreenMembersOnSignupPassword</a>}> +> **useScreen**: () => [`ScreenMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword) Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L29) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnSignupPassword`](../../../../Types/interfaces/ScreenMembersOnSignupPassword) +[`ScreenMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L24) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnSignupPassword">TransactionMembersOnSignupPassword</a>}> -> **useTransaction**: () => [`TransactionMembersOnSignupPassword`](../../../../Types/interfaces/TransactionMembersOnSignupPassword) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword">TransactionMembersOnSignupPassword</a>}> +> **useTransaction**: () => [`TransactionMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword) Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L30) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembersOnSignupPassword`](../../../../Types/interfaces/TransactionMembersOnSignupPassword) +[`TransactionMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L31) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L23) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:36](https **payload** -[`FederatedSignupPasswordPayloadOptions`](../../../../Types/interfaces/FederatedSignupPasswordPayloadOptions) +[`FederatedSignupPasswordPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPasswordPayloadOptions) **Returns** @@ -242,38 +242,38 @@ Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:35](https **payload** -[`SignupPasswordOptions`](../../../../Types/interfaces/SignupPasswordOptions) +[`SignupPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useSignupPassword' type={<a href="../../../../Types/interfaces/SignupPasswordMembers">SignupPasswordMembers</a>}> -> **useSignupPassword**(): [`SignupPasswordMembers`](../../../../Types/interfaces/SignupPasswordMembers) +<ParamField body='useSignupPassword' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers">SignupPasswordMembers</a>}> +> **useSignupPassword**(): [`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers) Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L54) **Returns** -[`SignupPasswordMembers`](../../../../Types/interfaces/SignupPasswordMembers) +[`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/usePasswordValidation">usePasswordValidation</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/usePasswordValidation">usePasswordValidation</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index.mdx index e13ae434f..563bfb13a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index.mdx @@ -4,8 +4,8 @@ title: "signup" ## Variables -<ParamField body='useBranding' type={<a href="../../../../Types/interfaces/BrandingMembers">BrandingMembers</a>}> -> **useBranding**: () => [`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L26) @@ -13,7 +13,7 @@ Hook to access branding and theme configuration. **Returns** -[`BrandingMembers`](../../../../Types/interfaces/BrandingMembers) +[`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Branding object containing colors, logos, fonts, and visual customization settings @@ -27,8 +27,8 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="../../../../Types/interfaces/ClientMembers">ClientMembers</a>}> -> **useClient**: () => [`ClientMembers`](../../../../Types/interfaces/ClientMembers) +<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L27) @@ -36,7 +36,7 @@ Hook to access Auth0 application (client) configuration. **Returns** -[`ClientMembers`](../../../../Types/interfaces/ClientMembers) +[`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Client object containing application settings, callbacks, and client-specific data @@ -50,8 +50,8 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="../../../../Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> -> **useOrganization**: () => [`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L28) @@ -59,7 +59,7 @@ Hook to access organization context and settings. **Returns** -[`OrganizationMembers`](../../../../Types/interfaces/OrganizationMembers) +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Organization object containing org-specific data, metadata, and configuration @@ -76,8 +76,8 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="../../../../Types/interfaces/PromptMembers">PromptMembers</a>}> -> **usePrompt**: () => [`PromptMembers`](../../../../Types/interfaces/PromptMembers) +<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L29) @@ -85,7 +85,7 @@ Hook to access prompt configuration and flow settings. **Returns** -[`PromptMembers`](../../../../Types/interfaces/PromptMembers) +[`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Prompt object containing flow configuration, screen settings, and prompt-specific data @@ -99,8 +99,8 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="../../../../Types/interfaces/ScreenMembersOnSignup">ScreenMembersOnSignup</a>}> -> **useScreen**: () => [`ScreenMembersOnSignup`](../../../../Types/interfaces/ScreenMembersOnSignup) +<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup">ScreenMembersOnSignup</a>}> +> **useScreen**: () => [`ScreenMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup) Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L30) @@ -108,7 +108,7 @@ Hook to access current screen information and metadata. **Returns** -[`ScreenMembersOnSignup`](../../../../Types/interfaces/ScreenMembersOnSignup) +[`ScreenMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup) Screen object containing current screen name, configuration, and screen-specific data @@ -122,8 +122,8 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="../../../../Types/interfaces/TenantMembers">TenantMembers</a>}> -> **useTenant**: () => [`TenantMembers`](../../../../Types/interfaces/TenantMembers) +<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L25) @@ -131,7 +131,7 @@ Hook to access tenant configuration and settings. **Returns** -[`TenantMembers`](../../../../Types/interfaces/TenantMembers) +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Tenant object containing domain, region, and tenant-specific configuration @@ -145,8 +145,8 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="../../../../Types/interfaces/TransactionMembersOnSignup">TransactionMembersOnSignup</a>}> -> **useTransaction**: () => [`TransactionMembersOnSignup`](../../../../Types/interfaces/TransactionMembersOnSignup) +<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup">TransactionMembersOnSignup</a>}> +> **useTransaction**: () => [`TransactionMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup) Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L31) @@ -154,7 +154,7 @@ Hook to access transaction state and authentication flow data. **Returns** -[`TransactionMembersOnSignup`](../../../../Types/interfaces/TransactionMembersOnSignup) +[`TransactionMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup) Transaction object containing flow state, session data, and transaction-specific information @@ -168,8 +168,8 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="../../../../Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> -> **useUntrustedData**: () => [`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L32) @@ -177,7 +177,7 @@ Hook to access untrusted data from URL parameters and form submissions. **Returns** -[`UntrustedDataMembers`](../../../../Types/interfaces/UntrustedDataMembers) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Object containing untrusted user input that should be validated before use @@ -191,8 +191,8 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="../../../../Types/interfaces/UserMembers">UserMembers</a>}> -> **useUser**: () => [`UserMembers`](../../../../Types/interfaces/UserMembers) +<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L24) @@ -200,7 +200,7 @@ Hook to access user information and profile data. **Returns** -[`UserMembers`](../../../../Types/interfaces/UserMembers) +[`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) User object containing profile information, attributes, and user-specific data @@ -226,7 +226,7 @@ Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:37](https://github **payload** -[`FederatedSignupPayloadOptions`](../../../../Types/interfaces/FederatedSignupPayloadOptions) +[`FederatedSignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPayloadOptions) **Returns** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:39](https://github **payload?** -[`CustomOptions`](../../../../Types/interfaces/CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -258,42 +258,42 @@ Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:36](https://github **payload** -[`SignupPayloadOptions`](../../../../Types/interfaces/SignupPayloadOptions) +[`SignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPayloadOptions) **Returns** `void` \| `Promise`\<`void`\> </ParamField> -<ParamField body='useSignup' type={<a href="../../../../Types/interfaces/SignupMembers">SignupMembers</a>}> -> **useSignup**(): [`SignupMembers`](../../../../Types/interfaces/SignupMembers) +<ParamField body='useSignup' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers">SignupMembers</a>}> +> **useSignup**(): [`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers) Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:63](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L63) **Returns** -[`SignupMembers`](../../../../Types/interfaces/SignupMembers) +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers) </ParamField> ## References -<ParamField body={<a href="../../../Hooks/functions/usePasswordValidation">usePasswordValidation</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/usePasswordValidation">usePasswordValidation</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useSignupIdentifiers">useSignupIdentifiers</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useSignupIdentifiers">useSignupIdentifiers</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useUsernameValidation">useUsernameValidation</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useUsernameValidation">useUsernameValidation</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -<ParamField body={<a href="../../../Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions">UseErrorOptions</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult">UseErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>} type='Types'/> -<ParamField body={<a href="../../../Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>} type='Types'/> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks.mdx index 054df4fbd..2e7ad3ad6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks.mdx @@ -11,7 +11,7 @@ These hooks provide access to various aspects of the authentication flow and ten ### T -`T` *extends* [`BaseMembers`](../interfaces/BaseMembers) +`T` *extends* [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ### Constructor diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/index.mdx index aebf2d784..7e02e74f7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/index.mdx @@ -4,357 +4,357 @@ title: "Types" ## Classes -- [ContextHooks](./classes/ContextHooks): Factory class that creates context hooks for accessing Auth0 Universal Login data. These hooks provide access to various aspects of the authentication flow and tenant configuration. +- [ContextHooks](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks): Factory class that creates context hooks for accessing Auth0 Universal Login data. These hooks provide access to various aspects of the authentication flow and tenant configuration. ## Interfaces -- [CustomOptions](./interfaces/CustomOptions) -- [WebAuthnErrorDetails](./interfaces/WebAuthnErrorDetails): Details of a WebAuthn browser error. -- [CurrentScreenOptions](./interfaces/CurrentScreenOptions): CurrentScreenOptions details. -- [FlattenedTheme](./interfaces/FlattenedTheme) -- [BaseMembers](./interfaces/BaseMembers) -- [BrandingSettings](./interfaces/BrandingSettings) -- [BrandingThemes](./interfaces/BrandingThemes) -- [BrandingMembers](./interfaces/BrandingMembers) -- [ClientMembers](./interfaces/ClientMembers) -- [Branding](./interfaces/Branding) -- [OrganizationMembers](./interfaces/OrganizationMembers) -- [PromptMembers](./interfaces/PromptMembers) -- [CaptchaContext](./interfaces/CaptchaContext) -- [AllowCredential](./interfaces/AllowCredential) -- [PasskeyCreate](./interfaces/PasskeyCreate) -- [PhonePrefix](./interfaces/PhonePrefix) -- [Scope](./interfaces/Scope) -- [AuthorizationDetail](./interfaces/AuthorizationDetail) -- [ScreenMembers](./interfaces/ScreenMembers) -- [TenantMembers](./interfaces/TenantMembers) -- [Connection](./interfaces/Connection) -- [UsernamePolicy](./interfaces/UsernamePolicy) -- [PasswordPolicy](./interfaces/PasswordPolicy) -- [EnterpriseConnection](./interfaces/EnterpriseConnection) -- [PasswordComplexityRule](./interfaces/PasswordComplexityRule) -- [Error](./interfaces/Error) -- [TransactionMembers](./interfaces/TransactionMembers) -- [UntrustedDataMembers](./interfaces/UntrustedDataMembers) -- [EnrolledEmail](./interfaces/EnrolledEmail) -- [EnrolledPhoneNumber](./interfaces/EnrolledPhoneNumber) -- [EnrolledDevice](./interfaces/EnrolledDevice) -- [Organizations](./interfaces/Organizations) -- [UserMembers](./interfaces/UserMembers) -- [ScreenMembersOnAcceptInvitation](./interfaces/ScreenMembersOnAcceptInvitation) -- [AcceptInvitationMembers](./interfaces/AcceptInvitationMembers) -- [ScreenMembersOnConsent](./interfaces/ScreenMembersOnConsent): ScreenMembersOnConsent -- [ConsentMembers](./interfaces/ConsentMembers): ConsentMembers -- [ScreenMembersOnCustomizedConsent](./interfaces/ScreenMembersOnCustomizedConsent): ScreenMembersOnCustomizedConsent -- [CustomizedConsentMembers](./interfaces/CustomizedConsentMembers): CustomizedConsentMembers -- [DeviceCodeActivationAllowedMembers](./interfaces/DeviceCodeActivationAllowedMembers): Interface describing the members of the Device Code Activation Allowed screen. -- [DeviceCodeActivationDeniedMembers](./interfaces/DeviceCodeActivationDeniedMembers): Interface describing the members of the Device Code Activation Denied screen. -- [DeviceCodeActivationContinueOptions](./interfaces/DeviceCodeActivationContinueOptions): payload for continuing device code activation. -- [DeviceCodeActivationMembers](./interfaces/DeviceCodeActivationMembers): Interface describing the members of the Device Code Activation screen. -- [ScreenMembersOnDeviceCodeConfirmation](./interfaces/ScreenMembersOnDeviceCodeConfirmation): Interface describing the data available on the Device Code Confirmation screen. -- [DeviceCodeConfirmationMembers](./interfaces/DeviceCodeConfirmationMembers): Interface describing the members of the Device Code Confirmation screen. -- [EmailChallengeOptions](./interfaces/EmailChallengeOptions) -- [ScreenMembersOnEmailIdentifierChallenge](./interfaces/ScreenMembersOnEmailIdentifierChallenge) -- [EmailIdentifierChallengeMembers](./interfaces/EmailIdentifierChallengeMembers) -- [ScreenMembersOnEmailOTPChallenge](./interfaces/ScreenMembersOnEmailOTPChallenge): Represents the members of the Email OTP Challenge screen. Extends the base ScreenMembers interface. -- [OtpCodeOptions](./interfaces/OtpCodeOptions) -- [EmailOTPChallengeMembers](./interfaces/EmailOTPChallengeMembers): Represents the Email OTP Challenge screen interface. -- [ScreenMembersOnEmailVerificationResult](./interfaces/ScreenMembersOnEmailVerificationResult): ScreenMembersOnEmailVerificationResult -- [EmailVerificationResultMembers](./interfaces/EmailVerificationResultMembers): EmailVerificationResultMembers -- [SubmitCaptchaOptions](./interfaces/SubmitCaptchaOptions) -- [InterstitialCaptchaMembers](./interfaces/InterstitialCaptchaMembers) -- [ContinueWithCodeOptionPayload](./interfaces/ContinueWithCodeOptionPayload): ContinueWithCodeOptions description Options for the `continueWithCode` method on the Login Email Verification screen. This operation is used when the user submits the verification code they received via email to proceed with the authentication flow. -- [ResendCodeOptionsPayload](./interfaces/ResendCodeOptionsPayload): ResendCodeOptions description Options for the `resendCode` method on the Login Email Verification screen. This operation is used when the user requests a new verification code to be sent to their email, for instance, if they did not receive the initial code or if it has expired. -- [LoginEmailVerificationMembers](./interfaces/LoginEmailVerificationMembers): LoginEmailVerificationMembers description Defines the members (properties and methods) available for interacting with the Login Email Verification screen. This screen is a crucial part of email verification processes, typically during login, where a user must prove ownership of an email address by providing a one-time code. The SDK facilitates submitting this code or requesting a new one. -- [ScreenMembersOnLoginId](./interfaces/ScreenMembersOnLoginId) -- [TransactionMembersOnLoginId](./interfaces/TransactionMembersOnLoginId) -- [LoginOptions](./interfaces/LoginOptions) -- [FederatedLoginOptions](./interfaces/FederatedLoginOptions) -- [LoginIdMembers](./interfaces/LoginIdMembers) -- [ScreenMembersOnLoginPassword](./interfaces/ScreenMembersOnLoginPassword) -- [TransactionMembersOnLoginPassword](./interfaces/TransactionMembersOnLoginPassword) -- [LoginPasswordOptions](./interfaces/LoginPasswordOptions) -- [FederatedLoginPasswordOptions](./interfaces/FederatedLoginPasswordOptions) -- [LoginPasswordMembers](./interfaces/LoginPasswordMembers) -- [ScreenMembersOnLoginPasswordlessEmailCode](./interfaces/ScreenMembersOnLoginPasswordlessEmailCode) -- [TransactionMembersOnLoginPasswordlessEmailCode](./interfaces/TransactionMembersOnLoginPasswordlessEmailCode) -- [SubmitCodeOptions](./interfaces/SubmitCodeOptions) -- [LoginPasswordlessEmailCodeMembers](./interfaces/LoginPasswordlessEmailCodeMembers) -- [ScreenMembersOnLoginPasswordlessSmsOtp](./interfaces/ScreenMembersOnLoginPasswordlessSmsOtp) -- [TransactionMembersOnLoginPasswordlessSmsOtp](./interfaces/TransactionMembersOnLoginPasswordlessSmsOtp) -- [SubmitOTPOptions](./interfaces/SubmitOTPOptions) -- [LoginPasswordlessSmsOtpMembers](./interfaces/LoginPasswordlessSmsOtpMembers) -- [ScreenMembersOnLogin](./interfaces/ScreenMembersOnLogin): Extended screen members interface for the login screen -- [TransactionMembersOnLogin](./interfaces/TransactionMembersOnLogin): Extended transaction members interface for the login screen -- [LoginPayloadOptions](./interfaces/LoginPayloadOptions): Options for performing login operations -- [FederatedLoginPayloadOptions](./interfaces/FederatedLoginPayloadOptions): Options for performing social login operations -- [LoginMembers](./interfaces/LoginMembers): Login screen members interface extending base members -- [LogoutAbortedMembers](./interfaces/LogoutAbortedMembers): Interface defining the available methods and properties for the logout-aborted screen -- [LogoutCompleteMembers](./interfaces/LogoutCompleteMembers): Interface defining the available methods and properties for the logout-complete screen -- [ConfirmLogoutOptions](./interfaces/ConfirmLogoutOptions): Options for confirming logout -- [LogoutMembers](./interfaces/LogoutMembers): Interface defining the available methods and properties for the logout screen -- [MfaEnrollOptions](./interfaces/MfaEnrollOptions): Options for continuing with factor enrollment -- [MfaBeginEnrollOptionsMembers](./interfaces/MfaBeginEnrollOptionsMembers): MFA Begin Enroll Options screen members interface -- [ScreenMembersOnMfaCountryCodes](./interfaces/ScreenMembersOnMfaCountryCodes): Interface for screen data specific to mfa-country-codes screen -- [SelectCountryCodeOptions](./interfaces/SelectCountryCodeOptions): Options for selecting a country code -- [MfaCountryCodesMembers](./interfaces/MfaCountryCodesMembers): Interface defining the available methods and properties for the mfa-country-codes screen -- [MfaDetectBrowserCapabilitiesMembers](./interfaces/MfaDetectBrowserCapabilitiesMembers): Interface defining the available methods and properties for the mfa-detect-browser-capabilities screen -- [ScreenMembersOnMfaEmailChallenge](./interfaces/ScreenMembersOnMfaEmailChallenge): Interface for the screen data specific to mfa-email-challenge screen -- [UntrustedDataMembersOnMfaEmailChallenge](./interfaces/UntrustedDataMembersOnMfaEmailChallenge): Interface for untrusted data specific to mfa-email-challenge screen -- [ContinuePayloadOptions](./interfaces/ContinuePayloadOptions): Options for continuing with the email challenge -- [ResendCodePayloadOptions](./interfaces/ResendCodePayloadOptions): Options for resending the email code -- [TryAnotherMethodPayloadOptions](./interfaces/TryAnotherMethodPayloadOptions): Options for trying another method -- [MfaEmailChallengeMembers](./interfaces/MfaEmailChallengeMembers): Interface defining the available methods and properties for the mfa-email-challenge screen -- [ScreenMembersOnMfaEmailList](./interfaces/ScreenMembersOnMfaEmailList): Interface for the screen data specific to mfa-email-list screen -- [SelectMfaEmailOptions](./interfaces/SelectMfaEmailOptions): Options for selecting an email address -- [MfaEmailListMembers](./interfaces/MfaEmailListMembers): Interface defining the available methods and properties for the mfa-email-list screen -- [ScreenMembersOnMfaEnrollResult](./interfaces/ScreenMembersOnMfaEnrollResult): ScreenMembersOnMfaEnrollResult -- [MfaEnrollResultMembers](./interfaces/MfaEnrollResultMembers): MfaEnrollResultMembers -- [ScreenMembersOnMfaLoginOptions](./interfaces/ScreenMembersOnMfaLoginOptions): Interface for the screen data specific to mfa-login-options screen -- [LoginEnrollOptions](./interfaces/LoginEnrollOptions): Options for continuing with a selected MFA factor -- [MfaLoginOptionsMembers](./interfaces/MfaLoginOptionsMembers): Interface defining the available methods and properties for the mfa-login-options screen -- [ScreenMembersOnMfaOtpChallenge](./interfaces/ScreenMembersOnMfaOtpChallenge): Interface for the screen data specific to mfa-otp-challenge screen -- [UntrustedDataMembersOnMfaOtpChallenge](./interfaces/UntrustedDataMembersOnMfaOtpChallenge): Interface for untrusted data specific to mfa-otp-challenge screen -- [ContinueOTPOptions](./interfaces/ContinueOTPOptions): Options for continuing with the OTP challenge -- [TryAnotherMethodMfaOtpChallengeOptions](./interfaces/TryAnotherMethodMfaOtpChallengeOptions): Options for trying another method -- [MfaOtpChallengeMembers](./interfaces/MfaOtpChallengeMembers): Interface defining the available methods and properties for the mfa-otp-challenge screen -- [MfaOtpContinueOptions](./interfaces/MfaOtpContinueOptions): Options for continuing with the MFA OTP enrollment code. -- [MfaOtpTryAnotherMethodOptions](./interfaces/MfaOtpTryAnotherMethodOptions): Options for trying another MFA method. -- [ScreenMembersOnMfaOtpEnrollmentCode](./interfaces/ScreenMembersOnMfaOtpEnrollmentCode): Interface for the screen data specific to the mfa-otp-enrollment-code screen. -- [MfaOtpEnrollmentCodeMembers](./interfaces/MfaOtpEnrollmentCodeMembers): Interface defining the available methods and properties for the mfa-otp-enrollment-code screen. -- [ScreenMembersOnMfaOtpEnrollmentQr](./interfaces/ScreenMembersOnMfaOtpEnrollmentQr): Interface for the screen data specific to mfa-otp-enrollment-qr screen -- [MfaOtpEnrollmentQrContinueOptions](./interfaces/MfaOtpEnrollmentQrContinueOptions): Interface for the payload of the continue method -- [MfaOtpEnrollmentQrMembers](./interfaces/MfaOtpEnrollmentQrMembers): Interface defining the available methods and properties for the mfa-otp-enrollment-qr screen -- [ScreenMembersOnMfaPhoneChallenge](./interfaces/ScreenMembersOnMfaPhoneChallenge): ScreenMembersOnMfaPhoneChallenge -- [MfaPhoneChallengeContinueOptions](./interfaces/MfaPhoneChallengeContinueOptions): ContinueOptions Defines the options required to continue the MFA phone challenge process. This typically involves selecting the method (SMS or Voice) to receive the verification code. -- [MfaPhoneChallengePickPhoneOptions](./interfaces/MfaPhoneChallengePickPhoneOptions): PickPhoneOptions Defines the options for the 'pick-phone' action. Although the interface only shows one phone number, this action might be used in scenarios where the server needs to redirect to a phone selection screen. -- [MfaPhoneChallengePickAuthenticatorOptions](./interfaces/MfaPhoneChallengePickAuthenticatorOptions): PickAuthenticatorOptions Defines the options for the 'pick-authenticator' action. This allows the user to choose a different MFA method if available. -- [MfaPhoneChallengeMembers](./interfaces/MfaPhoneChallengeMembers): MfaPhoneChallengeMembers -- [MfaPhoneEnrollmentContinueOptions](./interfaces/MfaPhoneEnrollmentContinueOptions): Options for continuing with the MFA phone enrollment. -- [MfaPhoneEnrollmentMembers](./interfaces/MfaPhoneEnrollmentMembers) -- [ScreenMembersOnMfaPushChallengePush](./interfaces/ScreenMembersOnMfaPushChallengePush): Interface for the screen data specific to mfa-push-challenge-push screen -- [UntrustedDataMembersOnMfaPushChallengePush](./interfaces/UntrustedDataMembersOnMfaPushChallengePush): Interface for untrusted data specific to mfa-push-challenge-push screen -- [WithRememberOptions](./interfaces/WithRememberOptions) -- [MfaPushChallengePushMembers](./interfaces/MfaPushChallengePushMembers): Interface defining the available methods and properties for the mfa-push-challenge-push screen -- [ScreenMembersOnMfaPushEnrollmentQr](./interfaces/ScreenMembersOnMfaPushEnrollmentQr): Interface for the screen data specific to mfa-push-enrollment-qr screen -- [MfaPushEnrollmentQrMembers](./interfaces/MfaPushEnrollmentQrMembers): Interface defining the available methods and properties for the mfa-push-enrollment-qr screen -- [SelectMfaPushDeviceOptions](./interfaces/SelectMfaPushDeviceOptions): Options for selecting an MFA push device. -- [MfaPushListMembers](./interfaces/MfaPushListMembers): Interface defining the available methods and properties for the mfa-push-list screen -- [ScreenMembersOnMfaPushWelcome](./interfaces/ScreenMembersOnMfaPushWelcome) -- [MfaPushWelcomeMembers](./interfaces/MfaPushWelcomeMembers) -- [ScreenMembersOnMfaRecoveryCodeChallengeNewCode](./interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode): ScreenMembersOnMfaRecoveryCodeChallengeNewCode -- [MfaRecoveryCodeChallengeNewCodeContinueOptions](./interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions): ContinueOptions -- [MfaRecoveryCodeChallengeNewCodeMembers](./interfaces/MfaRecoveryCodeChallengeNewCodeMembers): MfaRecoveryCodeChallengeNewCodeMembers -- [MfaRecoveryCodeChallengeContinueOptions](./interfaces/MfaRecoveryCodeChallengeContinueOptions): Options for continuing with the MFA Recovery Code Challenge. -- [MfaRecoveryCodeChallengeMembers](./interfaces/MfaRecoveryCodeChallengeMembers): Interface describing the members of the Mfa Recovery Code Challenge screen. -- [ScreenMembersOnMfaRecoveryCodeEnrollment](./interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment): Interface describing the data available on the Mfa Recovery Code Enrollment screen. -- [MfaRecoveryCodeEnrollmentContinueOptions](./interfaces/MfaRecoveryCodeEnrollmentContinueOptions) -- [MfaRecoveryCodeEnrollmentMembers](./interfaces/MfaRecoveryCodeEnrollmentMembers): Interface describing the members of the Mfa Recovery Code Enrollment screen. -- [MfaSmsChallengeOptions](./interfaces/MfaSmsChallengeOptions) -- [ScreenMembersOnMfaSmsChallenge](./interfaces/ScreenMembersOnMfaSmsChallenge): Interface for the screen data specific to mfa-sms-challenge screen -- [MfaSmsChallengeMembers](./interfaces/MfaSmsChallengeMembers) -- [UntrustedDataMembersOnMfaSmsChallenge](./interfaces/UntrustedDataMembersOnMfaSmsChallenge): Interface for untrusted data specific to mfa-sms-challenge screen -- [MfaSmsEnrollmentOptions](./interfaces/MfaSmsEnrollmentOptions) -- [ScreenMembersOnMfaSmsEnrollment](./interfaces/ScreenMembersOnMfaSmsEnrollment) -- [MfaSmsEnrollmentMembers](./interfaces/MfaSmsEnrollmentMembers) -- [MfaSmsListOptions](./interfaces/MfaSmsListOptions): MfaSmsListOptions Options for performing actions on the mfa-sms-list screen. -- [MfaSmsListMembers](./interfaces/MfaSmsListMembers): MfaSmsListMembers Interface defining the members and methods for the MfaSmsList class. -- [MfaVoiceChallengeContinueOptions](./interfaces/MfaVoiceChallengeContinueOptions): Options for submitting the voice challenge code. -- [ScreenMembersOnMfaVoiceChallenge](./interfaces/ScreenMembersOnMfaVoiceChallenge): Extended screen members interface for the MFA Voice Challenge screen. -- [MfaVoiceChallengeMembers](./interfaces/MfaVoiceChallengeMembers): Interface defining all members and operations available on the MFA Voice Challenge screen. -- [UntrustedDataMembersOnMfaVoiceChallenge](./interfaces/UntrustedDataMembersOnMfaVoiceChallenge): Interface for untrusted data specific to mfa-voice-challenge screen -- [MfaVoiceEnrollmentContinueOptions](./interfaces/MfaVoiceEnrollmentContinueOptions): Payload for continuing the MFA Voice Enrollment flow. -- [MfaVoiceEnrollmentMembers](./interfaces/MfaVoiceEnrollmentMembers): Interface describing the members of the Mfa Voice Enrollment screen. -- [ScreenMembersOnMfaWebAuthnChangeKeyNickname](./interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname): ScreenMembersOnMfaWebAuthnChangeKeyNickname -- [MfaWebAuthnChangeKeyNicknameContinueOptions](./interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions): ContinueOptions -- [MfaWebAuthnChangeKeyNicknameMembers](./interfaces/MfaWebAuthnChangeKeyNicknameMembers): MfaWebAuthnChangeKeyNicknameMembers -- [ScreenMembersOnMfaWebAuthnEnrollmentSuccess](./interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess): ScreenMembersOnMfaWebAuthnEnrollmentSuccess -- [WebAuthnEnrollSuccessContinueOptions](./interfaces/WebAuthnEnrollSuccessContinueOptions): ContinueOptions -- [MfaWebAuthnEnrollmentSuccessMembers](./interfaces/MfaWebAuthnEnrollmentSuccessMembers): MfaWebAuthnEnrollmentSuccessMembers -- [ScreenMembersOnMfaWebAuthnError](./interfaces/ScreenMembersOnMfaWebAuthnError): ScreenMembersOnMfaWebAuthnError -- [MfaWebAuthnErrorMembers](./interfaces/MfaWebAuthnErrorMembers): MfaWebAuthnErrorMembers -- [MfaWebAuthnNotAvailableErrorMembers](./interfaces/MfaWebAuthnNotAvailableErrorMembers): MfaWebAuthnNotAvailableErrorMembers -- [ScreenMembersOnMfaWebAuthnPlatformChallenge](./interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge): ScreenMembersOnMfaWebAuthnPlatformChallenge -- [VerifyPlatformAuthenticatorOptions](./interfaces/VerifyPlatformAuthenticatorOptions): VerifyPlatformAuthenticatorOptions -- [MfaWebAuthnPlatformChallengeReportErrorOptions](./interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions): ReportBrowserErrorOptions -- [MfaWebAuthnPlatformChallengeTryAnotherMethodOptions](./interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions): TryAnotherMethodOptions -- [MfaWebAuthnPlatformChallengeMembers](./interfaces/MfaWebAuthnPlatformChallengeMembers): MfaWebAuthnPlatformChallengeMembers -- [ScreenMembersOnMfaWebAuthnPlatformEnrollment](./interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment): ScreenMembersOnMfaWebAuthnPlatformEnrollment -- [SubmitPasskeyCredentialOptions](./interfaces/SubmitPasskeyCredentialOptions): SubmitPasskeyCredentialOptions -- [ReportBrowserErrorOptions](./interfaces/ReportBrowserErrorOptions): ReportBrowserErrorOptions -- [MfaWebAuthnPlatformEnrollmentMembers](./interfaces/MfaWebAuthnPlatformEnrollmentMembers): MfaWebAuthnPlatformEnrollmentMembers -- [ScreenMembersOnMfaWebAuthnRoamingChallenge](./interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge): ScreenMembersOnMfaWebAuthnRoamingChallenge -- [VerifySecurityKeyOptions](./interfaces/VerifySecurityKeyOptions): VerifySecurityKeyOptions -- [MfaWebAuthnRoamingChallengeReportErrorOptions](./interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions): ReportWebAuthnErrorOptions -- [MfaWebAuthnRoamingChallengeTryAnotherMethodOptions](./interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions): TryAnotherMethodOptions -- [MfaWebAuthnRoamingChallengeMembers](./interfaces/MfaWebAuthnRoamingChallengeMembers): MfaWebAuthnRoamingChallengeMembers -- [ScreenMembersOnMfaWebAuthnRoamingEnrollment](./interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment): Interface for screen data specific to mfa-webauthn-roaming-enrollment screen. -- [ShowErrorOptions](./interfaces/ShowErrorOptions): Options for submitting a WebAuthn browser error. -- [MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions](./interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions): Options for trying another MFA method. -- [MfaWebAuthnRoamingEnrollmentMembers](./interfaces/MfaWebAuthnRoamingEnrollmentMembers): Interface defining the available methods and properties for the mfa-webauthn-roaming-enrollment screen. -- [SelectOrganizationOptions](./interfaces/SelectOrganizationOptions) -- [OrganizationPickerMembers](./interfaces/OrganizationPickerMembers): Interface defining the available methods and properties for the organization-picker screen -- [ContinueWithOrganizationNameOptions](./interfaces/ContinueWithOrganizationNameOptions): Options for continuing with the selected organization name. -- [ScreenMembersOnOrganizationSelection](./interfaces/ScreenMembersOnOrganizationSelection): Interface for the screen data specific to organization-selection screen. -- [OrganizationSelectionMembers](./interfaces/OrganizationSelectionMembers): Interface defining the available methods and properties for the organization-selection screen. -- [AbortEnrollmentOptions](./interfaces/AbortEnrollmentOptions) -- [ScreenMembersOnPasskeyEnrollmentLocal](./interfaces/ScreenMembersOnPasskeyEnrollmentLocal) -- [PasskeyEnrollmentLocalMembers](./interfaces/PasskeyEnrollmentLocalMembers) -- [ScreenMembersOnPasskeyEnrollment](./interfaces/ScreenMembersOnPasskeyEnrollment) -- [PasskeyEnrollmentMembers](./interfaces/PasskeyEnrollmentMembers) -- [PhoneChallengeOptions](./interfaces/PhoneChallengeOptions) -- [ScreenMembersOnPhoneIdentifierChallenge](./interfaces/ScreenMembersOnPhoneIdentifierChallenge) -- [PhoneIdentifierChallengeMembers](./interfaces/PhoneIdentifierChallengeMembers) -- [ScreenMembersOnPhoneIdentifierEnrollment](./interfaces/ScreenMembersOnPhoneIdentifierEnrollment) -- [PhoneEnrollmentOptions](./interfaces/PhoneEnrollmentOptions) -- [PhoneIdentifierEnrollmentMembers](./interfaces/PhoneIdentifierEnrollmentMembers) -- [RedeemTicketMembers](./interfaces/RedeemTicketMembers): Interface describing the data available on the Redeem Ticket screen. -- [ResetPasswordEmailOptions](./interfaces/ResetPasswordEmailOptions) -- [ScreenMembersOnResetPasswordEmail](./interfaces/ScreenMembersOnResetPasswordEmail) -- [ResetPasswordEmailMembers](./interfaces/ResetPasswordEmailMembers) -- [ScreenMembersOnResetPasswordError](./interfaces/ScreenMembersOnResetPasswordError) -- [ResetPasswordErrorMembers](./interfaces/ResetPasswordErrorMembers) -- [ScreenMembersOnResetPasswordMfaEmailChallenge](./interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge): Interface for the screen data specific to reset-password-mfa-email-challenge screen -- [ContinueOptions](./interfaces/ContinueOptions): Options for continuing with the email challenge. -- [ResendCodeOptions](./interfaces/ResendCodeOptions): Options for resending the email code. -- [TryAnotherMethodOptions](./interfaces/TryAnotherMethodOptions): Options for trying another method. -- [ResetPasswordMfaEmailChallengeMembers](./interfaces/ResetPasswordMfaEmailChallengeMembers): Interface defining the available methods and properties for the reset-password-mfa-email-challenge screen -- [ResetPasswordMfaOtpChallengeContinueOptions](./interfaces/ResetPasswordMfaOtpChallengeContinueOptions): Options for continuing with the OTP challenge. -- [ResetPasswordMfaOtpChallengeTryAnotherMethodOptions](./interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions): Options for trying another method. -- [ResetPasswordMfaOtpChallengeMembers](./interfaces/ResetPasswordMfaOtpChallengeMembers): Interface defining the available methods and properties for the reset-password-mfa-otp-challenge screen -- [ScreenMembersOnResetPasswordMfaPhoneChallenge](./interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge): ScreenMembersOnResetPasswordMfaPhoneChallenge -- [ResetPasswordMfaPhoneChallengeContinueOptions](./interfaces/ResetPasswordMfaPhoneChallengeContinueOptions): ContinueOptions -- [ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions](./interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions): TryAnotherMethodOptions -- [ResetPasswordMfaPhoneChallengeMembers](./interfaces/ResetPasswordMfaPhoneChallengeMembers): ResetPasswordMfaPhoneChallengeMembers -- [ScreenMembersOnResetPasswordMfaPushChallengePush](./interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush): Interface for the screen data specific to reset-password-mfa-push-challenge-push screen -- [ResetPasswordMfaPushChallengePushMembers](./interfaces/ResetPasswordMfaPushChallengePushMembers): Interface defining the available methods and properties for the reset-password-mfa-push-challenge-push screen -- [ResetPasswordMfaRecoveryCodeChallengeMembers](./interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers): Interface describing the members of the Mfa Recovery Code Challenge screen. -- [ResetPasswordMfaSmsChallengeOptions](./interfaces/ResetPasswordMfaSmsChallengeOptions) -- [ScreenMembersOnResetPasswordMfaSmsChallenge](./interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge) -- [ResetPasswordMfaSmsChallengeMembers](./interfaces/ResetPasswordMfaSmsChallengeMembers) -- [ScreenMembersOnResetPasswordMfaVoiceChallenge](./interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge): Interface for the screen data specific to reset-password-mfa-voice-challenge screen. -- [ResetPasswordMfaVoiceChallengeContinueOptions](./interfaces/ResetPasswordMfaVoiceChallengeContinueOptions): Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers. -- [ResetPasswordMfaVoiceChallengeMembers](./interfaces/ResetPasswordMfaVoiceChallengeMembers): Interface defining the available methods and properties for the reset-password-mfa-voice-challenge screen. -- [ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge](./interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge): ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge -- [ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions](./interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions): ContinueWithPasskeyOptions -- [ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions](./interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions): ReportBrowserErrorOptions -- [ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions](./interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions): TryAnotherMethodOptions -- [ResetPasswordMfaWebAuthnPlatformChallengeMembers](./interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers): ResetPasswordMfaWebAuthnPlatformChallengeMembers -- [ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge](./interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge): ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge -- [ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions](./interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions): UseSecurityKeyOptions -- [ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions](./interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions): ShowErrorOptions -- [ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions](./interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions): TryAnotherMethodOptions -- [ResetPasswordMfaWebAuthnRoamingChallengeMembers](./interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers): ResetPasswordMfaWebAuthnRoamingChallengeMembers -- [ResetPasswordRequestOptions](./interfaces/ResetPasswordRequestOptions) -- [TransactionMembersOnResetPasswordRequest](./interfaces/TransactionMembersOnResetPasswordRequest) -- [ScreenMembersOnResetPasswordRequest](./interfaces/ScreenMembersOnResetPasswordRequest) -- [ResetPasswordRequestMembers](./interfaces/ResetPasswordRequestMembers) -- [ScreenMembersOnResetPasswordSuccess](./interfaces/ScreenMembersOnResetPasswordSuccess) -- [ResetPasswordSuccessMembers](./interfaces/ResetPasswordSuccessMembers) -- [ResetPasswordOptions](./interfaces/ResetPasswordOptions) -- [ScreenMembersOnResetPassword](./interfaces/ScreenMembersOnResetPassword) -- [TransactionMembersOnResetPassword](./interfaces/TransactionMembersOnResetPassword) -- [ResetPasswordMembers](./interfaces/ResetPasswordMembers) -- [ScreenMembersOnSignupId](./interfaces/ScreenMembersOnSignupId) -- [TransactionMembersOnSignupId](./interfaces/TransactionMembersOnSignupId) -- [FederatedSignupOptions](./interfaces/FederatedSignupOptions) -- [SignupOptions](./interfaces/SignupOptions) -- [SignupIdMembers](./interfaces/SignupIdMembers) -- [FederatedSignupPasswordPayloadOptions](./interfaces/FederatedSignupPasswordPayloadOptions) -- [ScreenMembersOnSignupPassword](./interfaces/ScreenMembersOnSignupPassword) -- [TransactionMembersOnSignupPassword](./interfaces/TransactionMembersOnSignupPassword) -- [SignupPasswordOptions](./interfaces/SignupPasswordOptions) -- [SignupPasswordMembers](./interfaces/SignupPasswordMembers) -- [SignupPayloadOptions](./interfaces/SignupPayloadOptions) -- [FederatedSignupPayloadOptions](./interfaces/FederatedSignupPayloadOptions) -- [ScreenMembersOnSignup](./interfaces/ScreenMembersOnSignup) -- [TransactionMembersOnSignup](./interfaces/TransactionMembersOnSignup) -- [SignupMembers](./interfaces/SignupMembers) -- [CredentialResponse](./interfaces/CredentialResponse) -- [PasskeyCreateResponse](./interfaces/PasskeyCreateResponse) -- [MfaPushPollingControl](./interfaces/MfaPushPollingControl): Control interface for managing an MFA push-notification polling session. -- [StartResendOptions](./interfaces/StartResendOptions): Options for configuring resend functionality -- [ResendControl](./interfaces/ResendControl): Control object returned by resendManager method -- [Identifier](./interfaces/Identifier): Describes a configured identifier field (e.g. email, phone, or username) for use in a signup form or authentication flow. -- [PasswordValidationResult](./interfaces/PasswordValidationResult) -- [UsernameValidationError](./interfaces/UsernameValidationError): Represents a single username validation error returned during validation. -- [UsernameValidationResult](./interfaces/UsernameValidationResult): The result of validating a username against one or more rules. -- [ErrorsResult](./interfaces/ErrorsResult) -- [UseErrorOptions](./interfaces/UseErrorOptions) -- [UseErrorsResult](./interfaces/UseErrorsResult) -- [MfaPollingResult](./interfaces/MfaPollingResult): Result object returned by [useMfaPolling](../Hooks/functions/useMfaPolling). -- [UseResendReturn](./interfaces/UseResendReturn): Return type for [useResend](../Hooks/functions/useResend). -- [UseResendOptions](./interfaces/UseResendOptions): Optional configuration for [useResend](../Hooks/functions/useResend). -- [ErrorItem](./interfaces/ErrorItem) +- [CustomOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) +- [WebAuthnErrorDetails](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails): Details of a WebAuthn browser error. +- [CurrentScreenOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions): CurrentScreenOptions details. +- [FlattenedTheme](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme) +- [BaseMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) +- [BrandingSettings](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings) +- [BrandingThemes](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes) +- [BrandingMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) +- [ClientMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) +- [Branding](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding) +- [OrganizationMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) +- [PromptMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) +- [CaptchaContext](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) +- [AllowCredential](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential) +- [PasskeyCreate](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate) +- [PhonePrefix](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix) +- [Scope](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope) +- [AuthorizationDetail](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AuthorizationDetail) +- [ScreenMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) +- [TenantMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) +- [Connection](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) +- [UsernamePolicy](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy) +- [PasswordPolicy](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy) +- [EnterpriseConnection](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection) +- [PasswordComplexityRule](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule) +- [Error](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error) +- [TransactionMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) +- [UntrustedDataMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) +- [EnrolledEmail](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledEmail) +- [EnrolledPhoneNumber](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledPhoneNumber) +- [EnrolledDevice](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledDevice) +- [Organizations](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations) +- [UserMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) +- [ScreenMembersOnAcceptInvitation](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation) +- [AcceptInvitationMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers) +- [ScreenMembersOnConsent](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent): ScreenMembersOnConsent +- [ConsentMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers): ConsentMembers +- [ScreenMembersOnCustomizedConsent](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent): ScreenMembersOnCustomizedConsent +- [CustomizedConsentMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers): CustomizedConsentMembers +- [DeviceCodeActivationAllowedMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers): Interface describing the members of the Device Code Activation Allowed screen. +- [DeviceCodeActivationDeniedMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers): Interface describing the members of the Device Code Activation Denied screen. +- [DeviceCodeActivationContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions): payload for continuing device code activation. +- [DeviceCodeActivationMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers): Interface describing the members of the Device Code Activation screen. +- [ScreenMembersOnDeviceCodeConfirmation](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation): Interface describing the data available on the Device Code Confirmation screen. +- [DeviceCodeConfirmationMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers): Interface describing the members of the Device Code Confirmation screen. +- [EmailChallengeOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailChallengeOptions) +- [ScreenMembersOnEmailIdentifierChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge) +- [EmailIdentifierChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers) +- [ScreenMembersOnEmailOTPChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge): Represents the members of the Email OTP Challenge screen. Extends the base ScreenMembers interface. +- [OtpCodeOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions) +- [EmailOTPChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers): Represents the Email OTP Challenge screen interface. +- [ScreenMembersOnEmailVerificationResult](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult): ScreenMembersOnEmailVerificationResult +- [EmailVerificationResultMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers): EmailVerificationResultMembers +- [SubmitCaptchaOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCaptchaOptions) +- [InterstitialCaptchaMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers) +- [ContinueWithCodeOptionPayload](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload): ContinueWithCodeOptions description Options for the `continueWithCode` method on the Login Email Verification screen. This operation is used when the user submits the verification code they received via email to proceed with the authentication flow. +- [ResendCodeOptionsPayload](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload): ResendCodeOptions description Options for the `resendCode` method on the Login Email Verification screen. This operation is used when the user requests a new verification code to be sent to their email, for instance, if they did not receive the initial code or if it has expired. +- [LoginEmailVerificationMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers): LoginEmailVerificationMembers description Defines the members (properties and methods) available for interacting with the Login Email Verification screen. This screen is a crucial part of email verification processes, typically during login, where a user must prove ownership of an email address by providing a one-time code. The SDK facilitates submitting this code or requesting a new one. +- [ScreenMembersOnLoginId](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId) +- [TransactionMembersOnLoginId](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId) +- [LoginOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginOptions) +- [FederatedLoginOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginOptions) +- [LoginIdMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers) +- [ScreenMembersOnLoginPassword](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword) +- [TransactionMembersOnLoginPassword](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword) +- [LoginPasswordOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordOptions) +- [FederatedLoginPasswordOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPasswordOptions) +- [LoginPasswordMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers) +- [ScreenMembersOnLoginPasswordlessEmailCode](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode) +- [TransactionMembersOnLoginPasswordlessEmailCode](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode) +- [SubmitCodeOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions) +- [LoginPasswordlessEmailCodeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers) +- [ScreenMembersOnLoginPasswordlessSmsOtp](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp) +- [TransactionMembersOnLoginPasswordlessSmsOtp](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp) +- [SubmitOTPOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitOTPOptions) +- [LoginPasswordlessSmsOtpMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers) +- [ScreenMembersOnLogin](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin): Extended screen members interface for the login screen +- [TransactionMembersOnLogin](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin): Extended transaction members interface for the login screen +- [LoginPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPayloadOptions): Options for performing login operations +- [FederatedLoginPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPayloadOptions): Options for performing social login operations +- [LoginMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers): Login screen members interface extending base members +- [LogoutAbortedMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers): Interface defining the available methods and properties for the logout-aborted screen +- [LogoutCompleteMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers): Interface defining the available methods and properties for the logout-complete screen +- [ConfirmLogoutOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions): Options for confirming logout +- [LogoutMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers): Interface defining the available methods and properties for the logout screen +- [MfaEnrollOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions): Options for continuing with factor enrollment +- [MfaBeginEnrollOptionsMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers): MFA Begin Enroll Options screen members interface +- [ScreenMembersOnMfaCountryCodes](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes): Interface for screen data specific to mfa-country-codes screen +- [SelectCountryCodeOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectCountryCodeOptions): Options for selecting a country code +- [MfaCountryCodesMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers): Interface defining the available methods and properties for the mfa-country-codes screen +- [MfaDetectBrowserCapabilitiesMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers): Interface defining the available methods and properties for the mfa-detect-browser-capabilities screen +- [ScreenMembersOnMfaEmailChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge): Interface for the screen data specific to mfa-email-challenge screen +- [UntrustedDataMembersOnMfaEmailChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge): Interface for untrusted data specific to mfa-email-challenge screen +- [ContinuePayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinuePayloadOptions): Options for continuing with the email challenge +- [ResendCodePayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodePayloadOptions): Options for resending the email code +- [TryAnotherMethodPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodPayloadOptions): Options for trying another method +- [MfaEmailChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers): Interface defining the available methods and properties for the mfa-email-challenge screen +- [ScreenMembersOnMfaEmailList](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList): Interface for the screen data specific to mfa-email-list screen +- [SelectMfaEmailOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaEmailOptions): Options for selecting an email address +- [MfaEmailListMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers): Interface defining the available methods and properties for the mfa-email-list screen +- [ScreenMembersOnMfaEnrollResult](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult): ScreenMembersOnMfaEnrollResult +- [MfaEnrollResultMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers): MfaEnrollResultMembers +- [ScreenMembersOnMfaLoginOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions): Interface for the screen data specific to mfa-login-options screen +- [LoginEnrollOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions): Options for continuing with a selected MFA factor +- [MfaLoginOptionsMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers): Interface defining the available methods and properties for the mfa-login-options screen +- [ScreenMembersOnMfaOtpChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge): Interface for the screen data specific to mfa-otp-challenge screen +- [UntrustedDataMembersOnMfaOtpChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge): Interface for untrusted data specific to mfa-otp-challenge screen +- [ContinueOTPOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOTPOptions): Options for continuing with the OTP challenge +- [TryAnotherMethodMfaOtpChallengeOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodMfaOtpChallengeOptions): Options for trying another method +- [MfaOtpChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers): Interface defining the available methods and properties for the mfa-otp-challenge screen +- [MfaOtpContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpContinueOptions): Options for continuing with the MFA OTP enrollment code. +- [MfaOtpTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpTryAnotherMethodOptions): Options for trying another MFA method. +- [ScreenMembersOnMfaOtpEnrollmentCode](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode): Interface for the screen data specific to the mfa-otp-enrollment-code screen. +- [MfaOtpEnrollmentCodeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers): Interface defining the available methods and properties for the mfa-otp-enrollment-code screen. +- [ScreenMembersOnMfaOtpEnrollmentQr](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr): Interface for the screen data specific to mfa-otp-enrollment-qr screen +- [MfaOtpEnrollmentQrContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions): Interface for the payload of the continue method +- [MfaOtpEnrollmentQrMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers): Interface defining the available methods and properties for the mfa-otp-enrollment-qr screen +- [ScreenMembersOnMfaPhoneChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge): ScreenMembersOnMfaPhoneChallenge +- [MfaPhoneChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions): ContinueOptions Defines the options required to continue the MFA phone challenge process. This typically involves selecting the method (SMS or Voice) to receive the verification code. +- [MfaPhoneChallengePickPhoneOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions): PickPhoneOptions Defines the options for the 'pick-phone' action. Although the interface only shows one phone number, this action might be used in scenarios where the server needs to redirect to a phone selection screen. +- [MfaPhoneChallengePickAuthenticatorOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions): PickAuthenticatorOptions Defines the options for the 'pick-authenticator' action. This allows the user to choose a different MFA method if available. +- [MfaPhoneChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers): MfaPhoneChallengeMembers +- [MfaPhoneEnrollmentContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions): Options for continuing with the MFA phone enrollment. +- [MfaPhoneEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers) +- [ScreenMembersOnMfaPushChallengePush](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush): Interface for the screen data specific to mfa-push-challenge-push screen +- [UntrustedDataMembersOnMfaPushChallengePush](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush): Interface for untrusted data specific to mfa-push-challenge-push screen +- [WithRememberOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions) +- [MfaPushChallengePushMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers): Interface defining the available methods and properties for the mfa-push-challenge-push screen +- [ScreenMembersOnMfaPushEnrollmentQr](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr): Interface for the screen data specific to mfa-push-enrollment-qr screen +- [MfaPushEnrollmentQrMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers): Interface defining the available methods and properties for the mfa-push-enrollment-qr screen +- [SelectMfaPushDeviceOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaPushDeviceOptions): Options for selecting an MFA push device. +- [MfaPushListMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers): Interface defining the available methods and properties for the mfa-push-list screen +- [ScreenMembersOnMfaPushWelcome](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome) +- [MfaPushWelcomeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers) +- [ScreenMembersOnMfaRecoveryCodeChallengeNewCode](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode): ScreenMembersOnMfaRecoveryCodeChallengeNewCode +- [MfaRecoveryCodeChallengeNewCodeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions): ContinueOptions +- [MfaRecoveryCodeChallengeNewCodeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers): MfaRecoveryCodeChallengeNewCodeMembers +- [MfaRecoveryCodeChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions): Options for continuing with the MFA Recovery Code Challenge. +- [MfaRecoveryCodeChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers): Interface describing the members of the Mfa Recovery Code Challenge screen. +- [ScreenMembersOnMfaRecoveryCodeEnrollment](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment): Interface describing the data available on the Mfa Recovery Code Enrollment screen. +- [MfaRecoveryCodeEnrollmentContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions) +- [MfaRecoveryCodeEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers): Interface describing the members of the Mfa Recovery Code Enrollment screen. +- [MfaSmsChallengeOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeOptions) +- [ScreenMembersOnMfaSmsChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge): Interface for the screen data specific to mfa-sms-challenge screen +- [MfaSmsChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers) +- [UntrustedDataMembersOnMfaSmsChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge): Interface for untrusted data specific to mfa-sms-challenge screen +- [MfaSmsEnrollmentOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentOptions) +- [ScreenMembersOnMfaSmsEnrollment](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment) +- [MfaSmsEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers) +- [MfaSmsListOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListOptions): MfaSmsListOptions Options for performing actions on the mfa-sms-list screen. +- [MfaSmsListMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers): MfaSmsListMembers Interface defining the members and methods for the MfaSmsList class. +- [MfaVoiceChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeContinueOptions): Options for submitting the voice challenge code. +- [ScreenMembersOnMfaVoiceChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge): Extended screen members interface for the MFA Voice Challenge screen. +- [MfaVoiceChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers): Interface defining all members and operations available on the MFA Voice Challenge screen. +- [UntrustedDataMembersOnMfaVoiceChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge): Interface for untrusted data specific to mfa-voice-challenge screen +- [MfaVoiceEnrollmentContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions): Payload for continuing the MFA Voice Enrollment flow. +- [MfaVoiceEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers): Interface describing the members of the Mfa Voice Enrollment screen. +- [ScreenMembersOnMfaWebAuthnChangeKeyNickname](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname): ScreenMembersOnMfaWebAuthnChangeKeyNickname +- [MfaWebAuthnChangeKeyNicknameContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions): ContinueOptions +- [MfaWebAuthnChangeKeyNicknameMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers): MfaWebAuthnChangeKeyNicknameMembers +- [ScreenMembersOnMfaWebAuthnEnrollmentSuccess](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess): ScreenMembersOnMfaWebAuthnEnrollmentSuccess +- [WebAuthnEnrollSuccessContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions): ContinueOptions +- [MfaWebAuthnEnrollmentSuccessMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers): MfaWebAuthnEnrollmentSuccessMembers +- [ScreenMembersOnMfaWebAuthnError](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError): ScreenMembersOnMfaWebAuthnError +- [MfaWebAuthnErrorMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers): MfaWebAuthnErrorMembers +- [MfaWebAuthnNotAvailableErrorMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers): MfaWebAuthnNotAvailableErrorMembers +- [ScreenMembersOnMfaWebAuthnPlatformChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge): ScreenMembersOnMfaWebAuthnPlatformChallenge +- [VerifyPlatformAuthenticatorOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions): VerifyPlatformAuthenticatorOptions +- [MfaWebAuthnPlatformChallengeReportErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions): ReportBrowserErrorOptions +- [MfaWebAuthnPlatformChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions): TryAnotherMethodOptions +- [MfaWebAuthnPlatformChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers): MfaWebAuthnPlatformChallengeMembers +- [ScreenMembersOnMfaWebAuthnPlatformEnrollment](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment): ScreenMembersOnMfaWebAuthnPlatformEnrollment +- [SubmitPasskeyCredentialOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions): SubmitPasskeyCredentialOptions +- [ReportBrowserErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions): ReportBrowserErrorOptions +- [MfaWebAuthnPlatformEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers): MfaWebAuthnPlatformEnrollmentMembers +- [ScreenMembersOnMfaWebAuthnRoamingChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge): ScreenMembersOnMfaWebAuthnRoamingChallenge +- [VerifySecurityKeyOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions): VerifySecurityKeyOptions +- [MfaWebAuthnRoamingChallengeReportErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions): ReportWebAuthnErrorOptions +- [MfaWebAuthnRoamingChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions): TryAnotherMethodOptions +- [MfaWebAuthnRoamingChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers): MfaWebAuthnRoamingChallengeMembers +- [ScreenMembersOnMfaWebAuthnRoamingEnrollment](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment): Interface for screen data specific to mfa-webauthn-roaming-enrollment screen. +- [ShowErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions): Options for submitting a WebAuthn browser error. +- [MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions): Options for trying another MFA method. +- [MfaWebAuthnRoamingEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers): Interface defining the available methods and properties for the mfa-webauthn-roaming-enrollment screen. +- [SelectOrganizationOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectOrganizationOptions) +- [OrganizationPickerMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers): Interface defining the available methods and properties for the organization-picker screen +- [ContinueWithOrganizationNameOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithOrganizationNameOptions): Options for continuing with the selected organization name. +- [ScreenMembersOnOrganizationSelection](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection): Interface for the screen data specific to organization-selection screen. +- [OrganizationSelectionMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers): Interface defining the available methods and properties for the organization-selection screen. +- [AbortEnrollmentOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AbortEnrollmentOptions) +- [ScreenMembersOnPasskeyEnrollmentLocal](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal) +- [PasskeyEnrollmentLocalMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers) +- [ScreenMembersOnPasskeyEnrollment](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment) +- [PasskeyEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers) +- [PhoneChallengeOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneChallengeOptions) +- [ScreenMembersOnPhoneIdentifierChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge) +- [PhoneIdentifierChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers) +- [ScreenMembersOnPhoneIdentifierEnrollment](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment) +- [PhoneEnrollmentOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions) +- [PhoneIdentifierEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers) +- [RedeemTicketMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers): Interface describing the data available on the Redeem Ticket screen. +- [ResetPasswordEmailOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailOptions) +- [ScreenMembersOnResetPasswordEmail](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail) +- [ResetPasswordEmailMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers) +- [ScreenMembersOnResetPasswordError](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError) +- [ResetPasswordErrorMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers) +- [ScreenMembersOnResetPasswordMfaEmailChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge): Interface for the screen data specific to reset-password-mfa-email-challenge screen +- [ContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOptions): Options for continuing with the email challenge. +- [ResendCodeOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptions): Options for resending the email code. +- [TryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodOptions): Options for trying another method. +- [ResetPasswordMfaEmailChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers): Interface defining the available methods and properties for the reset-password-mfa-email-challenge screen +- [ResetPasswordMfaOtpChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeContinueOptions): Options for continuing with the OTP challenge. +- [ResetPasswordMfaOtpChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions): Options for trying another method. +- [ResetPasswordMfaOtpChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers): Interface defining the available methods and properties for the reset-password-mfa-otp-challenge screen +- [ScreenMembersOnResetPasswordMfaPhoneChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge): ScreenMembersOnResetPasswordMfaPhoneChallenge +- [ResetPasswordMfaPhoneChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions): ContinueOptions +- [ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions): TryAnotherMethodOptions +- [ResetPasswordMfaPhoneChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers): ResetPasswordMfaPhoneChallengeMembers +- [ScreenMembersOnResetPasswordMfaPushChallengePush](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush): Interface for the screen data specific to reset-password-mfa-push-challenge-push screen +- [ResetPasswordMfaPushChallengePushMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers): Interface defining the available methods and properties for the reset-password-mfa-push-challenge-push screen +- [ResetPasswordMfaRecoveryCodeChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers): Interface describing the members of the Mfa Recovery Code Challenge screen. +- [ResetPasswordMfaSmsChallengeOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeOptions) +- [ScreenMembersOnResetPasswordMfaSmsChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge) +- [ResetPasswordMfaSmsChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers) +- [ScreenMembersOnResetPasswordMfaVoiceChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge): Interface for the screen data specific to reset-password-mfa-voice-challenge screen. +- [ResetPasswordMfaVoiceChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions): Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers. +- [ResetPasswordMfaVoiceChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers): Interface defining the available methods and properties for the reset-password-mfa-voice-challenge screen. +- [ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge): ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge +- [ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions): ContinueWithPasskeyOptions +- [ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions): ReportBrowserErrorOptions +- [ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions): TryAnotherMethodOptions +- [ResetPasswordMfaWebAuthnPlatformChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers): ResetPasswordMfaWebAuthnPlatformChallengeMembers +- [ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge): ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge +- [ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions): UseSecurityKeyOptions +- [ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions): ShowErrorOptions +- [ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions): TryAnotherMethodOptions +- [ResetPasswordMfaWebAuthnRoamingChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers): ResetPasswordMfaWebAuthnRoamingChallengeMembers +- [ResetPasswordRequestOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestOptions) +- [TransactionMembersOnResetPasswordRequest](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest) +- [ScreenMembersOnResetPasswordRequest](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest) +- [ResetPasswordRequestMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers) +- [ScreenMembersOnResetPasswordSuccess](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess) +- [ResetPasswordSuccessMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers) +- [ResetPasswordOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordOptions) +- [ScreenMembersOnResetPassword](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword) +- [TransactionMembersOnResetPassword](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword) +- [ResetPasswordMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers) +- [ScreenMembersOnSignupId](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId) +- [TransactionMembersOnSignupId](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId) +- [FederatedSignupOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupOptions) +- [SignupOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupOptions) +- [SignupIdMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers) +- [FederatedSignupPasswordPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPasswordPayloadOptions) +- [ScreenMembersOnSignupPassword](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword) +- [TransactionMembersOnSignupPassword](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword) +- [SignupPasswordOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordOptions) +- [SignupPasswordMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers) +- [SignupPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPayloadOptions) +- [FederatedSignupPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPayloadOptions) +- [ScreenMembersOnSignup](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup) +- [TransactionMembersOnSignup](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup) +- [SignupMembers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers) +- [CredentialResponse](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CredentialResponse) +- [PasskeyCreateResponse](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse) +- [MfaPushPollingControl](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl): Control interface for managing an MFA push-notification polling session. +- [StartResendOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions): Options for configuring resend functionality +- [ResendControl](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl): Control object returned by resendManager method +- [Identifier](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier): Describes a configured identifier field (e.g. email, phone, or username) for use in a signup form or authentication flow. +- [PasswordValidationResult](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult) +- [UsernameValidationError](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationError): Represents a single username validation error returned during validation. +- [UsernameValidationResult](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult): The result of validating a username against one or more rules. +- [ErrorsResult](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult) +- [UseErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions) +- [UseErrorsResult](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult) +- [MfaPollingResult](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult): Result object returned by [useMfaPolling](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useMfaPolling). +- [UseResendReturn](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn): Return type for [useResend](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend). +- [UseResendOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions): Optional configuration for [useResend](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend). +- [ErrorItem](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem) ## Type Aliases -- [AuthenticatorTransport](./type-aliases/AuthenticatorTransport) -- [WebAuthnType](./type-aliases/WebAuthnType) -- [MfaPollingOptions](./type-aliases/MfaPollingOptions): Configuration options for managing an MFA push-notification polling process. -- [OnStatusChangeCallback](./type-aliases/OnStatusChangeCallback): Callback function for status changes during resend countdown. -- [ScreenIdentifierType](./type-aliases/ScreenIdentifierType): Represents the types of user identifiers that can be used during signup. -- [IdentifierType](./type-aliases/IdentifierType): Type representing valid identifier values -- [MfaLoginFactorType](./type-aliases/MfaLoginFactorType): Type definition for MFA login factor constants -- [MfaEnrollFactorType](./type-aliases/MfaEnrollFactorType): Type definition for MFA enroll factor constants -- [ErrorKind](./type-aliases/ErrorKind) +- [AuthenticatorTransport](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/AuthenticatorTransport) +- [WebAuthnType](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType) +- [MfaPollingOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions): Configuration options for managing an MFA push-notification polling process. +- [OnStatusChangeCallback](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/OnStatusChangeCallback): Callback function for status changes during resend countdown. +- [ScreenIdentifierType](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ScreenIdentifierType): Represents the types of user identifiers that can be used during signup. +- [IdentifierType](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType): Type representing valid identifier values +- [MfaLoginFactorType](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaLoginFactorType): Type definition for MFA login factor constants +- [MfaEnrollFactorType](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaEnrollFactorType): Type definition for MFA enroll factor constants +- [ErrorKind](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind) ## References ### ULError -Renames and re-exports [Error](./interfaces/Error) +Renames and re-exports [Error](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error) *** ### useAuth0Themes -Re-exports [useAuth0Themes](../Hooks/functions/useAuth0Themes) +Re-exports [useAuth0Themes](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes) *** ### useCurrentScreen -Re-exports [useCurrentScreen](../Hooks/functions/useCurrentScreen) +Re-exports [useCurrentScreen](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen) *** ### useErrors -Re-exports [useErrors](../Hooks/functions/useErrors) +Re-exports [useErrors](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors) *** ### useLoginIdentifiers -Re-exports [useLoginIdentifiers](../Hooks/functions/useLoginIdentifiers) +Re-exports [useLoginIdentifiers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useLoginIdentifiers) *** ### useSignupIdentifiers -Re-exports [useSignupIdentifiers](../Hooks/functions/useSignupIdentifiers) +Re-exports [useSignupIdentifiers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useSignupIdentifiers) *** ### useMfaPolling -Re-exports [useMfaPolling](../Hooks/functions/useMfaPolling) +Re-exports [useMfaPolling](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useMfaPolling) *** ### useResend -Re-exports [useResend](../Hooks/functions/useResend) +Re-exports [useResend](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend) *** ### usePasswordValidation -Re-exports [usePasswordValidation](../Hooks/functions/usePasswordValidation) +Re-exports [usePasswordValidation](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/usePasswordValidation) *** ### useUsernameValidation -Re-exports [useUsernameValidation](../Hooks/functions/useUsernameValidation) \ No newline at end of file +Re-exports [useUsernameValidation](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useUsernameValidation) \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers.mdx index 992a29d1c..62f647464 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitati ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:15 **Overrides** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:16 **Overrides** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:17 **Overrides** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnAcceptInvitation](./ScreenMembersOnAcceptInvitation)'> -> **screen**: [`ScreenMembersOnAcceptInvitation`](./ScreenMembersOnAcceptInvitation) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation">ScreenMembersOnAcceptInvitation</a>}> +> **screen**: [`ScreenMembersOnAcceptInvitation`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:18 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:19 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -121,7 +121,7 @@ Accepts the invitation to the organization. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential.mdx index 08acb0306..9b5c628e5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential.mdx @@ -20,8 +20,8 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:10 </ParamField> -<ParamField body='transports?' type='[AuthenticatorTransport](../type-aliases/AuthenticatorTransport)[]'> -> `optional` **transports**: [`AuthenticatorTransport`](../type-aliases/AuthenticatorTransport)[] +<ParamField body='transports?' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/AuthenticatorTransport">AuthenticatorTransport</a>[]}> +> `optional` **transports**: [`AuthenticatorTransport`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/AuthenticatorTransport)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:11 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.mdx index a21505045..819ef3781 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.mdx @@ -6,143 +6,143 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.t ## Extended by -- [`LogoutMembers`](./LogoutMembers) -- [`LogoutAbortedMembers`](./LogoutAbortedMembers) -- [`LoginIdMembers`](./LoginIdMembers) -- [`LoginPasswordMembers`](./LoginPasswordMembers) -- [`SignupIdMembers`](./SignupIdMembers) -- [`SignupPasswordMembers`](./SignupPasswordMembers) -- [`LoginPasswordlessEmailCodeMembers`](./LoginPasswordlessEmailCodeMembers) -- [`LoginPasswordlessSmsOtpMembers`](./LoginPasswordlessSmsOtpMembers) -- [`PasskeyEnrollmentMembers`](./PasskeyEnrollmentMembers) -- [`PasskeyEnrollmentLocalMembers`](./PasskeyEnrollmentLocalMembers) -- [`PhoneIdentifierChallengeMembers`](./PhoneIdentifierChallengeMembers) -- [`PhoneIdentifierEnrollmentMembers`](./PhoneIdentifierEnrollmentMembers) -- [`EmailIdentifierChallengeMembers`](./EmailIdentifierChallengeMembers) -- [`InterstitialCaptchaMembers`](./InterstitialCaptchaMembers) -- [`LoginMembers`](./LoginMembers) -- [`SignupMembers`](./SignupMembers) -- [`ResetPasswordEmailMembers`](./ResetPasswordEmailMembers) -- [`ResetPasswordRequestMembers`](./ResetPasswordRequestMembers) -- [`ResetPasswordMembers`](./ResetPasswordMembers) -- [`ResetPasswordErrorMembers`](./ResetPasswordErrorMembers) -- [`ResetPasswordSuccessMembers`](./ResetPasswordSuccessMembers) -- [`ResetPasswordMfaPushChallengePushMembers`](./ResetPasswordMfaPushChallengePushMembers) -- [`MfaPushEnrollmentQrMembers`](./MfaPushEnrollmentQrMembers) -- [`MfaPushListMembers`](./MfaPushListMembers) -- [`MfaPushWelcomeMembers`](./MfaPushWelcomeMembers) -- [`MfaSmsEnrollmentMembers`](./MfaSmsEnrollmentMembers) -- [`MfaBeginEnrollOptionsMembers`](./MfaBeginEnrollOptionsMembers) -- [`MfaSmsChallengeMembers`](./MfaSmsChallengeMembers) -- [`MfaCountryCodesMembers`](./MfaCountryCodesMembers) -- [`ResetPasswordMfaEmailChallengeMembers`](./ResetPasswordMfaEmailChallengeMembers) -- [`ResetPasswordMfaSmsChallengeMembers`](./ResetPasswordMfaSmsChallengeMembers) -- [`MfaDetectBrowserCapabilitiesMembers`](./MfaDetectBrowserCapabilitiesMembers) -- [`MfaEmailChallengeMembers`](./MfaEmailChallengeMembers) -- [`MfaEmailListMembers`](./MfaEmailListMembers) -- [`MfaSmsListMembers`](./MfaSmsListMembers) -- [`MfaEnrollResultMembers`](./MfaEnrollResultMembers) -- [`MfaLoginOptionsMembers`](./MfaLoginOptionsMembers) -- [`MfaPushChallengePushMembers`](./MfaPushChallengePushMembers) -- [`MfaOtpChallengeMembers`](./MfaOtpChallengeMembers) -- [`MfaOtpEnrollmentQrMembers`](./MfaOtpEnrollmentQrMembers) -- [`MfaOtpEnrollmentCodeMembers`](./MfaOtpEnrollmentCodeMembers) -- [`ResetPasswordMfaOtpChallengeMembers`](./ResetPasswordMfaOtpChallengeMembers) -- [`OrganizationSelectionMembers`](./OrganizationSelectionMembers) -- [`OrganizationPickerMembers`](./OrganizationPickerMembers) -- [`AcceptInvitationMembers`](./AcceptInvitationMembers) -- [`CustomizedConsentMembers`](./CustomizedConsentMembers) -- [`MfaPhoneEnrollmentMembers`](./MfaPhoneEnrollmentMembers) -- [`MfaVoiceEnrollmentMembers`](./MfaVoiceEnrollmentMembers) -- [`MfaRecoveryCodeChallengeMembers`](./MfaRecoveryCodeChallengeMembers) -- [`DeviceCodeActivationAllowedMembers`](./DeviceCodeActivationAllowedMembers) -- [`DeviceCodeActivationDeniedMembers`](./DeviceCodeActivationDeniedMembers) -- [`DeviceCodeActivationMembers`](./DeviceCodeActivationMembers) -- [`MfaVoiceChallengeMembers`](./MfaVoiceChallengeMembers) -- [`ResetPasswordMfaRecoveryCodeChallengeMembers`](./ResetPasswordMfaRecoveryCodeChallengeMembers) -- [`ResetPasswordMfaVoiceChallengeMembers`](./ResetPasswordMfaVoiceChallengeMembers) -- [`RedeemTicketMembers`](./RedeemTicketMembers) -- [`DeviceCodeConfirmationMembers`](./DeviceCodeConfirmationMembers) -- [`MfaPhoneChallengeMembers`](./MfaPhoneChallengeMembers) -- [`MfaRecoveryCodeEnrollmentMembers`](./MfaRecoveryCodeEnrollmentMembers) -- [`ResetPasswordMfaPhoneChallengeMembers`](./ResetPasswordMfaPhoneChallengeMembers) -- [`MfaRecoveryCodeChallengeNewCodeMembers`](./MfaRecoveryCodeChallengeNewCodeMembers) -- [`LogoutCompleteMembers`](./LogoutCompleteMembers) -- [`EmailVerificationResultMembers`](./EmailVerificationResultMembers) -- [`EmailOTPChallengeMembers`](./EmailOTPChallengeMembers) -- [`LoginEmailVerificationMembers`](./LoginEmailVerificationMembers) -- [`MfaWebAuthnPlatformEnrollmentMembers`](./MfaWebAuthnPlatformEnrollmentMembers) -- [`MfaWebAuthnErrorMembers`](./MfaWebAuthnErrorMembers) -- [`MfaWebAuthnNotAvailableErrorMembers`](./MfaWebAuthnNotAvailableErrorMembers) -- [`MfaWebAuthnRoamingEnrollmentMembers`](./MfaWebAuthnRoamingEnrollmentMembers) -- [`MfaWebAuthnRoamingChallengeMembers`](./MfaWebAuthnRoamingChallengeMembers) -- [`MfaWebAuthnPlatformChallengeMembers`](./MfaWebAuthnPlatformChallengeMembers) -- [`MfaWebAuthnEnrollmentSuccessMembers`](./MfaWebAuthnEnrollmentSuccessMembers) -- [`MfaWebAuthnChangeKeyNicknameMembers`](./MfaWebAuthnChangeKeyNicknameMembers) -- [`ConsentMembers`](./ConsentMembers) -- [`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](./ResetPasswordMfaWebAuthnPlatformChallengeMembers) -- [`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](./ResetPasswordMfaWebAuthnRoamingChallengeMembers) +- [`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers) +- [`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers) +- [`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers) +- [`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers) +- [`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers) +- [`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers) +- [`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers) +- [`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers) +- [`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers) +- [`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers) +- [`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers) +- [`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers) +- [`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers) +- [`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers) +- [`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers) +- [`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers) +- [`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers) +- [`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers) +- [`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers) +- [`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers) +- [`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers) +- [`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers) +- [`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers) +- [`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers) +- [`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers) +- [`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers) +- [`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers) +- [`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers) +- [`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers) +- [`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers) +- [`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers) +- [`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers) +- [`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers) +- [`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers) +- [`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers) +- [`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers) +- [`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers) +- [`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers) +- [`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers) +- [`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers) +- [`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers) +- [`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers) +- [`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers) +- [`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers) +- [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers) +- [`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers) +- [`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers) +- [`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers) +- [`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers) +- [`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers) +- [`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers) +- [`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers) +- [`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers) +- [`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers) +- [`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers) +- [`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers) +- [`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers) +- [`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers) +- [`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers) +- [`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers) +- [`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers) +- [`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers) +- [`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers) +- [`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers) +- [`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers) +- [`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers) +- [`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers) +- [`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers) +- [`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers) +- [`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers) +- [`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers) +- [`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers) +- [`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers) +- [`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers) +- [`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers) +- [`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers.mdx index 979e3750c..1cec27ff4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers.mdx @@ -6,15 +6,15 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:53 ## Properties -<ParamField body='settings' type='[BrandingSettings](./BrandingSettings) '> -> **settings**: [`BrandingSettings`](./BrandingSettings) \| `null` +<ParamField body='settings' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings">BrandingSettings</a> }> +> **settings**: [`BrandingSettings`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:54 </ParamField> -<ParamField body='themes' type='[BrandingThemes](./BrandingThemes) '> -> **themes**: [`BrandingThemes`](./BrandingThemes) \| `null` +<ParamField body='themes' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes">BrandingThemes</a> }> +> **themes**: [`BrandingThemes`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:55 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions.mdx index 65053c02c..bc97e0e10 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions.mdx @@ -8,7 +8,7 @@ Options for confirming logout ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection.mdx index 6a53f1da2..8c3c0538d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts ## Extended by -- [`EnterpriseConnection`](./EnterpriseConnection) +- [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection) ## Properties diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers.mdx index fa28ecfb3..246f63b66 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers.mdx @@ -8,100 +8,100 @@ ConsentMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnConsent](./ScreenMembersOnConsent)'> -> **screen**: [`ScreenMembersOnConsent`](./ScreenMembersOnConsent) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent">ScreenMembersOnConsent</a>}> +> **screen**: [`ScreenMembersOnConsent`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/consent.d.ts:44 @@ -110,7 +110,7 @@ including the list of `scopes` being requested and the `hideScopes` flag. **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -127,7 +127,7 @@ This action posts to the `/u/consent` endpoint with `action: "accept"`. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional. An object for any custom key-value pairs to be sent with the request. These parameters will be @@ -175,7 +175,7 @@ This action posts to the `/u/consent` endpoint with `action: "deny"`. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional. An object for any custom key-value pairs to be sent with the request. These parameters will be diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload.mdx index 4986b29e9..d6449a95c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload.mdx @@ -11,7 +11,7 @@ to proceed with the authentication flow. ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions.mdx index 4231148b1..77cc9bf4b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions.mdx @@ -43,8 +43,8 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:40 </ParamField> -<ParamField body='transaction' type='{ errors: [Error](./Error)[] '> -> **transaction**: \{ `errors`: [`Error`](./Error)[] \| `null`; `state`: `string`; `locale`: `string`; \} \| `null` +<ParamField body='transaction' type={{ errors: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +> **transaction**: \{ `errors`: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null`; `state`: `string`; `locale`: `string`; \} \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:43 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions.mdx index c063c176e..4f0d1eabe 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions.mdx @@ -6,35 +6,35 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:2 ## Extended by -- [`OtpCodeOptions`](./OtpCodeOptions) -- [`WithRememberOptions`](./WithRememberOptions) -- [`MfaPhoneChallengeContinueOptions`](./MfaPhoneChallengeContinueOptions) -- [`MfaPhoneChallengePickPhoneOptions`](./MfaPhoneChallengePickPhoneOptions) -- [`MfaPhoneChallengePickAuthenticatorOptions`](./MfaPhoneChallengePickAuthenticatorOptions) -- [`MfaRecoveryCodeEnrollmentContinueOptions`](./MfaRecoveryCodeEnrollmentContinueOptions) -- [`ResetPasswordMfaPhoneChallengeContinueOptions`](./ResetPasswordMfaPhoneChallengeContinueOptions) -- [`ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions`](./ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions) -- [`MfaRecoveryCodeChallengeNewCodeContinueOptions`](./MfaRecoveryCodeChallengeNewCodeContinueOptions) -- [`ConfirmLogoutOptions`](./ConfirmLogoutOptions) -- [`ContinueWithCodeOptionPayload`](./ContinueWithCodeOptionPayload) -- [`ResendCodeOptionsPayload`](./ResendCodeOptionsPayload) -- [`SubmitPasskeyCredentialOptions`](./SubmitPasskeyCredentialOptions) -- [`VerifySecurityKeyOptions`](./VerifySecurityKeyOptions) -- [`MfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](./MfaWebAuthnRoamingChallengeTryAnotherMethodOptions) -- [`VerifyPlatformAuthenticatorOptions`](./VerifyPlatformAuthenticatorOptions) -- [`MfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](./MfaWebAuthnPlatformChallengeTryAnotherMethodOptions) -- [`WebAuthnEnrollSuccessContinueOptions`](./WebAuthnEnrollSuccessContinueOptions) -- [`MfaWebAuthnChangeKeyNicknameContinueOptions`](./MfaWebAuthnChangeKeyNicknameContinueOptions) -- [`ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions`](./ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions) -- [`ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](./ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions) -- [`ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions`](./ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions) -- [`ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](./ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions) -- [`MfaOtpEnrollmentQrContinueOptions`](./MfaOtpEnrollmentQrContinueOptions) -- [`DeviceCodeActivationContinueOptions`](./DeviceCodeActivationContinueOptions) -- [`MfaPhoneEnrollmentContinueOptions`](./MfaPhoneEnrollmentContinueOptions) -- [`MfaRecoveryCodeChallengeContinueOptions`](./MfaRecoveryCodeChallengeContinueOptions) -- [`MfaVoiceEnrollmentContinueOptions`](./MfaVoiceEnrollmentContinueOptions) -- [`ResetPasswordMfaVoiceChallengeContinueOptions`](./ResetPasswordMfaVoiceChallengeContinueOptions) +- [`OtpCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions) +- [`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions) +- [`MfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions) +- [`MfaPhoneChallengePickPhoneOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions) +- [`MfaPhoneChallengePickAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions) +- [`MfaRecoveryCodeEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions) +- [`ResetPasswordMfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions) +- [`ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions) +- [`MfaRecoveryCodeChallengeNewCodeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions) +- [`ConfirmLogoutOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions) +- [`ContinueWithCodeOptionPayload`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload) +- [`ResendCodeOptionsPayload`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload) +- [`SubmitPasskeyCredentialOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions) +- [`VerifySecurityKeyOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions) +- [`MfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions) +- [`VerifyPlatformAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions) +- [`MfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions) +- [`WebAuthnEnrollSuccessContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions) +- [`MfaWebAuthnChangeKeyNicknameContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions) +- [`ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions) +- [`ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions) +- [`ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions) +- [`ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions) +- [`MfaOtpEnrollmentQrContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions) +- [`DeviceCodeActivationContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions) +- [`MfaPhoneEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions) +- [`MfaRecoveryCodeChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions) +- [`MfaVoiceEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions) +- [`ResetPasswordMfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers.mdx index dc20127e1..7f6e37555 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers.mdx @@ -8,100 +8,100 @@ CustomizedConsentMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnCustomizedConsent](./ScreenMembersOnCustomizedConsent)'> -> **screen**: [`ScreenMembersOnCustomizedConsent`](./ScreenMembersOnCustomizedConsent) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent">ScreenMembersOnCustomizedConsent</a>}> +> **screen**: [`ScreenMembersOnCustomizedConsent`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/customized-consent.d.ts:55 @@ -110,7 +110,7 @@ including the list of `scopes` and `authorizationDetails` being requested. **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -128,7 +128,7 @@ The transaction state is automatically included. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional. An object for any custom key-value pairs to be sent with the request. These parameters will be @@ -177,7 +177,7 @@ The transaction state is automatically included. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional. An object for any custom key-value pairs to be sent with the request. These parameters will be diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers.mdx index 4067e9a3e..ae6980fcc 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers.mdx @@ -8,104 +8,104 @@ Interface describing the members of the Device Code Activation Allowed screen. ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 **Inherited from** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions.mdx index 831d2dc30..64c2a5149 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions.mdx @@ -12,7 +12,7 @@ a simpler structure for consumers of this interface. ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers.mdx index e64170384..83216efdc 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers.mdx @@ -8,104 +8,104 @@ Interface describing the members of the Device Code Activation Denied screen. ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 **Inherited from** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers.mdx index fb2c02538..07a72fa5a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers.mdx @@ -8,106 +8,106 @@ Interface describing the members of the Device Code Activation screen. ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 **Inherited from** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) **Methods** </ParamField> @@ -124,7 +124,7 @@ This action is triggered when the user enters the code displayed on their device **payload** -[`DeviceCodeActivationContinueOptions`](./DeviceCodeActivationContinueOptions) +[`DeviceCodeActivationContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions) An object containing the code entered by the user and any custom payload. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers.mdx index c5ff5b693..5f8526a3c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers.mdx @@ -8,106 +8,106 @@ Interface describing the members of the Device Code Confirmation screen. ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnDeviceCodeConfirmation](./ScreenMembersOnDeviceCodeConfirmation)'> -> **screen**: [`ScreenMembersOnDeviceCodeConfirmation`](./ScreenMembersOnDeviceCodeConfirmation) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation">ScreenMembersOnDeviceCodeConfirmation</a>}> +> **screen**: [`ScreenMembersOnDeviceCodeConfirmation`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-confirmation.d.ts:16 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -123,7 +123,7 @@ Confirms the device code. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. @@ -144,7 +144,7 @@ Cancels the device code flow. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers.mdx index 5aed362d4..ed6acaa7e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifie ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnEmailIdentifierChallenge](./ScreenMembersOnEmailIdentifierChallenge)'> -> **screen**: [`ScreenMembersOnEmailIdentifierChallenge`](./ScreenMembersOnEmailIdentifierChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge">ScreenMembersOnEmailIdentifierChallenge</a>}> +> **screen**: [`ScreenMembersOnEmailIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:18 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifie **payload** -[`EmailChallengeOptions`](./EmailChallengeOptions) +[`EmailChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailChallengeOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifie **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -145,7 +145,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifie </ParamField> <ParamField body='resendManager()' type='unknown'> -> **resendManager**(`payload?`): [`ResendControl`](./ResendControl) +> **resendManager**(`payload?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:21 @@ -153,11 +153,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifie **payload?** -[`StartResendOptions`](./StartResendOptions) +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) **Returns** -[`ResendControl`](./ResendControl) +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) </ParamField> @@ -170,7 +170,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifie **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers.mdx index 1d4d53ad9..7852ce1d1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers.mdx @@ -8,106 +8,106 @@ Represents the Email OTP Challenge screen interface. ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnEmailOTPChallenge](./ScreenMembersOnEmailOTPChallenge)'> -> **screen**: [`ScreenMembersOnEmailOTPChallenge`](./ScreenMembersOnEmailOTPChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge">ScreenMembersOnEmailOTPChallenge</a>}> +> **screen**: [`ScreenMembersOnEmailOTPChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-otp-challenge.d.ts:21 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -123,7 +123,7 @@ Submits the OTP code entered by the user. **options** -[`OtpCodeOptions`](./OtpCodeOptions) +[`OtpCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions) Optional parameters to include in the submission. @@ -144,7 +144,7 @@ Requests a new OTP code to be sent to the user's email. **options?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional parameters to include in the resend request. @@ -155,7 +155,7 @@ Optional parameters to include in the resend request. </ParamField> <ParamField body='resendManager()' type='unknown'> -> **resendManager**(`options?`): [`ResendControl`](./ResendControl) +> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-otp-challenge.d.ts:36 @@ -165,11 +165,11 @@ Gets resend functionality with timeout management for this screen **options?** -[`StartResendOptions`](./StartResendOptions) +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) Configuration options for resend functionality **Returns** -[`ResendControl`](./ResendControl) +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers.mdx index 442a0e055..8805bbc5a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers.mdx @@ -8,100 +8,100 @@ EmailVerificationResultMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnEmailVerificationResult](./ScreenMembersOnEmailVerificationResult)'> -> **screen**: [`ScreenMembersOnEmailVerificationResult`](./ScreenMembersOnEmailVerificationResult) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult">ScreenMembersOnEmailVerificationResult</a>}> +> **screen**: [`ScreenMembersOnEmailVerificationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-verification-result.d.ts:48 @@ -109,5 +109,5 @@ Screen-specific data, including verification status and login link. **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection.mdx index cad8dbb42..a4468dc9a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts ## Extends -- [`Connection`](./Connection) +- [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`Connection`](./Connection).[`name`](./Connection.md#name) +[`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`Connection`](./Connection).[`strategy`](./Connection.md#strategy) +[`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection).[`strategy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection.md#strategy) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`Connection`](./Connection).[`metadata`](./Connection.md#metadata) +[`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection).[`metadata`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection.md#metadata) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.mdx index d160b2977..031193fb1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts ## Extended by -- [`ErrorItem`](./ErrorItem) +- [`ErrorItem`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem) ## Properties @@ -31,8 +31,8 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='rules?' type='[PasswordComplexityRule](./PasswordComplexityRule)[]'> -> `optional` **rules**: [`PasswordComplexityRule`](./PasswordComplexityRule)[] +<ParamField body='rules?' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule">PasswordComplexityRule</a>[]}> +> `optional` **rules**: [`PasswordComplexityRule`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:141 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem.mdx index fe2d6174b..4cad872ad 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem.mdx @@ -6,7 +6,7 @@ Defined in: [packages/auth0-acul-react/src/state/error-store.ts:3](https://githu ## Extends -- [`Error`](./Error) +- [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`Error`](./Error).[`code`](./Error.md#code) +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error).[`code`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.md#code) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`Error`](./Error).[`field`](./Error.md#field) +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error).[`field`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.md#field) </ParamField> @@ -39,18 +39,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`Error`](./Error).[`message`](./Error.md#message) +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error).[`message`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.md#message) </ParamField> -<ParamField body='rules?' type='[PasswordComplexityRule](./PasswordComplexityRule)[]'> -> `optional` **rules**: [`PasswordComplexityRule`](./PasswordComplexityRule)[] +<ParamField body='rules?' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule">PasswordComplexityRule</a>[]}> +> `optional` **rules**: [`PasswordComplexityRule`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:141 **Inherited from** -[`Error`](./Error).[`rules`](./Error.md#rules) +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error).[`rules`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.md#rules) </ParamField> @@ -68,8 +68,8 @@ Defined in: [packages/auth0-acul-react/src/state/error-store.ts:5](https://githu </ParamField> -<ParamField body='kind?' type='[ErrorKind](../type-aliases/ErrorKind)'> -> `optional` **kind**: [`ErrorKind`](../type-aliases/ErrorKind) +<ParamField body='kind?' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>}> +> `optional` **kind**: [`ErrorKind`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind) Defined in: [packages/auth0-acul-react/src/state/error-store.ts:6](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/state/error-store.ts#L6) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult.mdx index 0a56f747d..affe1cb3e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult.mdx @@ -6,17 +6,17 @@ Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:12](https://gi ## Extends -- `ReadonlyArray`\<[`ErrorItem`](./ErrorItem)\> +- `ReadonlyArray`\<[`ErrorItem`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem)\> ## Indexable -\[`n`: `number`\]: [`ErrorItem`](./ErrorItem) +\[`n`: `number`\]: [`ErrorItem`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem) ## Methods ### byKind() -> **byKind**(`kind`, `opts?`): readonly [`ErrorItem`](./ErrorItem)[] +> **byKind**(`kind`, `opts?`): readonly [`ErrorItem`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem)[] Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:13](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L13) @@ -24,7 +24,7 @@ Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:13](https://gi ##### kind -[`ErrorKind`](../type-aliases/ErrorKind) +[`ErrorKind`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind) ##### opts? @@ -34,13 +34,13 @@ Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:13](https://gi #### Returns -readonly [`ErrorItem`](./ErrorItem)[] +readonly [`ErrorItem`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem)[] *** ### byField() -> **byField**(`field`, `opts?`): readonly [`ErrorItem`](./ErrorItem)[] +> **byField**(`field`, `opts?`): readonly [`ErrorItem`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem)[] Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:14](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L14) @@ -54,8 +54,8 @@ Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:14](https://gi ###### kind? -[`ErrorKind`](../type-aliases/ErrorKind) +[`ErrorKind`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind) #### Returns -readonly [`ErrorItem`](./ErrorItem)[] \ No newline at end of file +readonly [`ErrorItem`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem)[] \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier.mdx index f0fe37654..c935e574f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier.mdx @@ -18,8 +18,8 @@ const emailIdentifier: Identifier = { ## Properties -<ParamField body='type' type='[ScreenIdentifierType](../type-aliases/ScreenIdentifierType)'> -> **type**: [`ScreenIdentifierType`](../type-aliases/ScreenIdentifierType) +<ParamField body='type' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ScreenIdentifierType">ScreenIdentifierType</a>}> +> **type**: [`ScreenIdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ScreenIdentifierType) Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/signup-identifiers.d.ts:35 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers.mdx index c2714aec6..2ac826a61 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/interstitial-ca ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 **Inherited from** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> @@ -118,7 +118,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/interstitial-ca **payload** -[`SubmitCaptchaOptions`](./SubmitCaptchaOptions) +[`SubmitCaptchaOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCaptchaOptions) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers.mdx index 3ce440ff6..d871c0234 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers.mdx @@ -19,106 +19,106 @@ The `universal_login_context` for this screen (`window.universal_login_context`) ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 **Inherited from** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) **Methods** </ParamField> @@ -143,7 +143,7 @@ about the failure (e.g., error code `invalid-code`). **payload** -[`ContinueWithCodeOptionPayload`](./ContinueWithCodeOptionPayload) +[`ContinueWithCodeOptionPayload`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload) An object containing the `code` string entered by the user. It can also include any `CustomOptions` for extensibility. @@ -206,7 +206,7 @@ identified by error code `too-many-emails`), `transaction.errors` will be update **payload?** -[`ResendCodeOptionsPayload`](./ResendCodeOptionsPayload) +[`ResendCodeOptionsPayload`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload) Optional. An object for `CustomOptions` if any additional parameters need to be sent with the request. @@ -248,7 +248,7 @@ if (manager.transaction.errors && manager.transaction.errors.length > 0) { </ParamField> <ParamField body='resendManager()' type='unknown'> -> **resendManager**(`options?`): [`ResendControl`](./ResendControl) +> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-email-verification.d.ts:135 @@ -258,11 +258,11 @@ Gets resend functionality with timeout management for this screen **options?** -[`StartResendOptions`](./StartResendOptions) +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) Configuration options for resend functionality **Returns** -[`ResendControl`](./ResendControl) +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions.mdx index 4eb7966b5..3bdd30d15 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions.mdx @@ -14,8 +14,8 @@ Any additional custom options ## Properties -<ParamField body='action' type='[MfaLoginFactorType](../type-aliases/MfaLoginFactorType)'> -> **action**: [`MfaLoginFactorType`](../type-aliases/MfaLoginFactorType) +<ParamField body='action' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaLoginFactorType">MfaLoginFactorType</a>}> +> **action**: [`MfaLoginFactorType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaLoginFactorType) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-login-options.d.ts:19 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers.mdx index 076eeefd2..2c762f54c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:4 ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnLoginId](./ScreenMembersOnLoginId)'> -> **screen**: [`ScreenMembersOnLoginId`](./ScreenMembersOnLoginId) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId">ScreenMembersOnLoginId</a>}> +> **screen**: [`ScreenMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:49 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembersOnLoginId](./TransactionMembersOnLoginId)'> -> **transaction**: [`TransactionMembersOnLoginId`](./TransactionMembersOnLoginId) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId">TransactionMembersOnLoginId</a>}> +> **transaction**: [`TransactionMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:50 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:5 **payload** -[`LoginOptions`](./LoginOptions) +[`LoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:5 **payload** -[`FederatedLoginOptions`](./FederatedLoginOptions) +[`FederatedLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginOptions) **Returns** @@ -153,7 +153,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:5 **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -170,7 +170,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:5 **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -179,11 +179,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:5 </ParamField> <ParamField body='getLoginIdentifiers()' type='unknown'> -> **getLoginIdentifiers**(): [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +> **getLoginIdentifiers**(): [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:55 **Returns** -[`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +[`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers.mdx index 335f1d8e6..7d9f09da2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers.mdx @@ -8,106 +8,106 @@ Login screen members interface extending base members ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnLogin](./ScreenMembersOnLogin)'> -> **screen**: [`ScreenMembersOnLogin`](./ScreenMembersOnLogin) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin">ScreenMembersOnLogin</a>}> +> **screen**: [`ScreenMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:74 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembersOnLogin](./TransactionMembersOnLogin)'> -> **transaction**: [`TransactionMembersOnLogin`](./TransactionMembersOnLogin) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin">TransactionMembersOnLogin</a>}> +> **transaction**: [`TransactionMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:75 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -123,7 +123,7 @@ Performs login with username/password **payload** -[`LoginPayloadOptions`](./LoginPayloadOptions) +[`LoginPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPayloadOptions) The login options @@ -144,7 +144,7 @@ Performs login with social provider **payload** -[`FederatedLoginPayloadOptions`](./FederatedLoginPayloadOptions) +[`FederatedLoginPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPayloadOptions) The social login options @@ -165,7 +165,7 @@ Picks country code for phone number input **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options @@ -176,7 +176,7 @@ Optional custom options </ParamField> <ParamField body='getLoginIdentifiers()' type='unknown'> -> **getLoginIdentifiers**(): [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +> **getLoginIdentifiers**(): [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:96 @@ -184,7 +184,7 @@ Gets the active identifier types for the login screen **Returns** -[`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +[`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` An array of active identifier types or null if none are active diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers.mdx index 7c0ef33e6..49da878f2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password. ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnLoginPassword](./ScreenMembersOnLoginPassword)'> -> **screen**: [`ScreenMembersOnLoginPassword`](./ScreenMembersOnLoginPassword) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword">ScreenMembersOnLoginPassword</a>}> +> **screen**: [`ScreenMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:46 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembersOnLoginPassword](./TransactionMembersOnLoginPassword)'> -> **transaction**: [`TransactionMembersOnLoginPassword`](./TransactionMembersOnLoginPassword) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword">TransactionMembersOnLoginPassword</a>}> +> **transaction**: [`TransactionMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:47 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password. **payload** -[`LoginPasswordOptions`](./LoginPasswordOptions) +[`LoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password. **payload** -[`FederatedLoginPasswordOptions`](./FederatedLoginPasswordOptions) +[`FederatedLoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPasswordOptions) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers.mdx index 9ed0057c3..a105a0835 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnLoginPasswordlessEmailCode](./ScreenMembersOnLoginPasswordlessEmailCode)'> -> **screen**: [`ScreenMembersOnLoginPasswordlessEmailCode`](./ScreenMembersOnLoginPasswordlessEmailCode) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode">ScreenMembersOnLoginPasswordlessEmailCode</a>}> +> **screen**: [`ScreenMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:24 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembersOnLoginPasswordlessEmailCode](./TransactionMembersOnLoginPasswordlessEmailCode)'> -> **transaction**: [`TransactionMembersOnLoginPasswordlessEmailCode`](./TransactionMembersOnLoginPasswordlessEmailCode) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode">TransactionMembersOnLoginPasswordlessEmailCode</a>}> +> **transaction**: [`TransactionMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:25 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl **payload** -[`SubmitCodeOptions`](./SubmitCodeOptions) +[`SubmitCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -145,7 +145,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl </ParamField> <ParamField body='resendManager()' type='unknown'> -> **resendManager**(`options?`): [`ResendControl`](./ResendControl) +> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:28 @@ -153,9 +153,9 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl **options?** -[`StartResendOptions`](./StartResendOptions) +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) **Returns** -[`ResendControl`](./ResendControl) +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers.mdx index 18b2472cd..dfe51c137 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnLoginPasswordlessSmsOtp](./ScreenMembersOnLoginPasswordlessSmsOtp)'> -> **screen**: [`ScreenMembersOnLoginPasswordlessSmsOtp`](./ScreenMembersOnLoginPasswordlessSmsOtp) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp">ScreenMembersOnLoginPasswordlessSmsOtp</a>}> +> **screen**: [`ScreenMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:32 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembersOnLoginPasswordlessSmsOtp](./TransactionMembersOnLoginPasswordlessSmsOtp)'> -> **transaction**: [`TransactionMembersOnLoginPasswordlessSmsOtp`](./TransactionMembersOnLoginPasswordlessSmsOtp) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp">TransactionMembersOnLoginPasswordlessSmsOtp</a>}> +> **transaction**: [`TransactionMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:33 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl **payload** -[`SubmitOTPOptions`](./SubmitOTPOptions) +[`SubmitOTPOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitOTPOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -145,7 +145,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl </ParamField> <ParamField body='resendManager()' type='unknown'> -> **resendManager**(`options?`): [`ResendControl`](./ResendControl) +> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:40 @@ -155,11 +155,11 @@ Gets resend functionality with timeout management for this screen **options?** -[`StartResendOptions`](./StartResendOptions) +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) Configuration options for resend functionality **Returns** -[`ResendControl`](./ResendControl) +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers.mdx index 695e499ff..c6c5e0457 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers.mdx @@ -8,104 +8,104 @@ Interface defining the available methods and properties for the logout-aborted s ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 **Inherited from** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers.mdx index 98c1b6bf0..8c8aef35c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers.mdx @@ -8,104 +8,104 @@ Interface defining the available methods and properties for the logout-complete ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 **Inherited from** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers.mdx index e20bb4080..4c2caac05 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the logout screen ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 **Inherited from** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) **Methods** </ParamField> @@ -123,7 +123,7 @@ Confirms the logout action (accept or deny) **payload** -[`ConfirmLogoutOptions`](./ConfirmLogoutOptions) +[`ConfirmLogoutOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions) The options containing the action to perform diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers.mdx index 9de56c8ce..6bf1bc610 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers.mdx @@ -8,106 +8,106 @@ MFA Begin Enroll Options screen members interface ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 **Inherited from** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) **Methods** </ParamField> @@ -123,7 +123,7 @@ Continues the enrollment process with the selected factor **payload** -[`MfaEnrollOptions`](./MfaEnrollOptions) +[`MfaEnrollOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions) The enrollment options including the selected factor diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers.mdx index e9f9476d7..1ca02bc68 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the mfa-country-code ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaCountryCodes](./ScreenMembersOnMfaCountryCodes)'> -> **screen**: [`ScreenMembersOnMfaCountryCodes`](./ScreenMembersOnMfaCountryCodes) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes">ScreenMembersOnMfaCountryCodes</a>}> +> **screen**: [`ScreenMembersOnMfaCountryCodes`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-country-codes.d.ts:28 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -123,7 +123,7 @@ Selects a country code from the available options **payload** -[`SelectCountryCodeOptions`](./SelectCountryCodeOptions) +[`SelectCountryCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectCountryCodeOptions) The options containing the country code selection action @@ -144,7 +144,7 @@ Navigates back to the previous screen **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx index 4a770fed5..b1a9f7a57 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the mfa-detect-brows ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 **Inherited from** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) **Methods** </ParamField> @@ -123,7 +123,7 @@ Picks an authenticator based on browser capabilities **payload** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) The options containing browser capability flags diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers.mdx index ace7db102..8e1994b54 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the mfa-email-challe ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaEmailChallenge](./ScreenMembersOnMfaEmailChallenge)'> -> **screen**: [`ScreenMembersOnMfaEmailChallenge`](./ScreenMembersOnMfaEmailChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge">ScreenMembersOnMfaEmailChallenge</a>}> +> **screen**: [`ScreenMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:52 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembersOnMfaEmailChallenge](./UntrustedDataMembersOnMfaEmailChallenge)'> -> **untrustedData**: [`UntrustedDataMembersOnMfaEmailChallenge`](./UntrustedDataMembersOnMfaEmailChallenge) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge">UntrustedDataMembersOnMfaEmailChallenge</a>}> +> **untrustedData**: [`UntrustedDataMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:53 **Overrides** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) **Methods** </ParamField> @@ -123,7 +123,7 @@ Continues with the email challenge using the provided code **payload** -[`ContinuePayloadOptions`](./ContinuePayloadOptions) +[`ContinuePayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinuePayloadOptions) The options containing the code and rememberDevice flag @@ -144,7 +144,7 @@ Resends the email code **payload?** -[`ResendCodePayloadOptions`](./ResendCodePayloadOptions) +[`ResendCodePayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodePayloadOptions) Optional custom options to include with the request @@ -165,7 +165,7 @@ Allows the user to try another MFA method **payload?** -[`TryAnotherMethodPayloadOptions`](./TryAnotherMethodPayloadOptions) +[`TryAnotherMethodPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodPayloadOptions) Optional custom options to include with the request @@ -186,7 +186,7 @@ Submits the action to pick a different Email configuration, if available **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request @@ -197,7 +197,7 @@ Optional custom options to include with the request </ParamField> <ParamField body='resendManager()' type='unknown'> -> **resendManager**(`options?`): [`ResendControl`](./ResendControl) +> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:78 @@ -207,11 +207,11 @@ Gets resend functionality with timeout management for this screen **options?** -[`StartResendOptions`](./StartResendOptions) +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) Configuration options for resend functionality **Returns** -[`ResendControl`](./ResendControl) +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers.mdx index 3d9c01657..d0b790e04 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the mfa-email-list s ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaEmailList](./ScreenMembersOnMfaEmailList)'> -> **screen**: [`ScreenMembersOnMfaEmailList`](./ScreenMembersOnMfaEmailList) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList">ScreenMembersOnMfaEmailList</a>}> +> **screen**: [`ScreenMembersOnMfaEmailList`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-list.d.ts:29 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -123,7 +123,7 @@ Selects an enrolled email address from the list **payload** -[`SelectMfaEmailOptions`](./SelectMfaEmailOptions) +[`SelectMfaEmailOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaEmailOptions) The options containing the selection action @@ -144,7 +144,7 @@ Navigates back to the previous screen **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions.mdx index 0dff70c94..6164b4920 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions.mdx @@ -14,8 +14,8 @@ Any additional custom options ## Properties -<ParamField body='action' type='[MfaEnrollFactorType](../type-aliases/MfaEnrollFactorType)'> -> **action**: [`MfaEnrollFactorType`](../type-aliases/MfaEnrollFactorType) +<ParamField body='action' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaEnrollFactorType">MfaEnrollFactorType</a>}> +> **action**: [`MfaEnrollFactorType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaEnrollFactorType) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-begin-enroll-options.d.ts:8 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers.mdx index b74bc429e..a2d9ed5c6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers.mdx @@ -8,100 +8,100 @@ MfaEnrollResultMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaEnrollResult](./ScreenMembersOnMfaEnrollResult)'> -> **screen**: [`ScreenMembersOnMfaEnrollResult`](./ScreenMembersOnMfaEnrollResult) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult">ScreenMembersOnMfaEnrollResult</a>}> +> **screen**: [`ScreenMembersOnMfaEnrollResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-enroll-result.d.ts:49 @@ -109,5 +109,5 @@ Screen-specific data, including enrollment status. **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers.mdx index b4063febb..f9712e418 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the mfa-login-option ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaLoginOptions](./ScreenMembersOnMfaLoginOptions)'> -> **screen**: [`ScreenMembersOnMfaLoginOptions`](./ScreenMembersOnMfaLoginOptions) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions">ScreenMembersOnMfaLoginOptions</a>}> +> **screen**: [`ScreenMembersOnMfaLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-login-options.d.ts:27 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -123,7 +123,7 @@ Continues the login process with the selected MFA factor **payload** -[`LoginEnrollOptions`](./LoginEnrollOptions) +[`LoginEnrollOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions) The options containing the selected factor @@ -153,7 +153,7 @@ Returns to the previous screen in the authentication flow **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers.mdx index 730bdb507..f6e00c270 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the mfa-otp-challeng ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaOtpChallenge](./ScreenMembersOnMfaOtpChallenge)'> -> **screen**: [`ScreenMembersOnMfaOtpChallenge`](./ScreenMembersOnMfaOtpChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge">ScreenMembersOnMfaOtpChallenge</a>}> +> **screen**: [`ScreenMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:42 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembersOnMfaOtpChallenge](./UntrustedDataMembersOnMfaOtpChallenge)'> -> **untrustedData**: [`UntrustedDataMembersOnMfaOtpChallenge`](./UntrustedDataMembersOnMfaOtpChallenge) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge">UntrustedDataMembersOnMfaOtpChallenge</a>}> +> **untrustedData**: [`UntrustedDataMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:43 **Overrides** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) **Methods** </ParamField> @@ -123,7 +123,7 @@ Continues with the OTP challenge using the provided code **payload** -[`ContinueOTPOptions`](./ContinueOTPOptions) +[`ContinueOTPOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOTPOptions) The options containing the code and rememberDevice flag @@ -144,7 +144,7 @@ Allows the user to try another MFA method **payload?** -[`TryAnotherMethodMfaOtpChallengeOptions`](./TryAnotherMethodMfaOtpChallengeOptions) +[`TryAnotherMethodMfaOtpChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodMfaOtpChallengeOptions) Optional custom options to include with the request diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers.mdx index 802359bd2..ba23c8bc6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers.mdx @@ -8,100 +8,100 @@ Interface defining the available methods and properties for the mfa-otp-enrollme ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaOtpEnrollmentCode](./ScreenMembersOnMfaOtpEnrollmentCode)'> -> **screen**: [`ScreenMembersOnMfaOtpEnrollmentCode`](./ScreenMembersOnMfaOtpEnrollmentCode) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode">ScreenMembersOnMfaOtpEnrollmentCode</a>}> +> **screen**: [`ScreenMembersOnMfaOtpEnrollmentCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-code.d.ts:43 @@ -109,7 +109,7 @@ The screen properties for the mfa-otp-enrollment-code screen. **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -125,7 +125,7 @@ Continues the MFA OTP enrollment process by submitting the OTP code. **payload** -[`MfaOtpContinueOptions`](./MfaOtpContinueOptions) +[`MfaOtpContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpContinueOptions) The options containing the OTP code. @@ -146,7 +146,7 @@ Allows the user to try another MFA method. **payload?** -[`MfaOtpTryAnotherMethodOptions`](./MfaOtpTryAnotherMethodOptions) +[`MfaOtpTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpTryAnotherMethodOptions) Optional custom options to include with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx index 87a3e12e6..24717279d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx @@ -8,7 +8,7 @@ Interface for the payload of the continue method ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers.mdx index 34b9e8e35..2f36af8ae 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the mfa-otp-enrollme ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaOtpEnrollmentQr](./ScreenMembersOnMfaOtpEnrollmentQr)'> -> **screen**: [`ScreenMembersOnMfaOtpEnrollmentQr`](./ScreenMembersOnMfaOtpEnrollmentQr) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr">ScreenMembersOnMfaOtpEnrollmentQr</a>}> +> **screen**: [`ScreenMembersOnMfaOtpEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-qr.d.ts:23 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -123,7 +123,7 @@ Toggles the view. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request @@ -144,7 +144,7 @@ Continues with the default action. **payload** -[`MfaOtpEnrollmentQrContinueOptions`](./MfaOtpEnrollmentQrContinueOptions) +[`MfaOtpEnrollmentQrContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions) Payload containing code and optional custom options @@ -165,7 +165,7 @@ Allows trying another authentication method **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions.mdx index 01d391f8d..0c6e39319 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions.mdx @@ -10,7 +10,7 @@ This typically involves selecting the method (SMS or Voice) to receive the verif ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers.mdx index 849b961fd..da37da928 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers.mdx @@ -8,106 +8,106 @@ MfaPhoneChallengeMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaPhoneChallenge](./ScreenMembersOnMfaPhoneChallenge)'> -> **screen**: [`ScreenMembersOnMfaPhoneChallenge`](./ScreenMembersOnMfaPhoneChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge">ScreenMembersOnMfaPhoneChallenge</a>}> +> **screen**: [`ScreenMembersOnMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:62 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -125,7 +125,7 @@ This will trigger sending the verification code to the user's phone. **payload** -[`MfaPhoneChallengeContinueOptions`](./MfaPhoneChallengeContinueOptions) +[`MfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions) The options specifying the delivery type ('sms' or 'voice'). @@ -168,7 +168,7 @@ This typically redirects the user to a screen where they can select from multipl **payload?** -[`MfaPhoneChallengePickPhoneOptions`](./MfaPhoneChallengePickPhoneOptions) +[`MfaPhoneChallengePickPhoneOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions) Optional custom options to include with the request. @@ -206,7 +206,7 @@ This redirects the user to a screen where they can choose an alternative MFA met **payload?** -[`MfaPhoneChallengePickAuthenticatorOptions`](./MfaPhoneChallengePickAuthenticatorOptions) +[`MfaPhoneChallengePickAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions) Optional custom options to include with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx index 307dec8ee..b091a2dac 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx @@ -10,7 +10,7 @@ This allows the user to choose a different MFA method if available. ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions.mdx index 8c05c431e..b5b37e6be 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions.mdx @@ -11,7 +11,7 @@ in scenarios where the server needs to redirect to a phone selection screen. ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions.mdx index 3b9a113b7..c315657b5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions.mdx @@ -10,7 +10,7 @@ Extends `CustomOptions` to allow passing custom options alongside phone and type ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers.mdx index 6c1a2eb55..3a4d0461a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrol ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:18 **Overrides** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:19 **Overrides** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:20 **Overrides** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:21 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:22 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -121,7 +121,7 @@ Selects the country code for the phone number. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. @@ -142,7 +142,7 @@ Continues the enrollment process with the provided phone number and type (SMS or **payload** -[`MfaPhoneEnrollmentContinueOptions`](./MfaPhoneEnrollmentContinueOptions) +[`MfaPhoneEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions) The phone number, type, and optional custom options. @@ -163,7 +163,7 @@ Allows the user to try another MFA method. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult.mdx index e9db5c3cc..760c2e5b8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult.mdx @@ -4,7 +4,7 @@ title: "MfaPollingResult" Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L17) -Result object returned by [useMfaPolling](../../Hooks/functions/useMfaPolling). +Result object returned by [useMfaPolling](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useMfaPolling). ## Properties diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers.mdx index d79a136a9..e475dd164 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the mfa-push-challen ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaPushChallengePush](./ScreenMembersOnMfaPushChallengePush)'> -> **screen**: [`ScreenMembersOnMfaPushChallengePush`](./ScreenMembersOnMfaPushChallengePush) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush">ScreenMembersOnMfaPushChallengePush</a>}> +> **screen**: [`ScreenMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:32 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembersOnMfaPushChallengePush](./UntrustedDataMembersOnMfaPushChallengePush)'> -> **untrustedData**: [`UntrustedDataMembersOnMfaPushChallengePush`](./UntrustedDataMembersOnMfaPushChallengePush) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush">UntrustedDataMembersOnMfaPushChallengePush</a>}> +> **untrustedData**: [`UntrustedDataMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:33 **Overrides** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) **Methods** </ParamField> @@ -123,7 +123,7 @@ Continues with the push notification challenge **payload?** -[`WithRememberOptions`](./WithRememberOptions) +[`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions) Optional custom options to include with the request @@ -144,7 +144,7 @@ Resends the push notification **payload?** -[`WithRememberOptions`](./WithRememberOptions) +[`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions) Optional custom options to include with the request @@ -165,7 +165,7 @@ Switches to entering the verification code manually **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request @@ -186,7 +186,7 @@ Allows trying another authentication method **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request @@ -197,7 +197,7 @@ Optional custom options to include with the request </ParamField> <ParamField body='pollingManager()' type='unknown'> -> **pollingManager**(`options`): [`MfaPushPollingControl`](./MfaPushPollingControl) +> **pollingManager**(`options`): [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:59 @@ -207,13 +207,13 @@ Manages polling for MFA push challenge status **options** -[`MfaPollingOptions`](../type-aliases/MfaPollingOptions) +[`MfaPollingOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions) -Configuration options for polling of type [MfaPollingOptions](../type-aliases/MfaPollingOptions) +Configuration options for polling of type [MfaPollingOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions) **Returns** -[`MfaPushPollingControl`](./MfaPushPollingControl) +[`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl) An object to control the polling process </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers.mdx index 9f0cd061b..8c31637db 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the mfa-push-enrollm ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaPushEnrollmentQr](./ScreenMembersOnMfaPushEnrollmentQr)'> -> **screen**: [`ScreenMembersOnMfaPushEnrollmentQr`](./ScreenMembersOnMfaPushEnrollmentQr) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr">ScreenMembersOnMfaPushEnrollmentQr</a>}> +> **screen**: [`ScreenMembersOnMfaPushEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-enrollment-qr.d.ts:19 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -123,7 +123,7 @@ Navigates to the authenticator selection screen. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request @@ -134,7 +134,7 @@ Optional custom options to include with the request </ParamField> <ParamField body='pollingManager()' type='unknown'> -> **pollingManager**(`options`): [`MfaPushPollingControl`](./MfaPushPollingControl) +> **pollingManager**(`options`): [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-enrollment-qr.d.ts:25 @@ -142,9 +142,9 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-enroll **options** -[`MfaPollingOptions`](../type-aliases/MfaPollingOptions) +[`MfaPollingOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions) **Returns** -[`MfaPushPollingControl`](./MfaPushPollingControl) +[`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers.mdx index ccd63733b..656e82b14 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the mfa-push-list sc ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 **Inherited from** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) **Methods** </ParamField> @@ -123,7 +123,7 @@ Selects a registered device from the list to initiate MFA push. **payload** -[`SelectMfaPushDeviceOptions`](./SelectMfaPushDeviceOptions) +[`SelectMfaPushDeviceOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaPushDeviceOptions) The options containing the device index. @@ -144,7 +144,7 @@ Navigates back to the previous screen. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers.mdx index 8deb0f188..2155d7c5b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcom ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaPushWelcome](./ScreenMembersOnMfaPushWelcome)'> -> **screen**: [`ScreenMembersOnMfaPushWelcome`](./ScreenMembersOnMfaPushWelcome) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome">ScreenMembersOnMfaPushWelcome</a>}> +> **screen**: [`ScreenMembersOnMfaPushWelcome`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcome.d.ts:17 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcom **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcom **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx index 18b7f7023..433319a09 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx @@ -8,7 +8,7 @@ Options for continuing with the MFA Recovery Code Challenge. ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers.mdx index 20f235fa0..7af7a0879 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers.mdx @@ -8,106 +8,106 @@ Interface describing the members of the Mfa Recovery Code Challenge screen. ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:18 **Overrides** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:19 **Overrides** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:20 **Overrides** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:21 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:22 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -123,7 +123,7 @@ Continues with the provided recovery code. **payload** -[`MfaRecoveryCodeChallengeContinueOptions`](./MfaRecoveryCodeChallengeContinueOptions) +[`MfaRecoveryCodeChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions) The continue options containing the recovery code and optional custom options. @@ -146,7 +146,7 @@ Navigates to the screen where the user can pick another MFA method. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional payload. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx index 6a7fbdc0f..abbbbd2cd 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx @@ -8,7 +8,7 @@ ContinueOptions ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx index 6f00343b2..0fd6aef2b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx @@ -8,100 +8,100 @@ MfaRecoveryCodeChallengeNewCodeMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaRecoveryCodeChallengeNewCode](./ScreenMembersOnMfaRecoveryCodeChallengeNewCode)'> -> **screen**: [`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](./ScreenMembersOnMfaRecoveryCodeChallengeNewCode) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode">ScreenMembersOnMfaRecoveryCodeChallengeNewCode</a>}> +> **screen**: [`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge-new-code.d.ts:45 @@ -110,7 +110,7 @@ Includes the `textCode` which is the recovery code to be displayed. **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -128,7 +128,7 @@ It sends a confirmation to the Auth0 server to proceed to the next step. **payload?** -[`MfaRecoveryCodeChallengeNewCodeContinueOptions`](./MfaRecoveryCodeChallengeNewCodeContinueOptions) +[`MfaRecoveryCodeChallengeNewCodeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions) Optional custom data to include with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx index a694479cb..7f946b603 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-co ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx index 7ae2c0df3..8ecd87f6f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx @@ -8,106 +8,106 @@ Interface describing the members of the Mfa Recovery Code Enrollment screen. ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaRecoveryCodeEnrollment](./ScreenMembersOnMfaRecoveryCodeEnrollment)'> -> **screen**: [`ScreenMembersOnMfaRecoveryCodeEnrollment`](./ScreenMembersOnMfaRecoveryCodeEnrollment) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment">ScreenMembersOnMfaRecoveryCodeEnrollment</a>}> +> **screen**: [`ScreenMembersOnMfaRecoveryCodeEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-enrollment.d.ts:22 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -125,7 +125,7 @@ It redirects to the next screen in the authentication flow. **payload** -[`MfaRecoveryCodeEnrollmentContinueOptions`](./MfaRecoveryCodeEnrollmentContinueOptions) +[`MfaRecoveryCodeEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions) An object containing any custom options. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers.mdx index c376a2bd6..3fb7563f8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challen ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaSmsChallenge](./ScreenMembersOnMfaSmsChallenge)'> -> **screen**: [`ScreenMembersOnMfaSmsChallenge`](./ScreenMembersOnMfaSmsChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge">ScreenMembersOnMfaSmsChallenge</a>}> +> **screen**: [`ScreenMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:31 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembersOnMfaSmsChallenge](./UntrustedDataMembersOnMfaSmsChallenge)'> -> **untrustedData**: [`UntrustedDataMembersOnMfaSmsChallenge`](./UntrustedDataMembersOnMfaSmsChallenge) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge">UntrustedDataMembersOnMfaSmsChallenge</a>}> +> **untrustedData**: [`UntrustedDataMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:32 **Overrides** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challen **payload** -[`MfaSmsChallengeOptions`](./MfaSmsChallengeOptions) +[`MfaSmsChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challen **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -153,7 +153,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challen **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -170,7 +170,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challen **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -187,7 +187,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challen **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -196,7 +196,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challen </ParamField> <ParamField body='resendManager()' type='unknown'> -> **resendManager**(`options?`): [`ResendControl`](./ResendControl) +> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:42 @@ -206,11 +206,11 @@ Gets resend functionality with timeout management for this screen **options?** -[`StartResendOptions`](./StartResendOptions) +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) Configuration options for resend functionality **Returns** -[`ResendControl`](./ResendControl) +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers.mdx index d0d1caec0..52ffa3f85 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollm ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaSmsEnrollment](./ScreenMembersOnMfaSmsEnrollment)'> -> **screen**: [`ScreenMembersOnMfaSmsEnrollment`](./ScreenMembersOnMfaSmsEnrollment) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment">ScreenMembersOnMfaSmsEnrollment</a>}> +> **screen**: [`ScreenMembersOnMfaSmsEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:15 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollm **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -159,7 +159,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollm **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers.mdx index 133241704..246132f70 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers.mdx @@ -9,106 +9,106 @@ Interface defining the members and methods for the MfaSmsList class. ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 **Inherited from** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) **Methods** </ParamField> @@ -124,7 +124,7 @@ Selects a phone number from the list of enrolled phone numbers. **payload?** -[`MfaSmsListOptions`](./MfaSmsListOptions) +[`MfaSmsListOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListOptions) Optional payload for the action. @@ -149,7 +149,7 @@ Navigates back to the previous screen. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional payload for the action. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers.mdx index 9ee681159..de874669f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers.mdx @@ -8,89 +8,89 @@ Interface defining all members and operations available on the MFA Voice Challen ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaVoiceChallenge](./ScreenMembersOnMfaVoiceChallenge)'> -> **screen**: [`ScreenMembersOnMfaVoiceChallenge`](./ScreenMembersOnMfaVoiceChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge">ScreenMembersOnMfaVoiceChallenge</a>}> +> **screen**: [`ScreenMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:52 @@ -98,18 +98,18 @@ Screen-specific properties and data. **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembersOnMfaVoiceChallenge](./UntrustedDataMembersOnMfaVoiceChallenge)'> -> **untrustedData**: [`UntrustedDataMembersOnMfaVoiceChallenge`](./UntrustedDataMembersOnMfaVoiceChallenge) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge">UntrustedDataMembersOnMfaVoiceChallenge</a>}> +> **untrustedData**: [`UntrustedDataMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:53 **Overrides** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) **Methods** </ParamField> @@ -125,7 +125,7 @@ Submits the voice verification code to validate the MFA challenge. **payload** -[`MfaVoiceChallengeContinueOptions`](./MfaVoiceChallengeContinueOptions) +[`MfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeContinueOptions) Object containing the verification code and optional parameters @@ -158,7 +158,7 @@ Navigates to the screen for selecting a different phone number. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom parameters @@ -188,7 +188,7 @@ Switches to SMS verification method instead of voice call. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom parameters @@ -218,7 +218,7 @@ Requests a new voice call with a verification code. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom parameters @@ -248,7 +248,7 @@ Navigates to the screen for selecting an alternative MFA method. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom parameters @@ -268,7 +268,7 @@ mfaVoiceChallenge.tryAnotherMethod(); </ParamField> <ParamField body='resendManager()' type='unknown'> -> **resendManager**(`options?`): [`ResendControl`](./ResendControl) +> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:126 @@ -278,11 +278,11 @@ Gets resend functionality with timeout management for this screen **options?** -[`StartResendOptions`](./StartResendOptions) +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) Configuration options for resend functionality **Returns** -[`ResendControl`](./ResendControl) +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions.mdx index cc399e2a5..84c224b3e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions.mdx @@ -8,7 +8,7 @@ Payload for continuing the MFA Voice Enrollment flow. ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers.mdx index 4dc3cfb45..7a68df77a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers.mdx @@ -8,106 +8,106 @@ Interface describing the members of the Mfa Voice Enrollment screen. ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:18 **Overrides** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:19 **Overrides** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:20 **Overrides** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:21 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:22 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -123,7 +123,7 @@ Continues with the voice enrollment process. **payload** -[`MfaVoiceEnrollmentContinueOptions`](./MfaVoiceEnrollmentContinueOptions) +[`MfaVoiceEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions) The phone number and optional custom options. @@ -146,7 +146,7 @@ Allows trying another authentication method. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options. @@ -169,7 +169,7 @@ Allows picking a country code for the phone number. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx index d898ed637..35634f2a7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx @@ -8,7 +8,7 @@ ContinueOptions ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx index 8b0912154..ec3ec87c4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx @@ -8,100 +8,100 @@ MfaWebAuthnChangeKeyNicknameMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaWebAuthnChangeKeyNickname](./ScreenMembersOnMfaWebAuthnChangeKeyNickname)'> -> **screen**: [`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](./ScreenMembersOnMfaWebAuthnChangeKeyNickname) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname">ScreenMembersOnMfaWebAuthnChangeKeyNickname</a>}> +> **screen**: [`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-change-key-nickname.d.ts:71 @@ -109,7 +109,7 @@ The screen object with MFA WebAuthn Change Key Nickname specific data structure. **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -133,7 +133,7 @@ context will be updated with details about the validation failure. **payload** -[`MfaWebAuthnChangeKeyNicknameContinueOptions`](./MfaWebAuthnChangeKeyNicknameContinueOptions) +[`MfaWebAuthnChangeKeyNicknameContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions) An object containing the `nickname` (string) entered by the user. It can also include any `CustomOptions` for extensibility. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx index f1d85d2a9..bcd1d576b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx @@ -8,100 +8,100 @@ MfaWebAuthnEnrollmentSuccessMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaWebAuthnEnrollmentSuccess](./ScreenMembersOnMfaWebAuthnEnrollmentSuccess)'> -> **screen**: [`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](./ScreenMembersOnMfaWebAuthnEnrollmentSuccess) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess">ScreenMembersOnMfaWebAuthnEnrollmentSuccess</a>}> +> **screen**: [`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-enrollment-success.d.ts:59 @@ -110,7 +110,7 @@ Includes the `nickname` of the enrolled authenticator and its `webauthnType`. **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -127,7 +127,7 @@ This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` end **payload?** -[`WebAuthnEnrollSuccessContinueOptions`](./WebAuthnEnrollSuccessContinueOptions) +[`WebAuthnEnrollSuccessContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions) Optional. An object for `CustomOptions` if any additional parameters need to be sent with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers.mdx index b7829e04e..a2bcb4593 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers.mdx @@ -8,100 +8,100 @@ MfaWebAuthnErrorMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaWebAuthnError](./ScreenMembersOnMfaWebAuthnError)'> -> **screen**: [`ScreenMembersOnMfaWebAuthnError`](./ScreenMembersOnMfaWebAuthnError) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError">ScreenMembersOnMfaWebAuthnError</a>}> +> **screen**: [`ScreenMembersOnMfaWebAuthnError`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-error.d.ts:47 @@ -109,7 +109,7 @@ The screen object with MFA WebAuthn Error specific data structure. **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -126,7 +126,7 @@ This typically redirects the user back to the screen where the WebAuthn operatio **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. @@ -161,7 +161,7 @@ This is typically available if the primary authentication or a previous step inv **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. @@ -196,7 +196,7 @@ This navigates the user to an authenticator selection screen. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. @@ -231,7 +231,7 @@ This action is typically used in enrollment scenarios where the user decides not **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx index d2516981b..d8ae7dd2d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx @@ -8,106 +8,106 @@ MfaWebAuthnNotAvailableErrorMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 **Inherited from** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) **Methods** </ParamField> @@ -125,7 +125,7 @@ from other available/enrolled MFA factors. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom parameters to be sent with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx index e9f7f4570..ac789fa13 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx @@ -8,100 +8,100 @@ MfaWebAuthnPlatformChallengeMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaWebAuthnPlatformChallenge](./ScreenMembersOnMfaWebAuthnPlatformChallenge)'> -> **screen**: [`ScreenMembersOnMfaWebAuthnPlatformChallenge`](./ScreenMembersOnMfaWebAuthnPlatformChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge">ScreenMembersOnMfaWebAuthnPlatformChallenge</a>}> +> **screen**: [`ScreenMembersOnMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:80 @@ -109,7 +109,7 @@ Screen-specific properties and data, including WebAuthn challenge options and re **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -131,7 +131,7 @@ it's recommended to call `reportBrowserError` with the error details. **options?** -[`VerifyPlatformAuthenticatorOptions`](./VerifyPlatformAuthenticatorOptions) +[`VerifyPlatformAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions) Optional parameters for the verification process, such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. @@ -183,7 +183,7 @@ It submits the error details with `action: "showError::{errorDetailsJsonString}" **options** -[`MfaWebAuthnPlatformChallengeReportErrorOptions`](./MfaWebAuthnPlatformChallengeReportErrorOptions) +[`MfaWebAuthnPlatformChallengeReportErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions) Contains the `error` object (with `name` and `message` from the WebAuthn API DOMException) and any other custom options. @@ -228,7 +228,7 @@ the user to an MFA factor selection screen. **options?** -[`MfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](./MfaWebAuthnPlatformChallengeTryAnotherMethodOptions) +[`MfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions) Optional custom parameters to be sent with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx index 347fb5b09..933c40187 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx @@ -8,8 +8,8 @@ ReportBrowserErrorOptions ## Properties -<ParamField body='error' type='[WebAuthnErrorDetails](./WebAuthnErrorDetails)'> -> **error**: [`WebAuthnErrorDetails`](./WebAuthnErrorDetails) +<ParamField body='error' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a>}> +> **error**: [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:58 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx index f65802fd8..0e36eb240 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx @@ -8,7 +8,7 @@ TryAnotherMethodOptions ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx index f125e140f..013861bf0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx @@ -8,100 +8,100 @@ MfaWebAuthnPlatformEnrollmentMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaWebAuthnPlatformEnrollment](./ScreenMembersOnMfaWebAuthnPlatformEnrollment)'> -> **screen**: [`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](./ScreenMembersOnMfaWebAuthnPlatformEnrollment) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment">ScreenMembersOnMfaWebAuthnPlatformEnrollment</a>}> +> **screen**: [`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:55 @@ -109,7 +109,7 @@ The screen object with MFA WebAuthn Platform Enrollment specific data structure. **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -127,7 +127,7 @@ This method internally calls `createPasskeyCredentials` (which wraps `navigator. **payload?** -[`SubmitPasskeyCredentialOptions`](./SubmitPasskeyCredentialOptions) +[`SubmitPasskeyCredentialOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions) Optional custom parameters to be sent to the server along with the created credential. @@ -176,7 +176,7 @@ This method sends the error details to the server. **payload** -[`ReportBrowserErrorOptions`](./ReportBrowserErrorOptions) +[`ReportBrowserErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions) The browser error details and any custom options. @@ -217,7 +217,7 @@ This action typically means the user will be reminded to enroll at a later time. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. @@ -252,7 +252,7 @@ This action indicates the user does not want to use a platform authenticator on **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx index bcfc0b5ab..6d4b1ff85 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx @@ -8,100 +8,100 @@ MfaWebAuthnRoamingChallengeMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaWebAuthnRoamingChallenge](./ScreenMembersOnMfaWebAuthnRoamingChallenge)'> -> **screen**: [`ScreenMembersOnMfaWebAuthnRoamingChallenge`](./ScreenMembersOnMfaWebAuthnRoamingChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge">ScreenMembersOnMfaWebAuthnRoamingChallenge</a>}> +> **screen**: [`ScreenMembersOnMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:61 @@ -109,7 +109,7 @@ Screen-specific properties and data, including WebAuthn challenge options. **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -129,7 +129,7 @@ this method will internally call `reportWebAuthnError` to inform Auth0. **options?** -[`VerifySecurityKeyOptions`](./VerifySecurityKeyOptions) +[`VerifySecurityKeyOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions) Optional parameters for the verification process, such as `rememberDevice` and other custom options. @@ -177,7 +177,7 @@ It submits the error details with `action: "showError::{errorDetails}"`. **options** -[`MfaWebAuthnRoamingChallengeReportErrorOptions`](./MfaWebAuthnRoamingChallengeReportErrorOptions) +[`MfaWebAuthnRoamingChallengeReportErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions) Contains the `error` object with `name` and `message` from the WebAuthn API, and any other custom options. @@ -221,7 +221,7 @@ the user to an MFA factor selection screen. **options?** -[`MfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](./MfaWebAuthnRoamingChallengeTryAnotherMethodOptions) +[`MfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions) Optional custom parameters for the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx index 1182954fd..ed0ebf2ed 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx @@ -8,8 +8,8 @@ ReportWebAuthnErrorOptions ## Properties -<ParamField body='error' type='[WebAuthnErrorDetails](./WebAuthnErrorDetails)'> -> **error**: [`WebAuthnErrorDetails`](./WebAuthnErrorDetails) +<ParamField body='error' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a>}> +> **error**: [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:40 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx index 72dd5b27e..988670804 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx @@ -8,7 +8,7 @@ TryAnotherMethodOptions ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx index a63892587..4d88422f8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the mfa-webauthn-roa ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnMfaWebAuthnRoamingEnrollment](./ScreenMembersOnMfaWebAuthnRoamingEnrollment)'> -> **screen**: [`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](./ScreenMembersOnMfaWebAuthnRoamingEnrollment) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment">ScreenMembersOnMfaWebAuthnRoamingEnrollment</a>}> +> **screen**: [`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:37 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -124,7 +124,7 @@ This corresponds to the user interacting with the FIDO Security Keys prompt. **payload** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. @@ -165,7 +165,7 @@ This is used when the browser's WebAuthn API encounters an error. **payload** -[`ShowErrorOptions`](./ShowErrorOptions) +[`ShowErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions) The options containing the error details. @@ -207,7 +207,7 @@ This corresponds to the "Try Another Method" button. **payload?** -[`MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions`](./MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions) +[`MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions) Optional custom options to include with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers.mdx index a15dcd6b0..a2848870a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers.mdx @@ -34,8 +34,8 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.t </ParamField> -<ParamField body='branding' type='[Branding](./Branding) '> -> **branding**: [`Branding`](./Branding) \| `null` +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding">Branding</a> }> +> **branding**: [`Branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:29 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers.mdx index b5450e5a1..aa7fb365f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the organization-pic ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 **Inherited from** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) **Methods** </ParamField> @@ -150,7 +150,7 @@ Skips the organization selection, proceeding with the user's personal account. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers.mdx index d2b3ae2b7..75708a22d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers.mdx @@ -8,100 +8,100 @@ Interface defining the available methods and properties for the organization-sel ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnOrganizationSelection](./ScreenMembersOnOrganizationSelection)'> -> **screen**: [`ScreenMembersOnOrganizationSelection`](./ScreenMembersOnOrganizationSelection) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection">ScreenMembersOnOrganizationSelection</a>}> +> **screen**: [`ScreenMembersOnOrganizationSelection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:39 @@ -109,7 +109,7 @@ The screen properties. **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -125,7 +125,7 @@ Continues with the selected organization name. **payload** -[`ContinueWithOrganizationNameOptions`](./ContinueWithOrganizationNameOptions) +[`ContinueWithOrganizationNameOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithOrganizationNameOptions) The options containing the organization name. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations.mdx index 737d068ec..3a20f4020 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations.mdx @@ -27,8 +27,8 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:31 </ParamField> -<ParamField body='branding' type='[Branding](./Branding)'> -> **branding**: [`Branding`](./Branding) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding">Branding</a>}> +> **branding**: [`Branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:32 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions.mdx index 884df05ed..483f7ab42 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-otp-chall ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse.mdx index 8356973c6..c167994ad 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse.mdx @@ -34,8 +34,8 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:23 </ParamField> -<ParamField body='response' type='[CredentialResponse](./CredentialResponse)'> -> **response**: [`CredentialResponse`](./CredentialResponse) +<ParamField body='response' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CredentialResponse">CredentialResponse</a>}> +> **response**: [`CredentialResponse`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CredentialResponse) Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:24 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers.mdx index 9ed4fe200..fa24731d3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollm ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnPasskeyEnrollmentLocal](./ScreenMembersOnPasskeyEnrollmentLocal)'> -> **screen**: [`ScreenMembersOnPasskeyEnrollmentLocal`](./ScreenMembersOnPasskeyEnrollmentLocal) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal">ScreenMembersOnPasskeyEnrollmentLocal</a>}> +> **screen**: [`ScreenMembersOnPasskeyEnrollmentLocal`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment-local.d.ts:23 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollm **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollm **payload** -[`AbortEnrollmentOptions`](./AbortEnrollmentOptions) +[`AbortEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AbortEnrollmentOptions) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers.mdx index e99fbc12e..f0c220921 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollm ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnPasskeyEnrollment](./ScreenMembersOnPasskeyEnrollment)'> -> **screen**: [`ScreenMembersOnPasskeyEnrollment`](./ScreenMembersOnPasskeyEnrollment) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment">ScreenMembersOnPasskeyEnrollment</a>}> +> **screen**: [`ScreenMembersOnPasskeyEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:21 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollm **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollm **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy.mdx index 3c1681902..14a685abc 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy.mdx @@ -27,8 +27,8 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='passwordSecurityInfo?' type='[PasswordComplexityRule](./PasswordComplexityRule)[]'> -> `optional` **passwordSecurityInfo**: [`PasswordComplexityRule`](./PasswordComplexityRule)[] +<ParamField body='passwordSecurityInfo?' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule">PasswordComplexityRule</a>[]}> +> `optional` **passwordSecurityInfo**: [`PasswordComplexityRule`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:55 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult.mdx index d5e7e8375..04244e67c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult.mdx @@ -13,18 +13,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/validate-password Overall outcome of all password policy checks. -`true` only if every rule in [PasswordComplexityRule](./PasswordComplexityRule) has `status` equal to `"valid"`. +`true` only if every rule in [PasswordComplexityRule](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule) has `status` equal to `"valid"`. </ParamField> -<ParamField body='results' type='[PasswordComplexityRule](./PasswordComplexityRule)[]'> -> **results**: [`PasswordComplexityRule`](./PasswordComplexityRule)[] +<ParamField body='results' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule">PasswordComplexityRule</a>[]}> +> **results**: [`PasswordComplexityRule`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/validate-password.d.ts:16 Array of evaluated password rules. -Each item is a [PasswordComplexityRule](./PasswordComplexityRule) whose -[status](./PasswordComplexityRule.md#status) field reflects the +Each item is a [PasswordComplexityRule](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule) whose +[status](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule.md#status) field reflects the computed validation result for that rule. </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers.mdx index 3dcc04829..574735ecb 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnPhoneIdentifierChallenge](./ScreenMembersOnPhoneIdentifierChallenge)'> -> **screen**: [`ScreenMembersOnPhoneIdentifierChallenge`](./ScreenMembersOnPhoneIdentifierChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge">ScreenMembersOnPhoneIdentifierChallenge</a>}> +> **screen**: [`ScreenMembersOnPhoneIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:32 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie **payload** -[`PhoneChallengeOptions`](./PhoneChallengeOptions) +[`PhoneChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneChallengeOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -145,7 +145,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie </ParamField> <ParamField body='resendManager()' type='unknown'> -> **resendManager**(`options?`): [`ResendControl`](./ResendControl) +> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:35 @@ -153,11 +153,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie **options?** -[`StartResendOptions`](./StartResendOptions) +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) **Returns** -[`ResendControl`](./ResendControl) +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) </ParamField> @@ -170,7 +170,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -187,7 +187,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -204,7 +204,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers.mdx index 11563d505..ca0345ee0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnPhoneIdentifierEnrollment](./ScreenMembersOnPhoneIdentifierEnrollment)'> -> **screen**: [`ScreenMembersOnPhoneIdentifierEnrollment`](./ScreenMembersOnPhoneIdentifierEnrollment) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment">ScreenMembersOnPhoneIdentifierEnrollment</a>}> +> **screen**: [`ScreenMembersOnPhoneIdentifierEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:20 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie **payload** -[`PhoneEnrollmentOptions`](./PhoneEnrollmentOptions) +[`PhoneEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers.mdx index 983ca728f..fffab029e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers.mdx @@ -8,106 +8,106 @@ Interface describing the data available on the Redeem Ticket screen. ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/redeem-ticket.d.ts:12 **Overrides** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/redeem-ticket.d.ts:13 **Overrides** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/redeem-ticket.d.ts:14 **Overrides** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/redeem-ticket.d.ts:15 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/redeem-ticket.d.ts:16 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -123,7 +123,7 @@ Performs the default action on the redeem-ticket screen, which usually involves **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload.mdx index adf5c44d9..c68e48606 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload.mdx @@ -11,7 +11,7 @@ for instance, if they did not receive the initial code or if it has expired. ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers.mdx index e7eb76db3..47d180942 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnResetPasswordEmail](./ScreenMembersOnResetPasswordEmail)'> -> **screen**: [`ScreenMembersOnResetPasswordEmail`](./ScreenMembersOnResetPasswordEmail) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail">ScreenMembersOnResetPasswordEmail</a>}> +> **screen**: [`ScreenMembersOnResetPasswordEmail`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-email.d.ts:16 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers.mdx index e3f65ea73..4a2cbf644 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers.mdx @@ -6,104 +6,104 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnResetPasswordError](./ScreenMembersOnResetPasswordError)'> -> **screen**: [`ScreenMembersOnResetPasswordError`](./ScreenMembersOnResetPasswordError) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError">ScreenMembersOnResetPasswordError</a>}> +> **screen**: [`ScreenMembersOnResetPasswordError`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-error.d.ts:15 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers.mdx index bd4920c6d..4ba91d4d2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password. ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnResetPassword](./ScreenMembersOnResetPassword)'> -> **screen**: [`ScreenMembersOnResetPassword`](./ScreenMembersOnResetPassword) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword">ScreenMembersOnResetPassword</a>}> +> **screen**: [`ScreenMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:22 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembersOnResetPassword](./TransactionMembersOnResetPassword)'> -> **transaction**: [`TransactionMembersOnResetPassword`](./TransactionMembersOnResetPassword) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword">TransactionMembersOnResetPassword</a>}> +> **transaction**: [`TransactionMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:23 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password. **payload** -[`ResetPasswordOptions`](./ResetPasswordOptions) +[`ResetPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordOptions) **Returns** @@ -128,7 +128,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password. </ParamField> <ParamField body='validatePassword()' type='unknown'> -> **validatePassword**(`password`): [`PasswordValidationResult`](./PasswordValidationResult) +> **validatePassword**(`password`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:25 @@ -140,5 +140,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password. **Returns** -[`PasswordValidationResult`](./PasswordValidationResult) +[`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx index 09bb1750c..c8ae30456 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the reset-password-m ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnResetPasswordMfaEmailChallenge](./ScreenMembersOnResetPasswordMfaEmailChallenge)'> -> **screen**: [`ScreenMembersOnResetPasswordMfaEmailChallenge`](./ScreenMembersOnResetPasswordMfaEmailChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge">ScreenMembersOnResetPasswordMfaEmailChallenge</a>}> +> **screen**: [`ScreenMembersOnResetPasswordMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:41 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -123,7 +123,7 @@ Continues with the email challenge using the provided code. **payload** -[`ContinueOptions`](./ContinueOptions) +[`ContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOptions) The options containing the code and rememberDevice flag. @@ -144,7 +144,7 @@ Resends the email code. **payload?** -[`ResendCodeOptions`](./ResendCodeOptions) +[`ResendCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptions) Optional custom options to include with the request. @@ -165,7 +165,7 @@ Allows the user to try another MFA method. **payload?** -[`TryAnotherMethodOptions`](./TryAnotherMethodOptions) +[`TryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodOptions) Optional custom options to include with the request. @@ -176,7 +176,7 @@ Optional custom options to include with the request. </ParamField> <ParamField body='resendManager()' type='unknown'> -> **resendManager**(`options?`): [`ResendControl`](./ResendControl) +> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:61 @@ -186,11 +186,11 @@ Gets resend functionality with timeout management for this screen **options?** -[`StartResendOptions`](./StartResendOptions) +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) Configuration options for resend functionality **Returns** -[`ResendControl`](./ResendControl) +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx index 165a7664a..9ececf14d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the reset-password-m ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:26 **Inherited from** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) **Methods** </ParamField> @@ -123,7 +123,7 @@ Continues with the OTP challenge using the provided code. **payload** -[`ResetPasswordMfaOtpChallengeContinueOptions`](./ResetPasswordMfaOtpChallengeContinueOptions) +[`ResetPasswordMfaOtpChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeContinueOptions) The options containing the code. @@ -144,7 +144,7 @@ Allows the user to try another MFA method. **payload?** -[`ResetPasswordMfaOtpChallengeTryAnotherMethodOptions`](./ResetPasswordMfaOtpChallengeTryAnotherMethodOptions) +[`ResetPasswordMfaOtpChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions) Optional custom options to include with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx index 8fda6b068..619501cef 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx @@ -8,7 +8,7 @@ ContinueOptions ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx index 588aeb9d0..4415fea56 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx @@ -8,56 +8,56 @@ ResetPasswordMfaPhoneChallengeMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:68 @@ -65,12 +65,12 @@ Access to client-specific information (e.g., client ID, name). **Overrides** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:73 @@ -78,12 +78,12 @@ Access to organization-specific information, if applicable. **Overrides** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:78 @@ -91,12 +91,12 @@ Access to prompt details (e.g., prompt name). **Overrides** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnResetPasswordMfaPhoneChallenge](./ScreenMembersOnResetPasswordMfaPhoneChallenge)'> -> **screen**: [`ScreenMembersOnResetPasswordMfaPhoneChallenge`](./ScreenMembersOnResetPasswordMfaPhoneChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge">ScreenMembersOnResetPasswordMfaPhoneChallenge</a>}> +> **screen**: [`ScreenMembersOnResetPasswordMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:83 @@ -104,12 +104,12 @@ Access to the specific properties and data of the 'reset-password-mfa-phone-chal **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:88 @@ -117,7 +117,7 @@ Access to the current transaction details (e.g., state, errors). **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -135,7 +135,7 @@ It triggers the Auth0 backend to initiate the code delivery process. **payload** -[`ResetPasswordMfaPhoneChallengeContinueOptions`](./ResetPasswordMfaPhoneChallengeContinueOptions) +[`ResetPasswordMfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions) The options specifying the delivery type ('sms' or 'voice') and any custom data. @@ -177,7 +177,7 @@ This action corresponds to the user clicking a "Try Another Method" button. **payload** -[`ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions`](./ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions) +[`ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions) The options specifying the current challenge type (`sms` or `voice`) and any custom data. The `type` field is necessary to inform the backend which flow the user is navigating away from. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx index e0f666e9f..2f22f9d6f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx @@ -8,7 +8,7 @@ TryAnotherMethodOptions ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx index 48c32fc97..81a18b4dd 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the reset-password-m ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnResetPasswordMfaPushChallengePush](./ScreenMembersOnResetPasswordMfaPushChallengePush)'> -> **screen**: [`ScreenMembersOnResetPasswordMfaPushChallengePush`](./ScreenMembersOnResetPasswordMfaPushChallengePush) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush">ScreenMembersOnResetPasswordMfaPushChallengePush</a>}> +> **screen**: [`ScreenMembersOnResetPasswordMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-push-challenge-push.d.ts:18 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -123,7 +123,7 @@ Continues with the push notification challenge **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request @@ -144,7 +144,7 @@ Resends the push notification **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request @@ -165,7 +165,7 @@ Switches to entering the verification code manually **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request @@ -186,7 +186,7 @@ Allows trying another authentication method **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request @@ -197,7 +197,7 @@ Optional custom options to include with the request </ParamField> <ParamField body='pollingManager()' type='unknown'> -> **pollingManager**(`options?`): [`MfaPushPollingControl`](./MfaPushPollingControl) +> **pollingManager**(`options?`): [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-push-challenge-push.d.ts:43 @@ -207,11 +207,11 @@ Allows polling for the push notification challenge to be approved. **options?** -[`MfaPollingOptions`](../type-aliases/MfaPollingOptions) +[`MfaPollingOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions) -of type [MfaPollingOptions](../type-aliases/MfaPollingOptions) +of type [MfaPollingOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions) **Returns** -[`MfaPushPollingControl`](./MfaPushPollingControl) +[`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx index 299fb00c5..39cc9b614 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx @@ -8,106 +8,106 @@ Interface describing the members of the Mfa Recovery Code Challenge screen. ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-recovery-code-challenge.d.ts:12 **Overrides** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-recovery-code-challenge.d.ts:13 **Overrides** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-recovery-code-challenge.d.ts:14 **Overrides** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-recovery-code-challenge.d.ts:15 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-recovery-code-challenge.d.ts:16 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -129,7 +129,7 @@ The recovery code entered by the user. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional payload. @@ -150,7 +150,7 @@ Navigates to the screen where the user can pick another MFA method. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional payload. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx index fe84992ba..0bf2d8333 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnResetPasswordMfaSmsChallenge](./ScreenMembersOnResetPasswordMfaSmsChallenge)'> -> **screen**: [`ScreenMembersOnResetPasswordMfaSmsChallenge`](./ScreenMembersOnResetPasswordMfaSmsChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge">ScreenMembersOnResetPasswordMfaSmsChallenge</a>}> +> **screen**: [`ScreenMembersOnResetPasswordMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:19 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- **payload** -[`ResetPasswordMfaSmsChallengeOptions`](./ResetPasswordMfaSmsChallengeOptions) +[`ResetPasswordMfaSmsChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -153,7 +153,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -170,7 +170,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -179,7 +179,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- </ParamField> <ParamField body='resendManager()' type='unknown'> -> **resendManager**(`options?`): [`ResendControl`](./ResendControl) +> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:28 @@ -189,11 +189,11 @@ Gets resend functionality with timeout management for this screen **options?** -[`StartResendOptions`](./StartResendOptions) +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) Configuration options for resend functionality **Returns** -[`ResendControl`](./ResendControl) +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx index ca7a48829..67a01ab3a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx @@ -8,7 +8,7 @@ Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers. ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx index b545dc105..6a8ce321a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx @@ -8,106 +8,106 @@ Interface defining the available methods and properties for the reset-password-m ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnResetPasswordMfaVoiceChallenge](./ScreenMembersOnResetPasswordMfaVoiceChallenge)'> -> **screen**: [`ScreenMembersOnResetPasswordMfaVoiceChallenge`](./ScreenMembersOnResetPasswordMfaVoiceChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge">ScreenMembersOnResetPasswordMfaVoiceChallenge</a>}> +> **screen**: [`ScreenMembersOnResetPasswordMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-voice-challenge.d.ts:33 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -123,7 +123,7 @@ Continues with the voice challenge using the provided code. **payload** -[`ResetPasswordMfaVoiceChallengeContinueOptions`](./ResetPasswordMfaVoiceChallengeContinueOptions) +[`ResetPasswordMfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions) The options containing the code. @@ -153,7 +153,7 @@ Switches to SMS verification. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. @@ -176,7 +176,7 @@ Re-sends the code via voice call. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. @@ -199,7 +199,7 @@ Allows the user to try another MFA method. **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) Optional custom options to include with the request. @@ -212,7 +212,7 @@ A promise that resolves when the request is submitted. </ParamField> <ParamField body='resendManager()' type='unknown'> -> **resendManager**(`options?`): [`ResendControl`](./ResendControl) +> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-voice-challenge.d.ts:72 @@ -222,11 +222,11 @@ Gets resend functionality with timeout management for this screen **options?** -[`StartResendOptions`](./StartResendOptions) +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) Configuration options for resend functionality **Returns** -[`ResendControl`](./ResendControl) +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx index 7f17085a2..e94d68b0c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx @@ -8,7 +8,7 @@ ContinueWithPasskeyOptions ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx index 8ece057a9..0a7d69613 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx @@ -8,100 +8,100 @@ ResetPasswordMfaWebAuthnPlatformChallengeMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge](./ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge)'> -> **screen**: [`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](./ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge">ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge</a>}> +> **screen**: [`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:111 @@ -109,7 +109,7 @@ Access to the specific properties and data of the 'reset-password-mfa-webauthn-p **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -127,7 +127,7 @@ If successful, it submits the resulting credential assertion to Auth0 with `acti **options?** -[`ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions`](./ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions) +[`ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions) Optional parameters for the verification process, such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. @@ -180,7 +180,7 @@ It submits the error details with `action: "showError::{errorDetailsJsonString}" **options** -[`ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions`](./ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions) +[`ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions) Contains the `error` object (with `name` and `message` from the WebAuthn API DOMException) and any custom options. @@ -225,7 +225,7 @@ the user to an MFA factor selection screen for the password reset flow. **options?** -[`ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](./ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions) +[`ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions) Optional. Any custom parameters to be sent with the request. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx index 45007ab21..ce2da63c1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx @@ -8,8 +8,8 @@ ReportBrowserErrorOptions ## Properties -<ParamField body='error' type='[WebAuthnErrorDetails](./WebAuthnErrorDetails)'> -> **error**: [`WebAuthnErrorDetails`](./WebAuthnErrorDetails) +<ParamField body='error' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a>}> +> **error**: [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:79 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx index 8e61a5099..0f51be9fe 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx @@ -8,7 +8,7 @@ TryAnotherMethodOptions ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx index 7a8d82e12..04d578c35 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx @@ -8,100 +8,100 @@ ResetPasswordMfaWebAuthnRoamingChallengeMembers ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge](./ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge)'> -> **screen**: [`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](./ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge">ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge</a>}> +> **screen**: [`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:143 @@ -110,7 +110,7 @@ including WebAuthn `publicKey` challenge options and the `showRememberDevice` fl **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) **Methods** </ParamField> @@ -130,7 +130,7 @@ On successful interaction with the security key, it submits the resulting **options?** -[`ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions`](./ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions) +[`ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions) Optional. Parameters for the operation, such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. @@ -166,7 +166,7 @@ It submits the error details with `action: "showError::{errorDetailsJsonString}" **options** -[`ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions`](./ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions) +[`ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions) Contains the `error` object (with `name` and `message` from the WebAuthn API DOMException), an optional `rememberDevice` flag, and any other custom options. @@ -197,7 +197,7 @@ the user to an MFA factor selection screen. **options?** -[`ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](./ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions) +[`ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions) Optional. Parameters for the operation, such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx index 9250276a1..60acfa2b2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx @@ -8,8 +8,8 @@ ShowErrorOptions ## Properties -<ParamField body='error' type='[WebAuthnErrorDetails](./WebAuthnErrorDetails)'> -> **error**: [`WebAuthnErrorDetails`](./WebAuthnErrorDetails) +<ParamField body='error' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a>}> +> **error**: [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:98 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx index 195298bda..ccc59e166 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx @@ -8,7 +8,7 @@ TryAnotherMethodOptions ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx index e8e753f6f..b0cd71551 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx @@ -8,7 +8,7 @@ UseSecurityKeyOptions ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers.mdx index f98c1ff6e..2bdc88c0f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnResetPasswordRequest](./ScreenMembersOnResetPasswordRequest)'> -> **screen**: [`ScreenMembersOnResetPasswordRequest`](./ScreenMembersOnResetPasswordRequest) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest">ScreenMembersOnResetPasswordRequest</a>}> +> **screen**: [`ScreenMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:24 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembersOnResetPasswordRequest](./TransactionMembersOnResetPasswordRequest)'> -> **transaction**: [`TransactionMembersOnResetPasswordRequest`](./TransactionMembersOnResetPasswordRequest) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest">TransactionMembersOnResetPasswordRequest</a>}> +> **transaction**: [`TransactionMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:25 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- **payload** -[`ResetPasswordRequestOptions`](./ResetPasswordRequestOptions) +[`ResetPasswordRequestOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -145,11 +145,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- </ParamField> <ParamField body='getLoginIdentifiers()' type='unknown'> -> **getLoginIdentifiers**(): [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +> **getLoginIdentifiers**(): [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:28 **Returns** -[`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +[`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers.mdx index 0e6b4816a..e30f2c45a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers.mdx @@ -6,104 +6,104 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:28 **Inherited from** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnResetPasswordSuccess](./ScreenMembersOnResetPasswordSuccess)'> -> **screen**: [`ScreenMembersOnResetPasswordSuccess`](./ScreenMembersOnResetPasswordSuccess) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess">ScreenMembersOnResetPasswordSuccess</a>}> +> **screen**: [`ScreenMembersOnResetPasswordSuccess`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-success.d.ts:12 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.mdx index 5cbc199fc..eb9f0adc4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.mdx @@ -6,62 +6,62 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:70 ## Extended by -- [`ScreenMembersOnLoginId`](./ScreenMembersOnLoginId) -- [`ScreenMembersOnLoginPassword`](./ScreenMembersOnLoginPassword) -- [`ScreenMembersOnLoginPasswordlessEmailCode`](./ScreenMembersOnLoginPasswordlessEmailCode) -- [`ScreenMembersOnLoginPasswordlessSmsOtp`](./ScreenMembersOnLoginPasswordlessSmsOtp) -- [`ScreenMembersOnPasskeyEnrollment`](./ScreenMembersOnPasskeyEnrollment) -- [`ScreenMembersOnPasskeyEnrollmentLocal`](./ScreenMembersOnPasskeyEnrollmentLocal) -- [`ScreenMembersOnEmailIdentifierChallenge`](./ScreenMembersOnEmailIdentifierChallenge) -- [`ScreenMembersOnPhoneIdentifierChallenge`](./ScreenMembersOnPhoneIdentifierChallenge) -- [`ScreenMembersOnPhoneIdentifierEnrollment`](./ScreenMembersOnPhoneIdentifierEnrollment) -- [`ScreenMembersOnSignupId`](./ScreenMembersOnSignupId) -- [`ScreenMembersOnSignupPassword`](./ScreenMembersOnSignupPassword) -- [`ScreenMembersOnSignup`](./ScreenMembersOnSignup) -- [`ScreenMembersOnResetPasswordEmail`](./ScreenMembersOnResetPasswordEmail) -- [`ScreenMembersOnResetPasswordRequest`](./ScreenMembersOnResetPasswordRequest) -- [`ScreenMembersOnResetPassword`](./ScreenMembersOnResetPassword) -- [`ScreenMembersOnResetPasswordError`](./ScreenMembersOnResetPasswordError) -- [`ScreenMembersOnResetPasswordSuccess`](./ScreenMembersOnResetPasswordSuccess) -- [`ScreenMembersOnLogin`](./ScreenMembersOnLogin) -- [`ScreenMembersOnMfaPushEnrollmentQr`](./ScreenMembersOnMfaPushEnrollmentQr) -- [`ScreenMembersOnMfaPushWelcome`](./ScreenMembersOnMfaPushWelcome) -- [`ScreenMembersOnMfaEnrollResult`](./ScreenMembersOnMfaEnrollResult) -- [`ScreenMembersOnMfaSmsEnrollment`](./ScreenMembersOnMfaSmsEnrollment) -- [`ScreenMembersOnMfaSmsChallenge`](./ScreenMembersOnMfaSmsChallenge) -- [`ScreenMembersOnMfaCountryCodes`](./ScreenMembersOnMfaCountryCodes) -- [`ScreenMembersOnResetPasswordMfaPushChallengePush`](./ScreenMembersOnResetPasswordMfaPushChallengePush) -- [`ScreenMembersOnResetPasswordMfaEmailChallenge`](./ScreenMembersOnResetPasswordMfaEmailChallenge) -- [`ScreenMembersOnResetPasswordMfaSmsChallenge`](./ScreenMembersOnResetPasswordMfaSmsChallenge) -- [`ScreenMembersOnMfaEmailChallenge`](./ScreenMembersOnMfaEmailChallenge) -- [`ScreenMembersOnMfaEmailList`](./ScreenMembersOnMfaEmailList) -- [`ScreenMembersOnMfaLoginOptions`](./ScreenMembersOnMfaLoginOptions) -- [`ScreenMembersOnMfaPushChallengePush`](./ScreenMembersOnMfaPushChallengePush) -- [`ScreenMembersOnMfaOtpChallenge`](./ScreenMembersOnMfaOtpChallenge) -- [`ScreenMembersOnMfaOtpEnrollmentQr`](./ScreenMembersOnMfaOtpEnrollmentQr) -- [`ScreenMembersOnMfaOtpEnrollmentCode`](./ScreenMembersOnMfaOtpEnrollmentCode) -- [`ScreenMembersOnOrganizationSelection`](./ScreenMembersOnOrganizationSelection) -- [`ScreenMembersOnAcceptInvitation`](./ScreenMembersOnAcceptInvitation) -- [`ScreenMembersOnCustomizedConsent`](./ScreenMembersOnCustomizedConsent) -- [`ScreenMembersOnMfaVoiceChallenge`](./ScreenMembersOnMfaVoiceChallenge) -- [`ScreenMembersOnResetPasswordMfaVoiceChallenge`](./ScreenMembersOnResetPasswordMfaVoiceChallenge) -- [`ScreenMembersOnDeviceCodeConfirmation`](./ScreenMembersOnDeviceCodeConfirmation) -- [`ScreenMembersOnMfaPhoneChallenge`](./ScreenMembersOnMfaPhoneChallenge) -- [`ScreenMembersOnMfaRecoveryCodeEnrollment`](./ScreenMembersOnMfaRecoveryCodeEnrollment) -- [`ScreenMembersOnResetPasswordMfaPhoneChallenge`](./ScreenMembersOnResetPasswordMfaPhoneChallenge) -- [`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](./ScreenMembersOnMfaRecoveryCodeChallengeNewCode) -- [`ScreenMembersOnEmailOTPChallenge`](./ScreenMembersOnEmailOTPChallenge) -- [`ScreenMembersOnEmailVerificationResult`](./ScreenMembersOnEmailVerificationResult) -- [`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](./ScreenMembersOnMfaWebAuthnPlatformEnrollment) -- [`ScreenMembersOnMfaWebAuthnError`](./ScreenMembersOnMfaWebAuthnError) -- [`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](./ScreenMembersOnMfaWebAuthnRoamingEnrollment) -- [`ScreenMembersOnMfaWebAuthnRoamingChallenge`](./ScreenMembersOnMfaWebAuthnRoamingChallenge) -- [`ScreenMembersOnMfaWebAuthnPlatformChallenge`](./ScreenMembersOnMfaWebAuthnPlatformChallenge) -- [`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](./ScreenMembersOnMfaWebAuthnEnrollmentSuccess) -- [`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](./ScreenMembersOnMfaWebAuthnChangeKeyNickname) -- [`ScreenMembersOnConsent`](./ScreenMembersOnConsent) -- [`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](./ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge) -- [`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](./ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge) +- [`ScreenMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId) +- [`ScreenMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword) +- [`ScreenMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode) +- [`ScreenMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp) +- [`ScreenMembersOnPasskeyEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment) +- [`ScreenMembersOnPasskeyEnrollmentLocal`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal) +- [`ScreenMembersOnEmailIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge) +- [`ScreenMembersOnPhoneIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge) +- [`ScreenMembersOnPhoneIdentifierEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment) +- [`ScreenMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId) +- [`ScreenMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword) +- [`ScreenMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup) +- [`ScreenMembersOnResetPasswordEmail`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail) +- [`ScreenMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest) +- [`ScreenMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword) +- [`ScreenMembersOnResetPasswordError`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError) +- [`ScreenMembersOnResetPasswordSuccess`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess) +- [`ScreenMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin) +- [`ScreenMembersOnMfaPushEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr) +- [`ScreenMembersOnMfaPushWelcome`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome) +- [`ScreenMembersOnMfaEnrollResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult) +- [`ScreenMembersOnMfaSmsEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment) +- [`ScreenMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge) +- [`ScreenMembersOnMfaCountryCodes`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes) +- [`ScreenMembersOnResetPasswordMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush) +- [`ScreenMembersOnResetPasswordMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge) +- [`ScreenMembersOnResetPasswordMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge) +- [`ScreenMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge) +- [`ScreenMembersOnMfaEmailList`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList) +- [`ScreenMembersOnMfaLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions) +- [`ScreenMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush) +- [`ScreenMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge) +- [`ScreenMembersOnMfaOtpEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr) +- [`ScreenMembersOnMfaOtpEnrollmentCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode) +- [`ScreenMembersOnOrganizationSelection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection) +- [`ScreenMembersOnAcceptInvitation`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation) +- [`ScreenMembersOnCustomizedConsent`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent) +- [`ScreenMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge) +- [`ScreenMembersOnResetPasswordMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge) +- [`ScreenMembersOnDeviceCodeConfirmation`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation) +- [`ScreenMembersOnMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge) +- [`ScreenMembersOnMfaRecoveryCodeEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment) +- [`ScreenMembersOnResetPasswordMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge) +- [`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode) +- [`ScreenMembersOnEmailOTPChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge) +- [`ScreenMembersOnEmailVerificationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult) +- [`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment) +- [`ScreenMembersOnMfaWebAuthnError`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError) +- [`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment) +- [`ScreenMembersOnMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge) +- [`ScreenMembersOnMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge) +- [`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess) +- [`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname) +- [`ScreenMembersOnConsent`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent) +- [`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge) +- [`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge) ## Properties @@ -101,7 +101,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -121,8 +121,8 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation.mdx index f8496a84d..49bd4b500 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitati ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -72,7 +72,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -83,18 +83,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -105,5 +105,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitati **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent.mdx index fb47952d2..ea9ba8949 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent.mdx @@ -8,7 +8,7 @@ ScreenMembersOnConsent ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,12 +63,12 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -76,7 +76,7 @@ Screen-specific data. **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -98,23 +98,23 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> -<ParamField body='scopes' type='[Scope](./Scope)[]'> -> **scopes**: [`Scope`](./Scope)[] +<ParamField body='scopes' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope">Scope</a>[]}> +> **scopes**: [`Scope`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/consent.d.ts:20 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent.mdx index 954dcbe9c..e5ff88204 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent.mdx @@ -8,7 +8,7 @@ ScreenMembersOnCustomizedConsent ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,12 +63,12 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -76,7 +76,7 @@ Screen-specific data. **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -98,23 +98,23 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> -<ParamField body='scopes' type='[Scope](./Scope)[]'> -> **scopes**: [`Scope`](./Scope)[] +<ParamField body='scopes' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope">Scope</a>[]}> +> **scopes**: [`Scope`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/customized-consent.d.ts:24 @@ -124,8 +124,8 @@ This list should be displayed to the user for their review. </ParamField> -<ParamField body='authorizationDetails' type='[AuthorizationDetail](./AuthorizationDetail)[]'> -> **authorizationDetails**: [`AuthorizationDetail`](./AuthorizationDetail)[] +<ParamField body='authorizationDetails' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AuthorizationDetail">AuthorizationDetail</a>[]}> +> **authorizationDetails**: [`AuthorizationDetail`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AuthorizationDetail)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/customized-consent.d.ts:32 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx index 3c63c891f..2816a6fdf 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx @@ -8,7 +8,7 @@ Interface describing the data available on the Device Code Confirmation screen. ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -107,5 +107,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-con **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx index 3c2b0c43f..8b1874f25 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifie ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -72,7 +72,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -83,18 +83,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -105,5 +105,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifie **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge.mdx index e60676d32..2e52f4325 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge.mdx @@ -9,7 +9,7 @@ Extends the base ScreenMembers interface. ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -20,7 +20,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -31,7 +31,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -42,7 +42,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -53,7 +53,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -64,18 +64,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -86,7 +86,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -97,16 +97,16 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult.mdx index 19e6587ea..893afa2ee 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult.mdx @@ -8,7 +8,7 @@ ScreenMembersOnEmailVerificationResult ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -76,7 +76,7 @@ Navigation links available on this screen. **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -87,18 +87,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -125,7 +125,7 @@ This status should be displayed to the user to inform them of the outcome. **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin.mdx index aedfb7353..b1b997b85 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin.mdx @@ -8,7 +8,7 @@ Extended screen members interface for the login screen ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -121,5 +121,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:21 **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId.mdx index e3653de0e..30a9d7f77 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:2 ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,18 +61,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -83,7 +83,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -94,18 +94,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -123,8 +123,8 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:2 </ParamField> -<ParamField body='publicKey' type='{ challenge: string; allowCredentials?: [AllowCredential](./AllowCredential)[]; } '> -> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](./AllowCredential)[]; \} \| `null` +<ParamField body='publicKey' type={{ challenge: string; allowCredentials?: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential">AllowCredential</a>[]; } }> +> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential)[]; \} \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:29 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword.mdx index f720a4231..76816be4d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password. ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -72,7 +72,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -83,18 +83,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -126,5 +126,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password. **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx index 6cee54fe9..2cf93f805 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -72,7 +72,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -83,18 +83,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -126,5 +126,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx index 6ae468fc3..db1cfd559 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -72,7 +72,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -83,18 +83,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -134,5 +134,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes.mdx index 42937c8ad..4d8d00cd2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes.mdx @@ -8,7 +8,7 @@ Interface for screen data specific to mfa-country-codes screen ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,33 +85,33 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> -<ParamField body='data' type='{ phone_prefixes: [PhonePrefix](./PhonePrefix)[]; } '> -> **data**: \{ `phone_prefixes`: [`PhonePrefix`](./PhonePrefix)[]; \} \| `null` +<ParamField body='data' type={{ phone_prefixes: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[]; } }> +> **data**: \{ `phone_prefixes`: [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[]; \} \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-country-codes.d.ts:8 **Type Declaration** -\{ `phone_prefixes`: [`PhonePrefix`](./PhonePrefix)[]; \} +\{ `phone_prefixes`: [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[]; \} **phone\_prefixes** -> **phone\_prefixes**: [`PhonePrefix`](./PhonePrefix)[] +> **phone\_prefixes**: [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] List of available phone prefixes @@ -119,5 +119,5 @@ List of available phone prefixes **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge.mdx index e5dad8f99..e100a86aa 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge.mdx @@ -8,7 +8,7 @@ Interface for the screen data specific to mfa-email-challenge screen ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -107,5 +107,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-chall **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList.mdx index d913bd03d..3fb892058 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList.mdx @@ -8,7 +8,7 @@ Interface for the screen data specific to mfa-email-list screen ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -119,5 +119,5 @@ List of enrolled email addresses **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult.mdx index a928e1082..93ea37160 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult.mdx @@ -8,7 +8,7 @@ ScreenMembersOnMfaEnrollResult ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -123,5 +123,5 @@ This status can be used to display an appropriate message to the user. **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions.mdx index 99d0ac027..16993ab7c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions.mdx @@ -8,7 +8,7 @@ Interface for the screen data specific to mfa-login-options screen ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -119,5 +119,5 @@ List of enrolled MFA factors for the user **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge.mdx index 96f110aad..d46299992 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge.mdx @@ -8,7 +8,7 @@ Interface for the screen data specific to mfa-otp-challenge screen ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -107,5 +107,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challen **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx index e7f8552a4..d41c09abb 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx @@ -8,7 +8,7 @@ Interface for the screen data specific to the mfa-otp-enrollment-code screen. ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -119,5 +119,5 @@ The text code to display to the user. **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx index c0237e845..29d1ada67 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx @@ -8,7 +8,7 @@ Interface for the screen data specific to mfa-otp-enrollment-qr screen ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -107,5 +107,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollm **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx index bf9e033ef..87b2f0878 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx @@ -8,7 +8,7 @@ ScreenMembersOnMfaPhoneChallenge ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -119,5 +119,5 @@ The phone number (often masked) associated with this MFA challenge. **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush.mdx index 89af22db5..d9ec4db44 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush.mdx @@ -8,7 +8,7 @@ Interface for the screen data specific to mfa-push-challenge-push screen ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -125,5 +125,5 @@ Whether to show the remember device option **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx index 40071adf3..5ebd6d8c9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx @@ -8,7 +8,7 @@ Interface for the screen data specific to mfa-push-enrollment-qr screen ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -107,5 +107,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-enroll **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome.mdx index 906c08112..ca3bc66aa 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcom ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,18 +61,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -83,7 +83,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -94,18 +94,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx index 3045cfb7e..f60c0e1bd 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx @@ -8,7 +8,7 @@ ScreenMembersOnMfaRecoveryCodeChallengeNewCode ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -120,5 +120,5 @@ It is crucial that the user saves this code securely as it will be needed for fu **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx index b76b06e89..f52d2758a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx @@ -8,7 +8,7 @@ Interface describing the data available on the Mfa Recovery Code Enrollment scre ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -119,5 +119,5 @@ The recovery code to display to the user. **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge.mdx index c5a4f8dee..a3f701c59 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge.mdx @@ -8,7 +8,7 @@ Interface for the screen data specific to mfa-sms-challenge screen ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -131,5 +131,5 @@ Whether to show the link to switch to voice call verification **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx index 9b950d939..50795761e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollm ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -72,7 +72,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -83,18 +83,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -105,5 +105,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollm **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx index 4705732cd..548ffafd5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx @@ -8,7 +8,7 @@ Extended screen members interface for the MFA Voice Challenge screen. ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -133,5 +133,5 @@ Whether to show the link to switch to SMS verification. **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx index e6d7abf83..73e8c5620 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx @@ -8,7 +8,7 @@ ScreenMembersOnMfaWebAuthnChangeKeyNickname ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -132,5 +132,5 @@ This value should be displayed to the user for context. **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx index b5d8af987..075760f57 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx @@ -8,7 +8,7 @@ ScreenMembersOnMfaWebAuthnEnrollmentSuccess ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,23 +85,23 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> -<ParamField body='data' type='{ nickname: string; webauthnType: [WebAuthnType](../type-aliases/WebAuthnType); } '> -> **data**: \{ `nickname`: `string`; `webauthnType`: [`WebAuthnType`](../type-aliases/WebAuthnType); \} \| `null` +<ParamField body='data' type={{ nickname: string; webauthnType: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType">WebAuthnType</a>; } }> +> **data**: \{ `nickname`: `string`; `webauthnType`: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType); \} \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-enrollment-success.d.ts:21 @@ -109,7 +109,7 @@ Screen-specific data. **Type Declaration** -\{ `nickname`: `string`; `webauthnType`: [`WebAuthnType`](../type-aliases/WebAuthnType); \} +\{ `nickname`: `string`; `webauthnType`: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType); \} **nickname** @@ -130,7 +130,7 @@ This helps the user identify the authenticator later. **webauthnType** -> **webauthnType**: [`WebAuthnType`](../type-aliases/WebAuthnType) +> **webauthnType**: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType) The type of WebAuthn authenticator that was successfully enrolled. - `'webauthn-roaming'`: Indicates a roaming authenticator like a USB security key. @@ -140,5 +140,5 @@ The type of WebAuthn authenticator that was successfully enrolled. **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError.mdx index a4cdeff8f..5ce784d33 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError.mdx @@ -8,7 +8,7 @@ ScreenMembersOnMfaWebAuthnError ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,29 +85,29 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> -<ParamField body='data' type='{ errorType: string; webauthnType: [WebAuthnType](../type-aliases/WebAuthnType); } '> -> **data**: \{ `errorType`: `string`; `webauthnType`: [`WebAuthnType`](../type-aliases/WebAuthnType); \} \| `null` +<ParamField body='data' type={{ errorType: string; webauthnType: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType">WebAuthnType</a>; } }> +> **data**: \{ `errorType`: `string`; `webauthnType`: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType); \} \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-error.d.ts:26 **Type Declaration** -\{ `errorType`: `string`; `webauthnType`: [`WebAuthnType`](../type-aliases/WebAuthnType); \} +\{ `errorType`: `string`; `webauthnType`: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType); \} **errorType** @@ -117,7 +117,7 @@ A code or message describing the WebAuthn error. **webauthnType** -> **webauthnType**: [`WebAuthnType`](../type-aliases/WebAuthnType) +> **webauthnType**: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType) The type of WebAuthn authenticator involved. @@ -125,5 +125,5 @@ The type of WebAuthn authenticator involved. **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx index 54c733415..68c62f3fe 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx @@ -8,7 +8,7 @@ ScreenMembersOnMfaWebAuthnPlatformChallenge ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,12 +63,12 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -76,7 +76,7 @@ Screen-specific data. **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -98,23 +98,23 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> -<ParamField body='publicKey' type='{ challenge: string; allowCredentials?: [AllowCredential](./AllowCredential)[]; } '> -> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](./AllowCredential)[]; \} \| `null` +<ParamField body='publicKey' type={{ challenge: string; allowCredentials?: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential">AllowCredential</a>[]; } }> +> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential)[]; \} \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:22 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx index 393540ed9..88face9d6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx @@ -8,7 +8,7 @@ ScreenMembersOnMfaWebAuthnPlatformEnrollment ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,18 +63,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -85,7 +85,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -96,18 +96,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx index 7c110b452..2b07c1f5c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx @@ -8,7 +8,7 @@ ScreenMembersOnMfaWebAuthnRoamingChallenge ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,12 +63,12 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -76,7 +76,7 @@ Screen-specific data. **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -98,18 +98,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -127,8 +127,8 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-ro </ParamField> -<ParamField body='publicKey' type='{ challenge: string; allowCredentials?: [AllowCredential](./AllowCredential)[]; } '> -> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](./AllowCredential)[]; \} \| `null` +<ParamField body='publicKey' type={{ challenge: string; allowCredentials?: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential">AllowCredential</a>[]; } }> +> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential)[]; \} \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:19 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx index 29bd555c9..6644d7fe8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx @@ -8,7 +8,7 @@ Interface for screen data specific to mfa-webauthn-roaming-enrollment screen. ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,18 +63,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -85,7 +85,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -96,18 +96,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection.mdx index 9480886d5..292056cc0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection.mdx @@ -8,7 +8,7 @@ Interface for the screen data specific to organization-selection screen. ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,18 +63,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -85,7 +85,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -96,58 +96,58 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:25 </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:26 </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:27 </ParamField> -<ParamField body='screen' type='[ScreenMembers](./ScreenMembers)'> -> **screen**: [`ScreenMembers`](./ScreenMembers) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:28 </ParamField> -<ParamField body='transaction' type='[TransactionMembers](./TransactionMembers)'> -> **transaction**: [`TransactionMembers`](./TransactionMembers) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:29 </ParamField> -<ParamField body='User' type='[UserMembers](./UserMembers)'> -> **User**: [`UserMembers`](./UserMembers) +<ParamField body='User' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **User**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:30 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment.mdx index 27737738d..9b9741354 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollm ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,18 +61,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -83,7 +83,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -94,18 +94,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx index bec471e81..eb55404fa 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollm ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,18 +61,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -83,7 +83,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -94,18 +94,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx index d8c0f16b9..856c8daf1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -72,7 +72,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -83,18 +83,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -105,5 +105,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx index c0b3949d6..28b48899e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -72,7 +72,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -83,18 +83,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -105,7 +105,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword.mdx index 1df488fbf..29134b494 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password. ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -72,7 +72,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -83,18 +83,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -105,5 +105,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password. **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail.mdx index 48a44b713..186872730 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -72,7 +72,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -83,18 +83,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -105,5 +105,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError.mdx index 512ad8517..a712169db 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -72,7 +72,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -83,18 +83,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -105,5 +105,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx index 6145d9ba1..b60e3ce20 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx @@ -8,7 +8,7 @@ Interface for the screen data specific to reset-password-mfa-email-challenge scr ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -107,5 +107,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx index 852b1dabe..68f5f1724 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx @@ -8,7 +8,7 @@ ScreenMembersOnResetPasswordMfaPhoneChallenge ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -119,5 +119,5 @@ The phone number (often masked) associated with this MFA challenge. **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx index 5699f4efc..d595bddc7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx @@ -8,7 +8,7 @@ Interface for the screen data specific to reset-password-mfa-push-challenge-push ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -107,5 +107,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx index fc4237b8c..6713a019c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -72,7 +72,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -83,18 +83,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -121,5 +121,5 @@ Whether to show the link to switch to voice call verification **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx index bfd35226a..3ed5f855b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx @@ -8,7 +8,7 @@ Interface for the screen data specific to reset-password-mfa-voice-challenge scr ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -74,7 +74,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -85,18 +85,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -125,5 +125,5 @@ Whether to show the link to switch to SMS verification. **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx index 42b270462..53624aeff 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx @@ -8,7 +8,7 @@ ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,12 +63,12 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -76,7 +76,7 @@ Screen-specific data. **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -98,23 +98,23 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> -<ParamField body='publicKey' type='{ challenge: string; allowCredentials?: [AllowCredential](./AllowCredential)[]; } '> -> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](./AllowCredential)[]; \} \| `null` +<ParamField body='publicKey' type={{ challenge: string; allowCredentials?: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential">AllowCredential</a>[]; } }> +> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential)[]; \} \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:35 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx index f829f68f1..30da8fbab 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx @@ -8,7 +8,7 @@ ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -63,12 +63,12 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -77,7 +77,7 @@ including WebAuthn challenge options and the "show remember device" flag. **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -88,7 +88,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -99,23 +99,23 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> -<ParamField body='publicKey' type='{ challenge: string; allowCredentials?: [AllowCredential](./AllowCredential)[]; } '> -> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](./AllowCredential)[]; \} \| `null` +<ParamField body='publicKey' type={{ challenge: string; allowCredentials?: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential">AllowCredential</a>[]; } }> +> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential)[]; \} \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:50 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest.mdx index 22dbf87ce..96c56d506 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -72,7 +72,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -83,18 +83,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -105,5 +105,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess.mdx index ef04bbd1c..d191cbfb8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,18 +61,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -83,7 +83,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -94,16 +94,16 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup.mdx index 66f9d6c2a..830b4f20b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:21 ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,18 +61,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -83,7 +83,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -94,18 +94,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId.mdx index 39f6ad078..0e56f5f27 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts: ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,18 +61,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> <ParamField body='data' type='Record<string, string '> -> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](./PhonePrefix)[] \| [`PasskeyCreate`](./PasskeyCreate)\> \| `null` +> **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> @@ -83,7 +83,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -94,18 +94,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword.mdx index 4385eca4f..e3350f334 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password ## Extends -- [`ScreenMembers`](./ScreenMembers) +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`name`](./ScreenMembers.md#name) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#name) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaImage`](./ScreenMembers.md#captchaimage) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaimage) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaSiteKey`](./ScreenMembers.md#captchasitekey) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchasitekey) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captchaProvider`](./ScreenMembers.md#captchaprovider) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captchaprovider) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`isCaptchaAvailable`](./ScreenMembers.md#iscaptchaavailable) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#iscaptchaavailable) </ParamField> @@ -72,7 +72,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`links`](./ScreenMembers.md#links) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#links) </ParamField> @@ -83,18 +83,18 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`texts`](./ScreenMembers.md#texts) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#texts) </ParamField> -<ParamField body='captcha' type='[CaptchaContext](./CaptchaContext) '> -> **captcha**: [`CaptchaContext`](./CaptchaContext) \| `null` +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 **Inherited from** -[`ScreenMembers`](./ScreenMembers).[`captcha`](./ScreenMembers.md#captcha) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#captcha) </ParamField> @@ -119,5 +119,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password **Overrides** -[`ScreenMembers`](./ScreenMembers).[`data`](./ScreenMembers.md#data) +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions.mdx index 3a9bae5b0..b7911d973 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions.mdx @@ -8,14 +8,14 @@ Options for submitting a WebAuthn browser error. ## Indexable -\[`key`: `string`\]: `string` \| `number` \| `boolean` \| [`WebAuthnErrorDetails`](./WebAuthnErrorDetails) \| `undefined` +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails) \| `undefined` Any additional custom options. ## Properties -<ParamField body='error' type='[WebAuthnErrorDetails](./WebAuthnErrorDetails)'> -> **error**: [`WebAuthnErrorDetails`](./WebAuthnErrorDetails) +<ParamField body='error' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a>}> +> **error**: [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:18 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers.mdx index fd9cc540f..812406b12 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts: ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnSignupId](./ScreenMembersOnSignupId)'> -> **screen**: [`ScreenMembersOnSignupId`](./ScreenMembersOnSignupId) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId">ScreenMembersOnSignupId</a>}> +> **screen**: [`ScreenMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:47 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembersOnSignupId](./TransactionMembersOnSignupId)'> -> **transaction**: [`TransactionMembersOnSignupId`](./TransactionMembersOnSignupId) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a>}> +> **transaction**: [`TransactionMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:48 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts: **payload** -[`SignupOptions`](./SignupOptions) +[`SignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts: **payload** -[`FederatedSignupOptions`](./FederatedSignupOptions) +[`FederatedSignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupOptions) **Returns** @@ -145,13 +145,13 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts: </ParamField> <ParamField body='getSignupIdentifiers()' type='unknown'> -> **getSignupIdentifiers**(): [`Identifier`](./Identifier)[] \| `null` +> **getSignupIdentifiers**(): [`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:51 **Returns** -[`Identifier`](./Identifier)[] \| `null` +[`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier)[] \| `null` </ParamField> @@ -164,7 +164,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts: **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -173,7 +173,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts: </ParamField> <ParamField body='validateUsername()' type='unknown'> -> **validateUsername**(`username`): [`UsernameValidationResult`](./UsernameValidationResult) +> **validateUsername**(`username`): [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:53 @@ -185,5 +185,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts: **Returns** -[`UsernameValidationResult`](./UsernameValidationResult) +[`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers.mdx index e5143fbe8..347b78d5a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:31 ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnSignup](./ScreenMembersOnSignup)'> -> **screen**: [`ScreenMembersOnSignup`](./ScreenMembersOnSignup) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup">ScreenMembersOnSignup</a>}> +> **screen**: [`ScreenMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:32 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembersOnSignup](./TransactionMembersOnSignup)'> -> **transaction**: [`TransactionMembersOnSignup`](./TransactionMembersOnSignup) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup">TransactionMembersOnSignup</a>}> +> **transaction**: [`TransactionMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:33 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:34 **payload** -[`SignupPayloadOptions`](./SignupPayloadOptions) +[`SignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPayloadOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:35 **payload** -[`FederatedSignupPayloadOptions`](./FederatedSignupPayloadOptions) +[`FederatedSignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPayloadOptions) **Returns** @@ -153,7 +153,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:36 **payload?** -[`CustomOptions`](./CustomOptions) +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) **Returns** @@ -162,7 +162,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:36 </ParamField> <ParamField body='validatePassword()' type='unknown'> -> **validatePassword**(`password`): [`PasswordValidationResult`](./PasswordValidationResult) +> **validatePassword**(`password`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:37 @@ -174,12 +174,12 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:37 **Returns** -[`PasswordValidationResult`](./PasswordValidationResult) +[`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult) </ParamField> <ParamField body='getSignupIdentifiers()' type='unknown'> -> **getSignupIdentifiers**(): [`Identifier`](./Identifier)[] \| `null` +> **getSignupIdentifiers**(): [`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:59 @@ -191,9 +191,9 @@ and configuration provided during the authentication or signup flow. **Returns** -[`Identifier`](./Identifier)[] \| `null` +[`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier)[] \| `null` -An array of enabled [Identifier](./Identifier) objects, or `null` if the transaction is not initialized. +An array of enabled [Identifier](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier) objects, or `null` if the transaction is not initialized. **Example** @@ -215,7 +215,7 @@ Identifier </ParamField> <ParamField body='validateUsername()' type='unknown'> -> **validateUsername**(`username`): [`UsernameValidationResult`](./UsernameValidationResult) +> **validateUsername**(`username`): [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:60 @@ -227,5 +227,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:60 **Returns** -[`UsernameValidationResult`](./UsernameValidationResult) +[`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers.mdx index fdbebf74d..c7ef6f197 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers.mdx @@ -6,106 +6,106 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password ## Extends -- [`BaseMembers`](./BaseMembers) +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) ## Properties -<ParamField body='branding' type='[BrandingMembers](./BrandingMembers)'> -> **branding**: [`BrandingMembers`](./BrandingMembers) +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:22 **Inherited from** -[`BaseMembers`](./BaseMembers).[`branding`](./BaseMembers.md#branding) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#branding) </ParamField> -<ParamField body='client' type='[ClientMembers](./ClientMembers)'> -> **client**: [`ClientMembers`](./ClientMembers) +<ParamField body='client' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:23 **Inherited from** -[`BaseMembers`](./BaseMembers).[`client`](./BaseMembers.md#client) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#client) </ParamField> -<ParamField body='organization' type='[OrganizationMembers](./OrganizationMembers)'> -> **organization**: [`OrganizationMembers`](./OrganizationMembers) +<ParamField body='organization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:24 **Inherited from** -[`BaseMembers`](./BaseMembers).[`organization`](./BaseMembers.md#organization) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#organization) </ParamField> -<ParamField body='prompt' type='[PromptMembers](./PromptMembers)'> -> **prompt**: [`PromptMembers`](./PromptMembers) +<ParamField body='prompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:25 **Inherited from** -[`BaseMembers`](./BaseMembers).[`prompt`](./BaseMembers.md#prompt) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#prompt) </ParamField> -<ParamField body='tenant' type='[TenantMembers](./TenantMembers)'> -> **tenant**: [`TenantMembers`](./TenantMembers) +<ParamField body='tenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:27 **Inherited from** -[`BaseMembers`](./BaseMembers).[`tenant`](./BaseMembers.md#tenant) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#tenant) </ParamField> -<ParamField body='user' type='[UserMembers](./UserMembers)'> -> **user**: [`UserMembers`](./UserMembers) +<ParamField body='user' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:29 **Inherited from** -[`BaseMembers`](./BaseMembers).[`user`](./BaseMembers.md#user) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#user) </ParamField> -<ParamField body='untrustedData' type='[UntrustedDataMembers](./UntrustedDataMembers)'> -> **untrustedData**: [`UntrustedDataMembers`](./UntrustedDataMembers) +<ParamField body='untrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.ts:30 **Inherited from** -[`BaseMembers`](./BaseMembers).[`untrustedData`](./BaseMembers.md#untrusteddata) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#untrusteddata) </ParamField> -<ParamField body='screen' type='[ScreenMembersOnSignupPassword](./ScreenMembersOnSignupPassword)'> -> **screen**: [`ScreenMembersOnSignupPassword`](./ScreenMembersOnSignupPassword) +<ParamField body='screen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword">ScreenMembersOnSignupPassword</a>}> +> **screen**: [`ScreenMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:48 **Overrides** -[`BaseMembers`](./BaseMembers).[`screen`](./BaseMembers.md#screen) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#screen) </ParamField> -<ParamField body='transaction' type='[TransactionMembersOnSignupPassword](./TransactionMembersOnSignupPassword)'> -> **transaction**: [`TransactionMembersOnSignupPassword`](./TransactionMembersOnSignupPassword) +<ParamField body='transaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword">TransactionMembersOnSignupPassword</a>}> +> **transaction**: [`TransactionMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:49 **Overrides** -[`BaseMembers`](./BaseMembers).[`transaction`](./BaseMembers.md#transaction) +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers.md#transaction) **Methods** </ParamField> @@ -119,7 +119,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password **payload** -[`SignupPasswordOptions`](./SignupPasswordOptions) +[`SignupPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordOptions) **Returns** @@ -136,7 +136,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password **payload** -[`FederatedSignupPasswordPayloadOptions`](./FederatedSignupPasswordPayloadOptions) +[`FederatedSignupPasswordPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPasswordPayloadOptions) **Returns** @@ -145,7 +145,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password </ParamField> <ParamField body='validatePassword()' type='unknown'> -> **validatePassword**(`password`): [`PasswordValidationResult`](./PasswordValidationResult) +> **validatePassword**(`password`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult) Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:52 @@ -157,5 +157,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password **Returns** -[`PasswordValidationResult`](./PasswordValidationResult) +[`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions.mdx index 56cb03383..763961140 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions.mdx @@ -15,8 +15,8 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/resend-control.d. </ParamField> -<ParamField body='onStatusChange?' type='[OnStatusChangeCallback](../type-aliases/OnStatusChangeCallback)'> -> `optional` **onStatusChange**: [`OnStatusChangeCallback`](../type-aliases/OnStatusChangeCallback) +<ParamField body='onStatusChange?' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/OnStatusChangeCallback">OnStatusChangeCallback</a>}> +> `optional` **onStatusChange**: [`OnStatusChangeCallback`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/OnStatusChangeCallback) Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/resend-control.d.ts:12 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions.mdx index 07cb871c7..6dbb34a83 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions.mdx @@ -8,7 +8,7 @@ SubmitPasskeyCredentialOptions ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.mdx index fa164e7de..191bf9b5a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.mdx @@ -6,16 +6,16 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts ## Extended by -- [`TransactionMembersOnLoginId`](./TransactionMembersOnLoginId) -- [`TransactionMembersOnLoginPassword`](./TransactionMembersOnLoginPassword) -- [`TransactionMembersOnLoginPasswordlessEmailCode`](./TransactionMembersOnLoginPasswordlessEmailCode) -- [`TransactionMembersOnLoginPasswordlessSmsOtp`](./TransactionMembersOnLoginPasswordlessSmsOtp) -- [`TransactionMembersOnSignupId`](./TransactionMembersOnSignupId) -- [`TransactionMembersOnSignupPassword`](./TransactionMembersOnSignupPassword) -- [`TransactionMembersOnSignup`](./TransactionMembersOnSignup) -- [`TransactionMembersOnResetPasswordRequest`](./TransactionMembersOnResetPasswordRequest) -- [`TransactionMembersOnLogin`](./TransactionMembersOnLogin) -- [`TransactionMembersOnResetPassword`](./TransactionMembersOnResetPassword) +- [`TransactionMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId) +- [`TransactionMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword) +- [`TransactionMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode) +- [`TransactionMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp) +- [`TransactionMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId) +- [`TransactionMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword) +- [`TransactionMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup) +- [`TransactionMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest) +- [`TransactionMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin) +- [`TransactionMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword) ## Properties @@ -61,22 +61,22 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='errors' type='[Error](./Error)[] '> -> **errors**: [`Error`](./Error)[] \| `null` +<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 </ParamField> -<ParamField body='currentConnection' type='[Connection](./Connection) '> -> **currentConnection**: [`Connection`](./Connection) \| `null` +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 </ParamField> -<ParamField body='alternateConnections' type='([Connection](./Connection) '> -> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` +<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin.mdx index f7f612a2c..bc6bc2f6b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin.mdx @@ -8,7 +8,7 @@ Extended transaction members interface for the login screen ## Extends -- [`TransactionMembers`](./TransactionMembers) +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#state) </ParamField> @@ -30,7 +30,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#locale) </ParamField> @@ -41,7 +41,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countrycode) </ParamField> @@ -52,7 +52,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countryprefix) </ParamField> @@ -63,7 +63,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#connectionstrategy) </ParamField> @@ -74,40 +74,40 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#haserrors) </ParamField> -<ParamField body='errors' type='[Error](./Error)[] '> -> **errors**: [`Error`](./Error)[] \| `null` +<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#errors) </ParamField> -<ParamField body='currentConnection' type='[Connection](./Connection) '> -> **currentConnection**: [`Connection`](./Connection) \| `null` +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#currentconnection) </ParamField> -<ParamField body='alternateConnections' type='([Connection](./Connection) '> -> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` +<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#alternateconnections) </ParamField> @@ -132,15 +132,15 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:37 </ParamField> -<ParamField body='passwordPolicy' type='[PasswordPolicy](./PasswordPolicy) '> -> **passwordPolicy**: [`PasswordPolicy`](./PasswordPolicy) \| `null` +<ParamField body='passwordPolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy">PasswordPolicy</a> }> +> **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:38 </ParamField> -<ParamField body='allowedIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> -> **allowedIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +<ParamField body='allowedIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +> **allowedIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:39 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId.mdx index 81ca680dc..1f132b007 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:3 ## Extends -- [`TransactionMembers`](./TransactionMembers) +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#state) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#locale) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countrycode) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countryprefix) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#connectionstrategy) </ParamField> @@ -72,40 +72,40 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#haserrors) </ParamField> -<ParamField body='errors' type='[Error](./Error)[] '> -> **errors**: [`Error`](./Error)[] \| `null` +<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#errors) </ParamField> -<ParamField body='currentConnection' type='[Connection](./Connection) '> -> **currentConnection**: [`Connection`](./Connection) \| `null` +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#currentconnection) </ParamField> -<ParamField body='alternateConnections' type='([Connection](./Connection) '> -> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` +<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#alternateconnections) </ParamField> @@ -137,15 +137,15 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:3 </ParamField> -<ParamField body='usernamePolicy' type='[UsernamePolicy](./UsernamePolicy) '> -> **usernamePolicy**: [`UsernamePolicy`](./UsernamePolicy) \| `null` +<ParamField body='usernamePolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy">UsernamePolicy</a> }> +> **usernamePolicy**: [`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:36 </ParamField> -<ParamField body='allowedIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> -> **allowedIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +<ParamField body='allowedIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +> **allowedIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:37 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword.mdx index 2b3ac998b..aa7860ae6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password. ## Extends -- [`TransactionMembers`](./TransactionMembers) +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#state) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#locale) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countrycode) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countryprefix) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#connectionstrategy) </ParamField> @@ -72,40 +72,40 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#haserrors) </ParamField> -<ParamField body='errors' type='[Error](./Error)[] '> -> **errors**: [`Error`](./Error)[] \| `null` +<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#errors) </ParamField> -<ParamField body='currentConnection' type='[Connection](./Connection) '> -> **currentConnection**: [`Connection`](./Connection) \| `null` +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#currentconnection) </ParamField> -<ParamField body='alternateConnections' type='([Connection](./Connection) '> -> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` +<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#alternateconnections) </ParamField> @@ -132,33 +132,33 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password. </ParamField> <ParamField body='getPasswordPolicy()' type='unknown'> -> **getPasswordPolicy**(): [`PasswordPolicy`](./PasswordPolicy) \| `null` +> **getPasswordPolicy**(): [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:27 **Returns** -[`PasswordPolicy`](./PasswordPolicy) \| `null` +[`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy) \| `null` </ParamField> <ParamField body='getUsernamePolicy()' type='unknown'> -> **getUsernamePolicy**(): [`UsernamePolicy`](./UsernamePolicy) \| `null` +> **getUsernamePolicy**(): [`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:28 **Returns** -[`UsernamePolicy`](./UsernamePolicy) \| `null` +[`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy) \| `null` </ParamField> <ParamField body='getAllowedIdentifiers()' type='unknown'> -> **getAllowedIdentifiers**(): [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +> **getAllowedIdentifiers**(): [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:29 **Returns** -[`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +[`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx index c68a96146..5be573aab 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl ## Extends -- [`TransactionMembers`](./TransactionMembers) +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#state) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#locale) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countrycode) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countryprefix) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#connectionstrategy) </ParamField> @@ -72,40 +72,40 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#haserrors) </ParamField> -<ParamField body='errors' type='[Error](./Error)[] '> -> **errors**: [`Error`](./Error)[] \| `null` +<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#errors) </ParamField> -<ParamField body='currentConnection' type='[Connection](./Connection) '> -> **currentConnection**: [`Connection`](./Connection) \| `null` +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#currentconnection) </ParamField> -<ParamField body='alternateConnections' type='([Connection](./Connection) '> -> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` +<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#alternateconnections) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx index 7a571d3a3..b48852531 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl ## Extends -- [`TransactionMembers`](./TransactionMembers) +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#state) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#locale) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countrycode) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countryprefix) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#connectionstrategy) </ParamField> @@ -72,40 +72,40 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#haserrors) </ParamField> -<ParamField body='errors' type='[Error](./Error)[] '> -> **errors**: [`Error`](./Error)[] \| `null` +<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#errors) </ParamField> -<ParamField body='currentConnection' type='[Connection](./Connection) '> -> **currentConnection**: [`Connection`](./Connection) \| `null` +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#currentconnection) </ParamField> -<ParamField body='alternateConnections' type='([Connection](./Connection) '> -> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` +<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#alternateconnections) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword.mdx index f062f04bd..e8224c0ec 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password. ## Extends -- [`TransactionMembers`](./TransactionMembers) +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#state) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#locale) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countrycode) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countryprefix) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#connectionstrategy) </ParamField> @@ -72,45 +72,45 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#haserrors) </ParamField> -<ParamField body='errors' type='[Error](./Error)[] '> -> **errors**: [`Error`](./Error)[] \| `null` +<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#errors) </ParamField> -<ParamField body='currentConnection' type='[Connection](./Connection) '> -> **currentConnection**: [`Connection`](./Connection) \| `null` +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#currentconnection) </ParamField> -<ParamField body='alternateConnections' type='([Connection](./Connection) '> -> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` +<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#alternateconnections) </ParamField> -<ParamField body='passwordPolicy' type='[PasswordPolicy](./PasswordPolicy) '> -> **passwordPolicy**: [`PasswordPolicy`](./PasswordPolicy) \| `null` +<ParamField body='passwordPolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy">PasswordPolicy</a> }> +> **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:19 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest.mdx index 1a104b613..e6e7d9a3e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password- ## Extends -- [`TransactionMembers`](./TransactionMembers) +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#state) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#locale) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countrycode) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countryprefix) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#connectionstrategy) </ParamField> @@ -72,52 +72,52 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#haserrors) </ParamField> -<ParamField body='errors' type='[Error](./Error)[] '> -> **errors**: [`Error`](./Error)[] \| `null` +<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#errors) </ParamField> -<ParamField body='currentConnection' type='[Connection](./Connection) '> -> **currentConnection**: [`Connection`](./Connection) \| `null` +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#currentconnection) </ParamField> -<ParamField body='alternateConnections' type='([Connection](./Connection) '> -> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` +<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#alternateconnections) </ParamField> -<ParamField body='allowedIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> -> **allowedIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +<ParamField body='allowedIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +> **allowedIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:12 </ParamField> -<ParamField body='requiredIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> -> **requiredIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +<ParamField body='requiredIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +> **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:13 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup.mdx index 3055bfc7a..d235dc034 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:24 ## Extends -- [`TransactionMembers`](./TransactionMembers) +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#state) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#locale) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countrycode) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countryprefix) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#connectionstrategy) </ParamField> @@ -72,40 +72,40 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#haserrors) </ParamField> -<ParamField body='errors' type='[Error](./Error)[] '> -> **errors**: [`Error`](./Error)[] \| `null` +<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#errors) </ParamField> -<ParamField body='currentConnection' type='[Connection](./Connection) '> -> **currentConnection**: [`Connection`](./Connection) \| `null` +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#currentconnection) </ParamField> -<ParamField body='alternateConnections' type='([Connection](./Connection) '> -> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` +<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#alternateconnections) </ParamField> @@ -116,29 +116,29 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:25 </ParamField> -<ParamField body='usernamePolicy' type='[UsernamePolicy](./UsernamePolicy) '> -> **usernamePolicy**: [`UsernamePolicy`](./UsernamePolicy) \| `null` +<ParamField body='usernamePolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy">UsernamePolicy</a> }> +> **usernamePolicy**: [`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:26 </ParamField> -<ParamField body='requiredIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> -> **requiredIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +<ParamField body='requiredIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +> **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:27 </ParamField> -<ParamField body='optionalIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> -> **optionalIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +<ParamField body='optionalIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +> **optionalIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:28 </ParamField> -<ParamField body='passwordPolicy' type='[PasswordPolicy](./PasswordPolicy) '> -> **passwordPolicy**: [`PasswordPolicy`](./PasswordPolicy) \| `null` +<ParamField body='passwordPolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy">PasswordPolicy</a> }> +> **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:29 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId.mdx index 7e79cd819..9112605f1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts: ## Extends -- [`TransactionMembers`](./TransactionMembers) +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#state) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#locale) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countrycode) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countryprefix) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#connectionstrategy) </ParamField> @@ -72,40 +72,40 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#haserrors) </ParamField> -<ParamField body='errors' type='[Error](./Error)[] '> -> **errors**: [`Error`](./Error)[] \| `null` +<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#errors) </ParamField> -<ParamField body='currentConnection' type='[Connection](./Connection) '> -> **currentConnection**: [`Connection`](./Connection) \| `null` +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#currentconnection) </ParamField> -<ParamField body='alternateConnections' type='([Connection](./Connection) '> -> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` +<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#alternateconnections) </ParamField> @@ -116,22 +116,22 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts: </ParamField> -<ParamField body='usernamePolicy' type='[UsernamePolicy](./UsernamePolicy) '> -> **usernamePolicy**: [`UsernamePolicy`](./UsernamePolicy) \| `null` +<ParamField body='usernamePolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy">UsernamePolicy</a> }> +> **usernamePolicy**: [`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:27 </ParamField> -<ParamField body='requiredIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> -> **requiredIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +<ParamField body='requiredIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +> **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:28 </ParamField> -<ParamField body='optionalIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> -> **optionalIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +<ParamField body='optionalIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +> **optionalIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:29 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword.mdx index 79db58454..ff7a3b4e3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password ## Extends -- [`TransactionMembers`](./TransactionMembers) +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`state`](./TransactionMembers.md#state) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#state) </ParamField> @@ -28,7 +28,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`locale`](./TransactionMembers.md#locale) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#locale) </ParamField> @@ -39,7 +39,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryCode`](./TransactionMembers.md#countrycode) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countrycode) </ParamField> @@ -50,7 +50,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`countryPrefix`](./TransactionMembers.md#countryprefix) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#countryprefix) </ParamField> @@ -61,7 +61,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`connectionStrategy`](./TransactionMembers.md#connectionstrategy) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#connectionstrategy) </ParamField> @@ -72,40 +72,40 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`hasErrors`](./TransactionMembers.md#haserrors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#haserrors) </ParamField> -<ParamField body='errors' type='[Error](./Error)[] '> -> **errors**: [`Error`](./Error)[] \| `null` +<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`errors`](./TransactionMembers.md#errors) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#errors) </ParamField> -<ParamField body='currentConnection' type='[Connection](./Connection) '> -> **currentConnection**: [`Connection`](./Connection) \| `null` +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`currentConnection`](./TransactionMembers.md#currentconnection) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#currentconnection) </ParamField> -<ParamField body='alternateConnections' type='([Connection](./Connection) '> -> **alternateConnections**: ([`Connection`](./Connection) \| [`EnterpriseConnection`](./EnterpriseConnection))[] \| `null` +<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 **Inherited from** -[`TransactionMembers`](./TransactionMembers).[`alternateConnections`](./TransactionMembers.md#alternateconnections) +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.md#alternateconnections) </ParamField> @@ -116,22 +116,22 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password </ParamField> -<ParamField body='passwordPolicy' type='[PasswordPolicy](./PasswordPolicy) '> -> **passwordPolicy**: [`PasswordPolicy`](./PasswordPolicy) \| `null` +<ParamField body='passwordPolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy">PasswordPolicy</a> }> +> **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:35 </ParamField> -<ParamField body='requiredIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> -> **requiredIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +<ParamField body='requiredIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +> **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:36 </ParamField> -<ParamField body='optionalIdentifiers' type='[IdentifierType](../type-aliases/IdentifierType)[] '> -> **optionalIdentifiers**: [`IdentifierType`](../type-aliases/IdentifierType)[] \| `null` +<ParamField body='optionalIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +> **optionalIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:37 </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.mdx index 8634eab80..fc4ed5271 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.mdx @@ -6,11 +6,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d ## Extended by -- [`UntrustedDataMembersOnMfaSmsChallenge`](./UntrustedDataMembersOnMfaSmsChallenge) -- [`UntrustedDataMembersOnMfaEmailChallenge`](./UntrustedDataMembersOnMfaEmailChallenge) -- [`UntrustedDataMembersOnMfaPushChallengePush`](./UntrustedDataMembersOnMfaPushChallengePush) -- [`UntrustedDataMembersOnMfaOtpChallenge`](./UntrustedDataMembersOnMfaOtpChallenge) -- [`UntrustedDataMembersOnMfaVoiceChallenge`](./UntrustedDataMembersOnMfaVoiceChallenge) +- [`UntrustedDataMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge) +- [`UntrustedDataMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge) +- [`UntrustedDataMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush) +- [`UntrustedDataMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge) +- [`UntrustedDataMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge) ## Properties diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx index 11e0e7fd2..0c976bebc 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx @@ -8,7 +8,7 @@ Interface for untrusted data specific to mfa-email-challenge screen ## Extends -- [`UntrustedDataMembers`](./UntrustedDataMembers) +- [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d **Inherited from** -[`UntrustedDataMembers`](./UntrustedDataMembers).[`authorizationParams`](./UntrustedDataMembers.md#authorizationparams) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`authorizationParams`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#authorizationparams) </ParamField> @@ -30,5 +30,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-chall **Overrides** -[`UntrustedDataMembers`](./UntrustedDataMembers).[`submittedFormData`](./UntrustedDataMembers.md#submittedformdata) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`submittedFormData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#submittedformdata) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx index f7376753f..e88e80204 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx @@ -8,7 +8,7 @@ Interface for untrusted data specific to mfa-otp-challenge screen ## Extends -- [`UntrustedDataMembers`](./UntrustedDataMembers) +- [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d **Inherited from** -[`UntrustedDataMembers`](./UntrustedDataMembers).[`authorizationParams`](./UntrustedDataMembers.md#authorizationparams) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`authorizationParams`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#authorizationparams) </ParamField> @@ -30,5 +30,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challen **Overrides** -[`UntrustedDataMembers`](./UntrustedDataMembers).[`submittedFormData`](./UntrustedDataMembers.md#submittedformdata) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`submittedFormData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#submittedformdata) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx index 0de5591b9..9569a1785 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx @@ -8,7 +8,7 @@ Interface for untrusted data specific to mfa-push-challenge-push screen ## Extends -- [`UntrustedDataMembers`](./UntrustedDataMembers) +- [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d **Inherited from** -[`UntrustedDataMembers`](./UntrustedDataMembers).[`authorizationParams`](./UntrustedDataMembers.md#authorizationparams) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`authorizationParams`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#authorizationparams) </ParamField> @@ -30,5 +30,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challe **Overrides** -[`UntrustedDataMembers`](./UntrustedDataMembers).[`submittedFormData`](./UntrustedDataMembers.md#submittedformdata) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`submittedFormData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#submittedformdata) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx index 4ccf5f0a1..b76881f58 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx @@ -8,7 +8,7 @@ Interface for untrusted data specific to mfa-sms-challenge screen ## Extends -- [`UntrustedDataMembers`](./UntrustedDataMembers) +- [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d **Inherited from** -[`UntrustedDataMembers`](./UntrustedDataMembers).[`authorizationParams`](./UntrustedDataMembers.md#authorizationparams) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`authorizationParams`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#authorizationparams) </ParamField> @@ -30,5 +30,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challen **Overrides** -[`UntrustedDataMembers`](./UntrustedDataMembers).[`submittedFormData`](./UntrustedDataMembers.md#submittedformdata) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`submittedFormData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#submittedformdata) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx index 5317cf5d1..ceb411151 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx @@ -8,7 +8,7 @@ Interface for untrusted data specific to mfa-voice-challenge screen ## Extends -- [`UntrustedDataMembers`](./UntrustedDataMembers) +- [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) ## Properties @@ -19,7 +19,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d **Inherited from** -[`UntrustedDataMembers`](./UntrustedDataMembers).[`authorizationParams`](./UntrustedDataMembers.md#authorizationparams) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`authorizationParams`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#authorizationparams) </ParamField> @@ -30,5 +30,5 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-chall **Overrides** -[`UntrustedDataMembers`](./UntrustedDataMembers).[`submittedFormData`](./UntrustedDataMembers.md#submittedformdata) +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`submittedFormData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#submittedformdata) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult.mdx index d8fe741a3..0c516fcf5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult.mdx @@ -6,8 +6,8 @@ Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:21](https://gi ## Properties -<ParamField body='errors' type='[ErrorsResult](./ErrorsResult)'> -> **errors**: [`ErrorsResult`](./ErrorsResult) +<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>}> +> **errors**: [`ErrorsResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult) Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L22) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions.mdx index d1f711fb2..09135dde7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions.mdx @@ -4,7 +4,7 @@ title: "UseResendOptions" Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L18) -Optional configuration for [useResend](../../Hooks/functions/useResend). +Optional configuration for [useResend](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend). ## Properties diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn.mdx index b042057c6..007139d8d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn.mdx @@ -4,7 +4,7 @@ title: "UseResendReturn" Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:8](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L8) -Return type for [useResend](../../Hooks/functions/useResend). +Return type for [useResend](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend). ## Properties diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers.mdx index 4bf3a5b52..58cb65990 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers.mdx @@ -48,29 +48,29 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:40 </ParamField> -<ParamField body='enrolledEmails' type='[EnrolledEmail](./EnrolledEmail)[] '> -> **enrolledEmails**: [`EnrolledEmail`](./EnrolledEmail)[] \| `null` +<ParamField body='enrolledEmails' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledEmail">EnrolledEmail</a>[] }> +> **enrolledEmails**: [`EnrolledEmail`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledEmail)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:41 </ParamField> -<ParamField body='enrolledPhoneNumbers' type='[EnrolledPhoneNumber](./EnrolledPhoneNumber)[] '> -> **enrolledPhoneNumbers**: [`EnrolledPhoneNumber`](./EnrolledPhoneNumber)[] \| `null` +<ParamField body='enrolledPhoneNumbers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledPhoneNumber">EnrolledPhoneNumber</a>[] }> +> **enrolledPhoneNumbers**: [`EnrolledPhoneNumber`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledPhoneNumber)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:42 </ParamField> -<ParamField body='enrolledDevices' type='[EnrolledDevice](./EnrolledDevice)[] '> -> **enrolledDevices**: [`EnrolledDevice`](./EnrolledDevice)[] \| `null` +<ParamField body='enrolledDevices' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledDevice">EnrolledDevice</a>[] }> +> **enrolledDevices**: [`EnrolledDevice`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledDevice)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:43 </ParamField> -<ParamField body='organizations' type='[Organizations](./Organizations)[] '> -> **organizations**: [`Organizations`](./Organizations)[] \| `null` +<ParamField body='organizations' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations">Organizations</a>[] }> +> **organizations**: [`Organizations`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:44 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult.mdx index 9f89130fe..623e230c3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult.mdx @@ -17,12 +17,12 @@ Indicates whether the username passed all validation rules. </ParamField> -<ParamField body='errors' type='[UsernameValidationError](./UsernameValidationError)[]'> -> **errors**: [`UsernameValidationError`](./UsernameValidationError)[] +<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationError">UsernameValidationError</a>[]}> +> **errors**: [`UsernameValidationError`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationError)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/validate-username.d.ts:38 -An array of [UsernameValidationError](./UsernameValidationError) objects representing +An array of [UsernameValidationError](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationError) objects representing the individual rules that failed, if any. This array is empty if [UsernameValidationResult.isValid](#isvalid) is `true`. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions.mdx index 2ff324e64..c40350dab 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions.mdx @@ -8,7 +8,7 @@ VerifyPlatformAuthenticatorOptions ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions.mdx index 877e7a560..f4c002c9c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions.mdx @@ -8,7 +8,7 @@ VerifySecurityKeyOptions ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx index 855d0d62c..ded1995fb 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx @@ -8,7 +8,7 @@ ContinueOptions ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions.mdx index e9ded993e..b8ca96a5e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions.mdx @@ -6,7 +6,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challe ## Extends -- [`CustomOptions`](./CustomOptions) +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) ## Indexable diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions.mdx index 69f7f270f..998376da3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions.mdx @@ -58,7 +58,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/polling-control.d Optional callback invoked if an error occurs while polling. -Receives an [ULError](../interfaces/Error) object containing: +Receives an [ULError](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error) object containing: - `status` — the HTTP status code from the failed request - `responseText` — the raw response body, if available @@ -69,7 +69,7 @@ Receives an [ULError](../interfaces/Error) object containing: ##### error -[`Error`](../interfaces/Error) +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error) #### Returns diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/index.mdx index b93ea04e9..1531dbd41 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/index.mdx @@ -4,6 +4,6 @@ title: "API Reference" ## Namespaces -- [Hooks](./namespaces/Hooks) -- [Screens](./namespaces/Screens) -- [Types](./namespaces/Types) +- [Hooks](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks) +- [Screens](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/namespaces/Screens) +- [Types](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types) From 849a0d54e6319aade83f568accc1e12a59a99089 Mon Sep 17 00:00:00 2001 From: gabrielraeder <gabrielraeder@outlook.com.br> Date: Fri, 14 Nov 2025 14:48:56 -0300 Subject: [PATCH 4/7] general fixes to script and resulting pages --- .../API-Reference/Hooks/useAuth0Themes.mdx | 2 +- .../API-Reference/Hooks/useCurrentScreen.mdx | 2 +- .../API-Reference/Hooks/useErrors.mdx | 2 +- .../Hooks/useLoginIdentifiers.mdx | 2 +- .../API-Reference/Hooks/useMfaPolling.mdx | 2 +- .../Hooks/usePasswordValidation.mdx | 2 +- .../API-Reference/Hooks/useResend.mdx | 2 +- .../Hooks/useSignupIdentifiers.mdx | 2 +- .../Hooks/useUsernameValidation.mdx | 2 +- .../Screens/accept-invitation/index.mdx | 40 +++++------ .../API-Reference/Screens/consent/index.mdx | 42 +++++------ .../Screens/customized-consent/index.mdx | 42 +++++------ .../device-code-activation-allowed/index.mdx | 38 +++++----- .../device-code-activation-denied/index.mdx | 38 +++++----- .../Screens/device-code-activation/index.mdx | 40 +++++------ .../device-code-confirmation/index.mdx | 42 +++++------ .../email-identifier-challenge/index.mdx | 44 ++++++------ .../Screens/email-otp-challenge/index.mdx | 42 +++++------ .../email-verification-result/index.mdx | 38 +++++----- .../Screens/interstitial-captcha/index.mdx | 38 +++++----- .../login-email-verification/index.mdx | 42 +++++------ .../API-Reference/Screens/login-id/index.mdx | 46 ++++++------ .../Screens/login-password/index.mdx | 42 +++++------ .../login-passwordless-email-code/index.mdx | 42 +++++------ .../login-passwordless-sms-otp/index.mdx | 42 +++++------ .../API-Reference/Screens/login/index.mdx | 44 ++++++------ .../Screens/logout-aborted/index.mdx | 38 +++++----- .../Screens/logout-complete/index.mdx | 38 +++++----- .../API-Reference/Screens/logout/index.mdx | 40 +++++------ .../mfa-begin-enroll-options/index.mdx | 40 +++++------ .../Screens/mfa-country-codes/index.mdx | 42 +++++------ .../mfa-detect-browser-capabilities/index.mdx | 40 +++++------ .../Screens/mfa-email-challenge/index.mdx | 46 ++++++------ .../Screens/mfa-email-list/index.mdx | 42 +++++------ .../Screens/mfa-enroll-result/index.mdx | 38 +++++----- .../Screens/mfa-login-options/index.mdx | 42 +++++------ .../Screens/mfa-otp-challenge/index.mdx | 42 +++++------ .../Screens/mfa-otp-enrollment-code/index.mdx | 42 +++++------ .../Screens/mfa-otp-enrollment-qr/index.mdx | 44 ++++++------ .../Screens/mfa-phone-challenge/index.mdx | 44 ++++++------ .../Screens/mfa-phone-enrollment/index.mdx | 44 ++++++------ .../Screens/mfa-push-challenge-push/index.mdx | 46 ++++++------ .../Screens/mfa-push-enrollment-qr/index.mdx | 40 +++++------ .../Screens/mfa-push-list/index.mdx | 42 +++++------ .../Screens/mfa-push-welcome/index.mdx | 42 +++++------ .../index.mdx | 40 +++++------ .../mfa-recovery-code-challenge/index.mdx | 42 +++++------ .../mfa-recovery-code-enrollment/index.mdx | 40 +++++------ .../Screens/mfa-sms-challenge/index.mdx | 48 ++++++------- .../Screens/mfa-sms-enrollment/index.mdx | 44 ++++++------ .../Screens/mfa-sms-list/index.mdx | 42 +++++------ .../Screens/mfa-voice-challenge/index.mdx | 48 ++++++------- .../Screens/mfa-voice-enrollment/index.mdx | 44 ++++++------ .../index.mdx | 40 +++++------ .../mfa-webauthn-enrollment-success/index.mdx | 40 +++++------ .../Screens/mfa-webauthn-error/index.mdx | 46 ++++++------ .../index.mdx | 40 +++++------ .../mfa-webauthn-platform-challenge/index.mdx | 44 ++++++------ .../index.mdx | 46 ++++++------ .../mfa-webauthn-roaming-challenge/index.mdx | 44 ++++++------ .../mfa-webauthn-roaming-enrollment/index.mdx | 44 ++++++------ .../Screens/organization-picker/index.mdx | 42 +++++------ .../Screens/organization-selection/index.mdx | 40 +++++------ .../passkey-enrollment-local/index.mdx | 42 +++++------ .../Screens/passkey-enrollment/index.mdx | 42 +++++------ .../phone-identifier-challenge/index.mdx | 48 ++++++------- .../phone-identifier-enrollment/index.mdx | 42 +++++------ .../Screens/redeem-ticket/index.mdx | 40 +++++------ .../Screens/reset-password-email/index.mdx | 40 +++++------ .../Screens/reset-password-error/index.mdx | 38 +++++----- .../index.mdx | 44 ++++++------ .../index.mdx | 42 +++++------ .../index.mdx | 42 +++++------ .../index.mdx | 46 ++++++------ .../index.mdx | 42 +++++------ .../index.mdx | 46 ++++++------ .../index.mdx | 46 ++++++------ .../index.mdx | 44 ++++++------ .../index.mdx | 44 ++++++------ .../Screens/reset-password-request/index.mdx | 42 +++++------ .../Screens/reset-password-success/index.mdx | 38 +++++----- .../Screens/reset-password/index.mdx | 40 +++++------ .../API-Reference/Screens/signup-id/index.mdx | 44 ++++++------ .../Screens/signup-password/index.mdx | 42 +++++------ .../API-Reference/Screens/signup/index.mdx | 44 ++++++------ .../Types/classes/ContextHooks.mdx | 22 +++--- .../react-sdk/API-Reference/Types/index.mdx | 58 +++------------ .../Types/interfaces/AllowCredential.mdx | 2 +- .../Types/interfaces/Branding.mdx | 11 +-- .../Types/interfaces/BrandingMembers.mdx | 4 +- .../Types/interfaces/BrandingSettings.mdx | 12 +--- .../Types/interfaces/BrandingThemes.mdx | 36 ++++------ .../Types/interfaces/ClientMembers.mdx | 13 ++-- .../Types/interfaces/ConfirmLogoutOptions.mdx | 2 +- .../Types/interfaces/Connection.mdx | 2 +- .../Types/interfaces/CredentialResponse.mdx | 4 +- .../Types/interfaces/CurrentScreenOptions.mdx | 69 ++++++++++++------ .../Types/interfaces/EnterpriseConnection.mdx | 21 ++---- .../API-Reference/Types/interfaces/Error.mdx | 2 +- .../Types/interfaces/ErrorItem.mdx | 10 +-- .../Types/interfaces/ErrorsResult.mdx | 6 +- .../Types/interfaces/FlattenedTheme.mdx | 10 +-- .../interfaces/InterstitialCaptchaMembers.mdx | 2 +- .../MfaPhoneChallengeContinueOptions.mdx | 2 +- .../MfaPhoneEnrollmentContinueOptions.mdx | 2 +- .../Types/interfaces/MfaPollingResult.mdx | 12 ++-- .../interfaces/MfaPushPollingControl.mdx | 6 +- .../Types/interfaces/OrganizationMembers.mdx | 19 ++--- .../Types/interfaces/Organizations.mdx | 6 +- .../Types/interfaces/PasskeyCreate.mdx | 70 +++++++------------ .../interfaces/PasskeyCreateResponse.mdx | 4 +- .../interfaces/PasswordComplexityRule.mdx | 22 ++---- .../Types/interfaces/PasswordPolicy.mdx | 4 +- .../interfaces/PasswordValidationResult.mdx | 2 +- .../interfaces/PhoneEnrollmentOptions.mdx | 2 +- .../interfaces/ReportBrowserErrorOptions.mdx | 16 ++--- .../Types/interfaces/ResendControl.mdx | 2 +- ...sswordMfaPhoneChallengeContinueOptions.mdx | 2 +- ...aPhoneChallengeTryAnotherMethodOptions.mdx | 2 +- .../Types/interfaces/ScreenMembers.mdx | 14 ++-- .../ScreenMembersOnAcceptInvitation.mdx | 24 ++++--- .../interfaces/ScreenMembersOnConsent.mdx | 16 ++--- .../ScreenMembersOnCustomizedConsent.mdx | 18 ++--- .../ScreenMembersOnDeviceCodeConfirmation.mdx | 23 +++--- ...creenMembersOnEmailIdentifierChallenge.mdx | 27 ++++--- .../ScreenMembersOnEmailOTPChallenge.mdx | 14 ++-- ...ScreenMembersOnEmailVerificationResult.mdx | 42 ++++------- .../Types/interfaces/ScreenMembersOnLogin.mdx | 27 ++++--- .../interfaces/ScreenMembersOnLoginId.mdx | 30 ++++---- .../ScreenMembersOnLoginPassword.mdx | 29 ++++---- ...eenMembersOnLoginPasswordlessEmailCode.mdx | 30 ++++---- ...ScreenMembersOnLoginPasswordlessSmsOtp.mdx | 38 +++++----- .../ScreenMembersOnMfaCountryCodes.mdx | 35 +++------- .../ScreenMembersOnMfaEmailChallenge.mdx | 24 ++++--- .../ScreenMembersOnMfaEmailList.mdx | 35 +++------- .../ScreenMembersOnMfaEnrollResult.mdx | 39 +++-------- .../ScreenMembersOnMfaLoginOptions.mdx | 35 +++------- .../ScreenMembersOnMfaOtpChallenge.mdx | 23 +++--- .../ScreenMembersOnMfaOtpEnrollmentCode.mdx | 35 +++------- .../ScreenMembersOnMfaOtpEnrollmentQr.mdx | 23 +++--- .../ScreenMembersOnMfaPhoneChallenge.mdx | 35 +++------- .../ScreenMembersOnMfaPushChallengePush.mdx | 42 ++++------- .../ScreenMembersOnMfaPushEnrollmentQr.mdx | 27 ++++--- .../ScreenMembersOnMfaPushWelcome.mdx | 40 +++++------ ...mbersOnMfaRecoveryCodeChallengeNewCode.mdx | 36 +++------- ...reenMembersOnMfaRecoveryCodeEnrollment.mdx | 35 +++------- .../ScreenMembersOnMfaSmsChallenge.mdx | 49 ++++--------- .../ScreenMembersOnMfaSmsEnrollment.mdx | 23 +++--- .../ScreenMembersOnMfaVoiceChallenge.mdx | 51 ++++---------- ...nMembersOnMfaWebAuthnChangeKeyNickname.mdx | 48 +++---------- ...nMembersOnMfaWebAuthnEnrollmentSuccess.mdx | 57 ++++----------- .../ScreenMembersOnMfaWebAuthnError.mdx | 42 ++++------- ...nMembersOnMfaWebAuthnPlatformChallenge.mdx | 26 +++---- ...MembersOnMfaWebAuthnPlatformEnrollment.mdx | 29 +++++--- ...enMembersOnMfaWebAuthnRoamingChallenge.mdx | 28 +++++--- ...nMembersOnMfaWebAuthnRoamingEnrollment.mdx | 31 +++++--- .../ScreenMembersOnOrganizationSelection.mdx | 14 ++-- .../ScreenMembersOnPasskeyEnrollment.mdx | 33 +++++---- .../ScreenMembersOnPasskeyEnrollmentLocal.mdx | 29 +++++--- ...creenMembersOnPhoneIdentifierChallenge.mdx | 33 ++++++--- ...reenMembersOnPhoneIdentifierEnrollment.mdx | 27 +++---- .../ScreenMembersOnResetPassword.mdx | 23 +++--- .../ScreenMembersOnResetPasswordEmail.mdx | 23 +++--- .../ScreenMembersOnResetPasswordError.mdx | 23 +++--- ...embersOnResetPasswordMfaEmailChallenge.mdx | 23 +++--- ...embersOnResetPasswordMfaPhoneChallenge.mdx | 35 +++------- ...ersOnResetPasswordMfaPushChallengePush.mdx | 24 ++++--- ...nMembersOnResetPasswordMfaSmsChallenge.mdx | 40 ++++------- ...embersOnResetPasswordMfaVoiceChallenge.mdx | 42 ++++------- ...etPasswordMfaWebAuthnPlatformChallenge.mdx | 27 +++---- ...setPasswordMfaWebAuthnRoamingChallenge.mdx | 26 +++---- .../ScreenMembersOnResetPasswordRequest.mdx | 27 ++++--- .../ScreenMembersOnResetPasswordSuccess.mdx | 14 ++-- .../interfaces/ScreenMembersOnSignup.mdx | 16 ++--- .../interfaces/ScreenMembersOnSignupId.mdx | 16 ++--- .../ScreenMembersOnSignupPassword.mdx | 31 ++++---- .../Types/interfaces/StartResendOptions.mdx | 2 +- .../Types/interfaces/SubmitCodeOptions.mdx | 2 +- .../Types/interfaces/TenantMembers.mdx | 8 +-- .../Types/interfaces/TransactionMembers.mdx | 12 ++-- .../interfaces/TransactionMembersOnLogin.mdx | 16 ++--- .../TransactionMembersOnLoginId.mdx | 16 ++--- .../TransactionMembersOnLoginPassword.mdx | 12 ++-- ...ionMembersOnLoginPasswordlessEmailCode.mdx | 14 ++-- ...actionMembersOnLoginPasswordlessSmsOtp.mdx | 12 ++-- .../TransactionMembersOnResetPassword.mdx | 14 ++-- ...ansactionMembersOnResetPasswordRequest.mdx | 16 ++--- .../interfaces/TransactionMembersOnSignup.mdx | 20 +++--- .../TransactionMembersOnSignupId.mdx | 18 ++--- .../TransactionMembersOnSignupPassword.mdx | 18 ++--- .../Types/interfaces/UntrustedDataMembers.mdx | 17 +++-- ...ntrustedDataMembersOnMfaEmailChallenge.mdx | 23 +++--- .../UntrustedDataMembersOnMfaOtpChallenge.mdx | 23 +++--- ...ustedDataMembersOnMfaPushChallengePush.mdx | 23 +++--- .../UntrustedDataMembersOnMfaSmsChallenge.mdx | 23 +++--- ...ntrustedDataMembersOnMfaVoiceChallenge.mdx | 23 +++--- .../Types/interfaces/UseErrorOptions.mdx | 4 +- .../Types/interfaces/UseErrorsResult.mdx | 14 ++-- .../Types/interfaces/UseResendOptions.mdx | 8 +-- .../Types/interfaces/UseResendReturn.mdx | 10 +-- .../Types/interfaces/UserMembers.mdx | 37 +++++----- .../Types/interfaces/UsernamePolicy.mdx | 11 +-- .../interfaces/UsernameValidationResult.mdx | 2 +- .../Types/type-aliases/ErrorKind.mdx | 2 +- 204 files changed, 2741 insertions(+), 3048 deletions(-) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useAuth0Themes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useAuth0Themes.mdx index b3654bb87..9e725de79 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useAuth0Themes.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useAuth0Themes.mdx @@ -4,7 +4,7 @@ title: "useAuth0Themes" > **useAuth0Themes**(): [`FlattenedTheme`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme) \| `null` -Defined in: [packages/auth0-acul-react/src/hooks/common/auth0-themes.ts:50](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/auth0-themes.ts#L50) +Defined in: [packages/auth0-acul-react/src/hooks/common/auth0-themes.ts:50](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/auth0-themes.ts#L50) React hook to get the current theme options with flattened configuration from branding context. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useCurrentScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useCurrentScreen.mdx index a61fdc65a..5873e8c5b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useCurrentScreen.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useCurrentScreen.mdx @@ -4,7 +4,7 @@ title: "useCurrentScreen" > **useCurrentScreen**(): [`CurrentScreenOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions) \| `null` -Defined in: [packages/auth0-acul-react/src/hooks/common/current-screen.ts:76](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/current-screen.ts#L76) +Defined in: [packages/auth0-acul-react/src/hooks/common/current-screen.ts:76](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/current-screen.ts#L76) React hook that gets the current screen context and state. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useErrors.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useErrors.mdx index 0a8037bd1..474caa361 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useErrors.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useErrors.mdx @@ -4,7 +4,7 @@ title: "useErrors" > **useErrors**(`options`): [`UseErrorsResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult) -Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:134](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L134) +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:134](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L134) React hook for reading and managing errors in ACUL (Advanced Customization of Universal Login). With all validation and server-side errors. It groups errors into three kinds: diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useLoginIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useLoginIdentifiers.mdx index 8c7c6e079..95c0440e4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useLoginIdentifiers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useLoginIdentifiers.mdx @@ -4,7 +4,7 @@ title: "useLoginIdentifiers" > **useLoginIdentifiers**(): [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] -Defined in: [packages/auth0-acul-react/src/hooks/utility/login-identifiers.ts:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/login-identifiers.ts#L34) +Defined in: [packages/auth0-acul-react/src/hooks/utility/login-identifiers.ts:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/login-identifiers.ts#L34) Returns a list of active identifier types (such as `'email'`, `'phone'`, or `'username'`) currently in use in the authentication flow or login process. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useMfaPolling.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useMfaPolling.mdx index e419f3072..750ce45da 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useMfaPolling.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useMfaPolling.mdx @@ -4,7 +4,7 @@ title: "useMfaPolling" > **useMfaPolling**(`options?`): [`MfaPollingResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult) -Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:106](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L106) +Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:106](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L106) React hook to manage MFA push polling (e.g., waiting for a push notification approval) on an Auth0 Advanced Customization of Universal Login (ACUL) screen. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/usePasswordValidation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/usePasswordValidation.mdx index dc24a0dae..ec2f196a2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/usePasswordValidation.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/usePasswordValidation.mdx @@ -4,7 +4,7 @@ title: "usePasswordValidation" > **usePasswordValidation**(`password`, `options?`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult) -Defined in: [packages/auth0-acul-react/src/hooks/utility/validate-password.ts:43](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/validate-password.ts#L43) +Defined in: [packages/auth0-acul-react/src/hooks/utility/validate-password.ts:43](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/validate-password.ts#L43) This React hook validates a password against the current Auth0 password policy and returns a structured result describing whether the password satisfies each rule. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useResend.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useResend.mdx index 814401717..73663276f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useResend.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useResend.mdx @@ -4,7 +4,7 @@ title: "useResend" > **useResend**(`options?`): [`UseResendReturn`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn) -Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:87](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L87) +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:87](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L87) This React hook manages "resend" actions (e.g., resending a verification code) on ACUL screens. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useSignupIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useSignupIdentifiers.mdx index 51560828a..bf774e47b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useSignupIdentifiers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useSignupIdentifiers.mdx @@ -4,7 +4,7 @@ title: "useSignupIdentifiers" > **useSignupIdentifiers**(): \[\] \| [`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier)[] -Defined in: [packages/auth0-acul-react/src/hooks/utility/signup-identifiers.ts:42](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/signup-identifiers.ts#L42) +Defined in: [packages/auth0-acul-react/src/hooks/utility/signup-identifiers.ts:42](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/signup-identifiers.ts#L42) Returns a list of enabled identifiers (email, phone, or username), each with its `required` status, based on the current screen's signup identifiers. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useUsernameValidation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useUsernameValidation.mdx index 44be74332..21066609c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useUsernameValidation.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useUsernameValidation.mdx @@ -4,7 +4,7 @@ title: "useUsernameValidation" > **useUsernameValidation**(`username`, `options?`): [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult) -Defined in: [packages/auth0-acul-react/src/hooks/utility/validate-username.ts:65](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/validate-username.ts#L65) +Defined in: [packages/auth0-acul-react/src/hooks/utility/validate-username.ts:65](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/validate-username.ts#L65) React hook for validating a username against the current Auth0 username policy. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index.mdx index 450c61260..128ffc5f9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index.mdx @@ -4,10 +4,10 @@ title: "accept-invitation" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation">ScreenMembersOnAcceptInvitation</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation">ScreenMembersOnAcceptInvitation</a></span>}> > **useScreen**: () => [`ScreenMembersOnAcceptInvitation`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation) -Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='acceptInvitation' type={<span>void | Promise<void></span>}> > **acceptInvitation**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L34) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:34](htt <ParamField body='useAcceptInvitation' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers">AcceptInvitationMembers</a>}> > **useAcceptInvitation**(): [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers) -Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L49) +Defined in: [packages/auth0-acul-react/src/screens/accept-invitation.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L49) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index.mdx index ef330bf21..5834e51ed 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index.mdx @@ -4,10 +4,10 @@ title: "consent" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L21) +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L21) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L22) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L23) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L24) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent">ScreenMembersOnConsent</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent">ScreenMembersOnConsent</a></span>}> > **useScreen**: () => [`ScreenMembersOnConsent`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent) -Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L25) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L20) +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L20) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L26) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L27) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L19) +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L19) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='accept' type={<span>void | Promise<void></span>}> > **accept**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L31) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:31](https://githu <ParamField body='deny' type={<span>void | Promise<void></span>}> > **deny**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L32) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:32](https://githu <ParamField body='useConsent' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers">ConsentMembers</a>}> > **useConsent**(): [`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers) -Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:46](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/consent.tsx#L46) +Defined in: [packages/auth0-acul-react/src/screens/consent.tsx:46](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L46) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index.mdx index a62484306..d6a7d6b70 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index.mdx @@ -4,10 +4,10 @@ title: "customized-consent" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent">ScreenMembersOnCustomizedConsent</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent">ScreenMembersOnCustomizedConsent</a></span>}> > **useScreen**: () => [`ScreenMembersOnCustomizedConsent`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent) -Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='accept' type={<span>void | Promise<void></span>}> > **accept**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L34) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:34](ht <ParamField body='deny' type={<span>void | Promise<void></span>}> > **deny**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L35) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:35](ht <ParamField body='useCustomizedConsent' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers">CustomizedConsentMembers</a>}> > **useCustomizedConsent**(): [`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers) -Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/customized-consent.tsx#L49) +Defined in: [packages/auth0-acul-react/src/screens/customized-consent.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L49) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index.mdx index 8c6cf1e10..6b5d2069b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index.mdx @@ -4,10 +4,10 @@ title: "device-code-activation-allowed" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L17) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L17) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L18) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L18) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L19) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L19) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L20) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L20) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L21) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L21) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L16) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L16) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L22) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L23) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L15) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L15) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='useDeviceCodeActivationAllowed' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers">DeviceCodeActivationAllowedMembers</a>}> > **useDeviceCodeActivationAllowed**(): [`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L38) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index.mdx index 2a8981e79..6331fd739 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index.mdx @@ -4,10 +4,10 @@ title: "device-code-activation-denied" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L17) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L17) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L18) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L18) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L19) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L19) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L20) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L20) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L21) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L21) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L16) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L16) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L22) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L23) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L15) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L15) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='useDeviceCodeActivationDenied' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers">DeviceCodeActivationDeniedMembers</a>}> > **useDeviceCodeActivationDenied**(): [`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L38) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index.mdx index a768b46c5..0cdbf80c6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index.mdx @@ -4,10 +4,10 @@ title: "device-code-activation" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L34) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:34 <ParamField body='useDeviceCodeActivation' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers">DeviceCodeActivationMembers</a>}> > **useDeviceCodeActivation**(): [`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L48) +Defined in: [packages/auth0-acul-react/src/screens/device-code-activation.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L48) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index.mdx index ba78e0857..08ec84866 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index.mdx @@ -4,10 +4,10 @@ title: "device-code-confirmation" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation">ScreenMembersOnDeviceCodeConfirmation</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation">ScreenMembersOnDeviceCodeConfirmation</a></span>}> > **useScreen**: () => [`ScreenMembersOnDeviceCodeConfirmation`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation) -Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='cancel' type={<span>void | Promise<void></span>}> > **cancel**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L35) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx: <ParamField body='confirm' type={<span>void | Promise<void></span>}> > **confirm**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L34) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx: <ParamField body='useDeviceCodeConfirmation' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers">DeviceCodeConfirmationMembers</a>}> > **useDeviceCodeConfirmation**(): [`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers) -Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L49) +Defined in: [packages/auth0-acul-react/src/screens/device-code-confirmation.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L49) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index.mdx index 539637542..f5f1857d6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index.mdx @@ -4,10 +4,10 @@ title: "email-identifier-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge">ScreenMembersOnEmailIdentifierChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge">ScreenMembersOnEmailIdentifierChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnEmailIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge) -Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='resendCode' type={<span>void | Promise<void></span>}> > **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.ts <ParamField body='returnToPrevious' type={<span>void | Promise<void></span>}> > **returnToPrevious**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L38) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.ts <ParamField body='submitEmailChallenge' type={<span>void | Promise<void></span>}> > **submitEmailChallenge**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L35) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.ts <ParamField body='useEmailIdentifierChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers">EmailIdentifierChallengeMembers</a>}> > **useEmailIdentifierChallenge**(): [`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:56](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L56) +Defined in: [packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx:56](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L56) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index.mdx index 234f9a5e1..8ee5c83c6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index.mdx @@ -4,10 +4,10 @@ title: "email-otp-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge">ScreenMembersOnEmailOTPChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge">ScreenMembersOnEmailOTPChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnEmailOTPChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge) -Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='resendCode' type={<span>void | Promise<void></span>}> > **resendCode**(`options?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L36) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:36](h <ParamField body='submitCode' type={<span>void | Promise<void></span>}> > **submitCode**(`options`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L35) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:35](h <ParamField body='useEmailOTPChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers">EmailOTPChallengeMembers</a>}> > **useEmailOTPChallenge**(): [`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L53) +Defined in: [packages/auth0-acul-react/src/screens/email-otp-challenge.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L53) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index.mdx index 8583b8746..4c9312184 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index.mdx @@ -4,10 +4,10 @@ title: "email-verification-result" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L17) +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L17) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L18) +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L18) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L19) +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L19) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L20) +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L20) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult">ScreenMembersOnEmailVerificationResult</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult">ScreenMembersOnEmailVerificationResult</a></span>}> > **useScreen**: () => [`ScreenMembersOnEmailVerificationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult) -Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L21) +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L21) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L16) +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L16) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L22) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L23) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L15) +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L15) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='useEmailVerificationResult' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers">EmailVerificationResultMembers</a>}> > **useEmailVerificationResult**(): [`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers) -Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/email-verification-result.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L38) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index.mdx index 030c934e7..adbb0cf0d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index.mdx @@ -4,10 +4,10 @@ title: "interstitial-captcha" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L17) +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L17) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L18) +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L18) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L19) +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L19) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L20) +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L20) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L21) +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L21) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L16) +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L16) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L22) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L23) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L15) +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L15) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='useInterstitialCaptcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers">InterstitialCaptchaMembers</a>}> > **useInterstitialCaptcha**(): [`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers) -Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/interstitial-captcha.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L38) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index.mdx index 3a5fd4417..b5decc8c9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index.mdx @@ -4,10 +4,10 @@ title: "login-email-verification" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueWithCode' type={<span>void | Promise<void></span>}> > **continueWithCode**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L35) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx: <ParamField body='resendCode' type={<span>void | Promise<void></span>}> > **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L37) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx: <ParamField body='useLoginEmailVerification' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers">LoginEmailVerificationMembers</a>}> > **useLoginEmailVerification**(): [`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L54) +Defined in: [packages/auth0-acul-react/src/screens/login-email-verification.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L54) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index.mdx index b433e1959..869fa21da 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index.mdx @@ -4,10 +4,10 @@ title: "login-id" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L26) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L27) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L28) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L29) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId">ScreenMembersOnLoginId</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId">ScreenMembersOnLoginId</a></span>}> > **useScreen**: () => [`ScreenMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId) -Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L30) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L25) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId">TransactionMembersOnLoginId</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId">TransactionMembersOnLoginId</a></span>}> > **useTransaction**: () => [`TransactionMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId) -Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L31) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L32) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L24) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='federatedLogin' type={<span>void | Promise<void></span>}> > **federatedLogin**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:37](https://gith <ParamField body='login' type={<span>void | Promise<void></span>}> > **login**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L36) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:36](https://gith <ParamField body='passkeyLogin' type={<span>void | Promise<void></span>}> > **passkeyLogin**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L39) +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L39) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:39](https://gith <ParamField body='pickCountryCode' type={<span>void | Promise<void></span>}> > **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L40) +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L40) **Parameters** @@ -284,7 +284,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:40](https://gith <ParamField body='useLoginId' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers">LoginIdMembers</a>}> > **useLoginId**(): [`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-id.tsx#L58) +Defined in: [packages/auth0-acul-react/src/screens/login-id.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L58) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index.mdx index 6b8406919..6e5babda1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index.mdx @@ -4,10 +4,10 @@ title: "login-password" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword">ScreenMembersOnLoginPassword</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword">ScreenMembersOnLoginPassword</a></span>}> > **useScreen**: () => [`ScreenMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword) -Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword">TransactionMembersOnLoginPassword</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword">TransactionMembersOnLoginPassword</a></span>}> > **useTransaction**: () => [`TransactionMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword) -Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='federatedLogin' type={<span>void | Promise<void></span>}> > **federatedLogin**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L36) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:36](https: <ParamField body='login' type={<span>void | Promise<void></span>}> > **login**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L35) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:35](https: <ParamField body='useLoginPassword' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers">LoginPasswordMembers</a>}> > **useLoginPassword**(): [`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-password.tsx#L51) +Defined in: [packages/auth0-acul-react/src/screens/login-password.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L51) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index.mdx index 7e50dbd73..a53b126a0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index.mdx @@ -4,10 +4,10 @@ title: "login-passwordless-email-code" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode">ScreenMembersOnLoginPasswordlessEmailCode</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode">ScreenMembersOnLoginPasswordlessEmailCode</a></span>}> > **useScreen**: () => [`ScreenMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode">TransactionMembersOnLoginPasswordlessEmailCode</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode">TransactionMembersOnLoginPasswordlessEmailCode</a></span>}> > **useTransaction**: () => [`TransactionMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='resendCode' type={<span>void | Promise<void></span>}> > **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L36) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code <ParamField body='submitCode' type={<span>void | Promise<void></span>}> > **submitCode**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L35) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code <ParamField body='useLoginPasswordlessEmailCode' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers">LoginPasswordlessEmailCodeMembers</a>}> > **useLoginPasswordlessEmailCode**(): [`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L53) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L53) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index.mdx index 2c8727996..dbf82de0b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index.mdx @@ -4,10 +4,10 @@ title: "login-passwordless-sms-otp" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp">ScreenMembersOnLoginPasswordlessSmsOtp</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp">ScreenMembersOnLoginPasswordlessSmsOtp</a></span>}> > **useScreen**: () => [`ScreenMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp">TransactionMembersOnLoginPasswordlessSmsOtp</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp">TransactionMembersOnLoginPasswordlessSmsOtp</a></span>}> > **useTransaction**: () => [`TransactionMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='resendOTP' type={<span>void | Promise<void></span>}> > **resendOTP**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L36) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.ts <ParamField body='submitOTP' type={<span>void | Promise<void></span>}> > **submitOTP**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L35) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.ts <ParamField body='useLoginPasswordlessSmsOtp' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers">LoginPasswordlessSmsOtpMembers</a>}> > **useLoginPasswordlessSmsOtp**(): [`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers) -Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L53) +Defined in: [packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L53) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index.mdx index 39276616e..632411fbd 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index.mdx @@ -4,10 +4,10 @@ title: "login" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/login.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L26) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/login.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L27) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/login.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L28) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/login.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L29) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin">ScreenMembersOnLogin</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin">ScreenMembersOnLogin</a></span>}> > **useScreen**: () => [`ScreenMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin) -Defined in: [packages/auth0-acul-react/src/screens/login.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L30) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/login.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L25) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin">TransactionMembersOnLogin</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin">TransactionMembersOnLogin</a></span>}> > **useTransaction**: () => [`TransactionMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin) -Defined in: [packages/auth0-acul-react/src/screens/login.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L31) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/login.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L32) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/login.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L24) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='federatedLogin' type={<span>void | Promise<void></span>}> > **federatedLogin**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/login.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login.tsx:37](https://github. <ParamField body='login' type={<span>void | Promise<void></span>}> > **login**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/login.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L36) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login.tsx:36](https://github. <ParamField body='pickCountryCode' type={<span>void | Promise<void></span>}> > **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/login.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L39) +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L39) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/login.tsx:39](https://github. <ParamField body='useLogin' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers">LoginMembers</a>}> > **useLogin**(): [`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers) -Defined in: [packages/auth0-acul-react/src/screens/login.tsx:57](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/login.tsx#L57) +Defined in: [packages/auth0-acul-react/src/screens/login.tsx:57](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L57) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index.mdx index eeef16434..ab17282b6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index.mdx @@ -4,10 +4,10 @@ title: "logout-aborted" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L17) +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L17) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L18) +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L18) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L19) +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L19) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L20) +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L20) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L21) +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L21) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L16) +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L16) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L22) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L23) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L15) +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L15) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='useLogoutAborted' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers">LogoutAbortedMembers</a>}> > **useLogoutAborted**(): [`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/logout-aborted.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L38) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index.mdx index 8d2ee3773..67de057e9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index.mdx @@ -4,10 +4,10 @@ title: "logout-complete" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L17) +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L17) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L18) +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L18) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L19) +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L19) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L20) +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L20) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L21) +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L21) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L16) +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L16) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L22) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L23) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L15) +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L15) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='useLogoutComplete' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers">LogoutCompleteMembers</a>}> > **useLogoutComplete**(): [`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout-complete.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/logout-complete.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L38) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index.mdx index 4c0b6b78e..078b68008 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index.mdx @@ -4,10 +4,10 @@ title: "logout" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L21) +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L21) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L22) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L23) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L24) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L25) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L20) +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L20) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L26) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L27) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L19) +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L19) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='confirmLogout' type={<span>void | Promise<void></span>}> > **confirmLogout**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L31) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:31](https://github <ParamField body='useLogout' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers">LogoutMembers</a>}> > **useLogout**(): [`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers) -Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:46](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/logout.tsx#L46) +Defined in: [packages/auth0-acul-react/src/screens/logout.tsx:46](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L46) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index.mdx index 2e55b40af..a66af1d42 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index.mdx @@ -4,10 +4,10 @@ title: "mfa-begin-enroll-options" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='enroll' type={<span>void | Promise<void></span>}> > **enroll**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L34) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx: <ParamField body='useMfaBeginEnrollOptions' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers">MfaBeginEnrollOptionsMembers</a>}> > **useMfaBeginEnrollOptions**(): [`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L48) +Defined in: [packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L48) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index.mdx index acf3f1a31..f3c25c710 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index.mdx @@ -4,10 +4,10 @@ title: "mfa-country-codes" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes">ScreenMembersOnMfaCountryCodes</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes">ScreenMembersOnMfaCountryCodes</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaCountryCodes`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes) -Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='goBack' type={<span>void | Promise<void></span>}> > **goBack**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:37](htt <ParamField body='selectCountryCode' type={<span>void | Promise<void></span>}> > **selectCountryCode**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L35) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:35](htt <ParamField body='useMfaCountryCodes' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers">MfaCountryCodesMembers</a>}> > **useMfaCountryCodes**(): [`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L51) +Defined in: [packages/auth0-acul-react/src/screens/mfa-country-codes.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L51) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index.mdx index 64b189cd4..1fadd8406 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index.mdx @@ -4,10 +4,10 @@ title: "mfa-detect-browser-capabilities" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='detectCapabilities' type={<span>void | Promise<void></span>}> > **detectCapabilities**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L34) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabiliti <ParamField body='useMfaDetectBrowserCapabilities' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers">MfaDetectBrowserCapabilitiesMembers</a>}> > **useMfaDetectBrowserCapabilities**(): [`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L49) +Defined in: [packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L49) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index.mdx index 9ca9e5a81..ad2733929 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index.mdx @@ -4,10 +4,10 @@ title: "mfa-email-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L27) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L28) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L29) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L30) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge">ScreenMembersOnMfaEmailChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge">ScreenMembersOnMfaEmailChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L31) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L26) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L32) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge">UntrustedDataMembersOnMfaEmailChallenge</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge">UntrustedDataMembersOnMfaEmailChallenge</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L33) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L33) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L25) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:37](h <ParamField body='pickEmail' type={<span>void | Promise<void></span>}> > **pickEmail**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:41](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L41) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:41](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L41) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:41](h <ParamField body='resendCode' type={<span>void | Promise<void></span>}> > **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L38) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:38](h <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L39) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L39) **Parameters** @@ -284,7 +284,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:39](h <ParamField body='useMfaEmailChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers">MfaEmailChallengeMembers</a>}> > **useMfaEmailChallenge**(): [`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L58) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L58) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index.mdx index 57249a030..61fb62b53 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index.mdx @@ -4,10 +4,10 @@ title: "mfa-email-list" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList">ScreenMembersOnMfaEmailList</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList">ScreenMembersOnMfaEmailList</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaEmailList`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='goBack' type={<span>void | Promise<void></span>}> > **goBack**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:37](https: <ParamField body='selectMfaEmail' type={<span>void | Promise<void></span>}> > **selectMfaEmail**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L35) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:35](https: <ParamField body='useMfaEmailList' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers">MfaEmailListMembers</a>}> > **useMfaEmailList**(): [`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L51) +Defined in: [packages/auth0-acul-react/src/screens/mfa-email-list.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L51) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index.mdx index bd6a33139..9f54c782f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index.mdx @@ -4,10 +4,10 @@ title: "mfa-enroll-result" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L17) +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L17) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L18) +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L18) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L19) +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L19) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L20) +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L20) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult">ScreenMembersOnMfaEnrollResult</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult">ScreenMembersOnMfaEnrollResult</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaEnrollResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult) -Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L21) +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L21) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L16) +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L16) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L22) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L23) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L15) +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L15) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='useMfaEnrollResult' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers">MfaEnrollResultMembers</a>}> > **useMfaEnrollResult**(): [`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L38) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index.mdx index 8ebf52731..97afc3091 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index.mdx @@ -4,10 +4,10 @@ title: "mfa-login-options" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions">ScreenMembersOnMfaLoginOptions</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions">ScreenMembersOnMfaLoginOptions</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions) -Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='enroll' type={<span>void | Promise<void></span>}> > **enroll**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L35) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:35](htt <ParamField body='returnToPrevious' type={<span>void | Promise<void></span>}> > **returnToPrevious**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L36) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:36](htt <ParamField body='useMfaLoginOptions' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers">MfaLoginOptionsMembers</a>}> > **useMfaLoginOptions**(): [`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L51) +Defined in: [packages/auth0-acul-react/src/screens/mfa-login-options.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L51) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index.mdx index 9ca8dfc7f..31b204f73 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index.mdx @@ -4,10 +4,10 @@ title: "mfa-otp-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge">ScreenMembersOnMfaOtpChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge">ScreenMembersOnMfaOtpChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge">UntrustedDataMembersOnMfaOtpChallenge</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge">UntrustedDataMembersOnMfaOtpChallenge</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L35) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:35](htt <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L36) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:36](htt <ParamField body='useMfaOtpChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers">MfaOtpChallengeMembers</a>}> > **useMfaOtpChallenge**(): [`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L51) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L51) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index.mdx index 19714c08e..1099019b9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index.mdx @@ -4,10 +4,10 @@ title: "mfa-otp-enrollment-code" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode">ScreenMembersOnMfaOtpEnrollmentCode</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode">ScreenMembersOnMfaOtpEnrollmentCode</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaOtpEnrollmentCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L35) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:3 <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L36) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:3 <ParamField body='useMfaOtpEnrollmentCode' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers">MfaOtpEnrollmentCodeMembers</a>}> > **useMfaOtpEnrollmentCode**(): [`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L51) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L51) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index.mdx index 72900b2d2..95f80539e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index.mdx @@ -4,10 +4,10 @@ title: "mfa-otp-enrollment-qr" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr">ScreenMembersOnMfaOtpEnrollmentQr</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr">ScreenMembersOnMfaOtpEnrollmentQr</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaOtpEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L36) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:36] <ParamField body='toggleView' type={<span>void | Promise<void></span>}> > **toggleView**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L35) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:35] <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L37) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:37] <ParamField body='useMfaOtpEnrollmentQr' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers">MfaOtpEnrollmentQrMembers</a>}> > **useMfaOtpEnrollmentQr**(): [`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L52) +Defined in: [packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L52) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index.mdx index d601b09f7..265e07262 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index.mdx @@ -4,10 +4,10 @@ title: "mfa-phone-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L26) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L27) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L28) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L29) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge">ScreenMembersOnMfaPhoneChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge">ScreenMembersOnMfaPhoneChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L30) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L25) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L31) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L32) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L24) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L36) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:36](h <ParamField body='pickPhone' type={<span>void | Promise<void></span>}> > **pickPhone**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L37) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:37](h <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L38) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:38](h <ParamField body='useMfaPhoneChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers">MfaPhoneChallengeMembers</a>}> > **useMfaPhoneChallenge**(): [`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L53) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L53) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index.mdx index c3e9f2e6c..0506abe76 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index.mdx @@ -4,10 +4,10 @@ title: "mfa-phone-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueEnrollment' type={<span>void | Promise<void></span>}> > **continueEnrollment**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:37]( <ParamField body='pickCountryCode' type={<span>void | Promise<void></span>}> > **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L35) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:35]( <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L39) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L39) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:39]( <ParamField body='useMfaPhoneEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers">MfaPhoneEnrollmentMembers</a>}> > **useMfaPhoneEnrollment**(): [`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L54) +Defined in: [packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L54) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index.mdx index 9c906acd5..892fee4c2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index.mdx @@ -4,10 +4,10 @@ title: "mfa-push-challenge-push" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush">ScreenMembersOnMfaPushChallengePush</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush">ScreenMembersOnMfaPushChallengePush</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush">UntrustedDataMembersOnMfaPushChallengePush</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush">UntrustedDataMembersOnMfaPushChallengePush</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L35) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:3 <ParamField body='enterCodeManually' type={<span>void | Promise<void></span>}> > **enterCodeManually**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L39) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L39) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:3 <ParamField body='resendPushNotification' type={<span>void | Promise<void></span>}> > **resendPushNotification**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L37) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:3 <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:41](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L41) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:41](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L41) **Parameters** @@ -284,7 +284,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:4 <ParamField body='useMfaPushChallengePush' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers">MfaPushChallengePushMembers</a>}> > **useMfaPushChallengePush**(): [`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L59) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L59) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index.mdx index 47e029a92..ff67f3a41 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index.mdx @@ -4,10 +4,10 @@ title: "mfa-push-enrollment-qr" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr">ScreenMembersOnMfaPushEnrollmentQr</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr">ScreenMembersOnMfaPushEnrollmentQr</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaPushEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='pickAuthenticator' type={<span>void | Promise<void></span>}> > **pickAuthenticator**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L34) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:34 <ParamField body='useMfaPushEnrollmentQr' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers">MfaPushEnrollmentQrMembers</a>}> > **useMfaPushEnrollmentQr**(): [`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L52) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L52) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index.mdx index f590b27cf..6ce2a2ad4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index.mdx @@ -4,10 +4,10 @@ title: "mfa-push-list" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='goBack' type={<span>void | Promise<void></span>}> > **goBack**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:37](https:/ <ParamField body='selectMfaPushDevice' type={<span>void | Promise<void></span>}> > **selectMfaPushDevice**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L35) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:35](https:/ <ParamField body='useMfaPushList' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers">MfaPushListMembers</a>}> > **useMfaPushList**(): [`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L51) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-list.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L51) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index.mdx index d95d4f404..72ad3be22 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index.mdx @@ -4,10 +4,10 @@ title: "mfa-push-welcome" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L21) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L21) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L22) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L23) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L24) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome">ScreenMembersOnMfaPushWelcome</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome">ScreenMembersOnMfaPushWelcome</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaPushWelcome`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L25) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L20) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L20) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L26) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L27) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L19) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L19) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='enroll' type={<span>void | Promise<void></span>}> > **enroll**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L31) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:31](http <ParamField body='pickAuthenticator' type={<span>void | Promise<void></span>}> > **pickAuthenticator**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L32) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:32](http <ParamField body='useMfaPushWelcome' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers">MfaPushWelcomeMembers</a>}> > **useMfaPushWelcome**(): [`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:47](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L47) +Defined in: [packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx:47](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L47) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index.mdx index c56402f89..41f67da5f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index.mdx @@ -4,10 +4,10 @@ title: "mfa-recovery-code-challenge-new-code" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L26) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L27) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L28) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L29) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode">ScreenMembersOnMfaRecoveryCodeChallengeNewCode</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode">ScreenMembersOnMfaRecoveryCodeChallengeNewCode</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L30) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L25) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L31) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L32) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L24) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L36) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-n <ParamField body='useMfaRecoveryCodeChallengeNewCode' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers">MfaRecoveryCodeChallengeNewCodeMembers</a>}> > **useMfaRecoveryCodeChallengeNewCode**(): [`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:50](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L50) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx:50](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L50) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index.mdx index 951851e5b..01f8afec8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index.mdx @@ -4,10 +4,10 @@ title: "mfa-recovery-code-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L35) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.t <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L36) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.t <ParamField body='useMfaRecoveryCodeChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers">MfaRecoveryCodeChallengeMembers</a>}> > **useMfaRecoveryCodeChallenge**(): [`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L51) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L51) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index.mdx index f5f9be027..a941a1c8a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index.mdx @@ -4,10 +4,10 @@ title: "mfa-recovery-code-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment">ScreenMembersOnMfaRecoveryCodeEnrollment</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment">ScreenMembersOnMfaRecoveryCodeEnrollment</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaRecoveryCodeEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L34) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment. <ParamField body='useMfaRecoveryCodeEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers">MfaRecoveryCodeEnrollmentMembers</a>}> > **useMfaRecoveryCodeEnrollment**(): [`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L49) +Defined in: [packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L49) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index.mdx index 06f3e2cc3..e3da1488c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index.mdx @@ -4,10 +4,10 @@ title: "mfa-sms-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge">ScreenMembersOnMfaSmsChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge">ScreenMembersOnMfaSmsChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge">UntrustedDataMembersOnMfaSmsChallenge</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge">UntrustedDataMembersOnMfaSmsChallenge</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMfaSmsChallenge' type={<span>void | Promise<void></span>}> > **continueMfaSmsChallenge**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L35) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:35](htt <ParamField body='getACall' type={<span>void | Promise<void></span>}> > **getACall**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:41](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L41) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:41](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L41) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:41](htt <ParamField body='pickSms' type={<span>void | Promise<void></span>}> > **pickSms**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L37) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:37](htt <ParamField body='resendCode' type={<span>void | Promise<void></span>}> > **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L38) **Parameters** @@ -284,7 +284,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:38](htt <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L39) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L39) **Parameters** @@ -300,7 +300,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:39](htt <ParamField body='useMfaSmsChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers">MfaSmsChallengeMembers</a>}> > **useMfaSmsChallenge**(): [`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L58) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L58) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index.mdx index 7dac04800..bbac47761 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index.mdx @@ -4,10 +4,10 @@ title: "mfa-sms-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment">ScreenMembersOnMfaSmsEnrollment</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment">ScreenMembersOnMfaSmsEnrollment</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaSmsEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueEnrollment' type={<span>void | Promise<void></span>}> > **continueEnrollment**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L36) **Parameters** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:36](ht <ParamField body='pickCountryCode' type={<span>void | Promise<void></span>}> > **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L34) **Parameters** @@ -258,7 +258,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:34](ht <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L38) **Parameters** @@ -274,7 +274,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:38](ht <ParamField body='useMfaSmsEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers">MfaSmsEnrollmentMembers</a>}> > **useMfaSmsEnrollment**(): [`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L53) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L53) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index.mdx index 73f0e8d9a..d1034104f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index.mdx @@ -4,10 +4,10 @@ title: "mfa-sms-list" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='backAction' type={<span>void | Promise<void></span>}> > **backAction**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:37](https:// <ParamField body='selectPhoneNumber' type={<span>void | Promise<void></span>}> > **selectPhoneNumber**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L35) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:35](https:// <ParamField body='useMfaSmsList' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers">MfaSmsListMembers</a>}> > **useMfaSmsList**(): [`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L51) +Defined in: [packages/auth0-acul-react/src/screens/mfa-sms-list.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L51) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index.mdx index af4dbd01f..4ae0938e3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index.mdx @@ -4,10 +4,10 @@ title: "mfa-voice-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge">ScreenMembersOnMfaVoiceChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge">ScreenMembersOnMfaVoiceChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge">UntrustedDataMembersOnMfaVoiceChallenge</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge">UntrustedDataMembersOnMfaVoiceChallenge</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L35) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:35](h <ParamField body='pickPhone' type={<span>void | Promise<void></span>}> > **pickPhone**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L37) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:37](h <ParamField body='resendCode' type={<span>void | Promise<void></span>}> > **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L39) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L39) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:39](h <ParamField body='switchToSms' type={<span>void | Promise<void></span>}> > **switchToSms**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L38) **Parameters** @@ -284,7 +284,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:38](h <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L40) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L40) **Parameters** @@ -300,7 +300,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:40](h <ParamField body='useMfaVoiceChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers">MfaVoiceChallengeMembers</a>}> > **useMfaVoiceChallenge**(): [`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L58) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L58) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index.mdx index 453bad7f8..82137b55c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index.mdx @@ -4,10 +4,10 @@ title: "mfa-voice-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L35) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:35]( <ParamField body='selectPhoneCountryCode' type={<span>void | Promise<void></span>}> > **selectPhoneCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L38) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:38]( <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L36) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:36]( <ParamField body='useMfaVoiceEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers">MfaVoiceEnrollmentMembers</a>}> > **useMfaVoiceEnrollment**(): [`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L53) +Defined in: [packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L53) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index.mdx index 46ffc76a9..6b1d25f6e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index.mdx @@ -4,10 +4,10 @@ title: "mfa-webauthn-change-key-nickname" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname">ScreenMembersOnMfaWebAuthnChangeKeyNickname</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname">ScreenMembersOnMfaWebAuthnChangeKeyNickname</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueWithNewNickname' type={<span>void | Promise<void></span>}> > **continueWithNewNickname**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L34) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickn <ParamField body='useMfaWebAuthnChangeKeyNickname' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers">MfaWebAuthnChangeKeyNicknameMembers</a>}> > **useMfaWebAuthnChangeKeyNickname**(): [`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L49) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L49) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index.mdx index c37bced55..f95ec7317 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index.mdx @@ -4,10 +4,10 @@ title: "mfa-webauthn-enrollment-success" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess">ScreenMembersOnMfaWebAuthnEnrollmentSuccess</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess">ScreenMembersOnMfaWebAuthnEnrollmentSuccess</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L34) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-succe <ParamField body='useMfaWebAuthnEnrollmentSuccess' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers">MfaWebAuthnEnrollmentSuccessMembers</a>}> > **useMfaWebAuthnEnrollmentSuccess**(): [`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L48) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L48) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index.mdx index 44062688d..44b08b344 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index.mdx @@ -4,10 +4,10 @@ title: "mfa-webauthn-error" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError">ScreenMembersOnMfaWebAuthnError</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError">ScreenMembersOnMfaWebAuthnError</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaWebAuthnError`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='noThanks' type={<span>void | Promise<void></span>}> > **noThanks**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L38) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:38](ht <ParamField body='tryAgain' type={<span>void | Promise<void></span>}> > **tryAgain**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L34) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:34](ht <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L36) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:36](ht <ParamField body='useMfaWebAuthnError' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers">MfaWebAuthnErrorMembers</a>}> > **useMfaWebAuthnError**(): [`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L52) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L52) **Returns** @@ -278,7 +278,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:52](ht <ParamField body='usePassword' type={<span>void | Promise<void></span>}> > **usePassword**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L35) **Parameters** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index.mdx index 0fae02c99..268e71179 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index.mdx @@ -4,10 +4,10 @@ title: "mfa-webauthn-not-available-error" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L34) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-er <ParamField body='useMfaWebAuthnNotAvailableError' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers">MfaWebAuthnNotAvailableErrorMembers</a>}> > **useMfaWebAuthnNotAvailableError**(): [`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L49) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L49) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index.mdx index 019d7fe1d..fad0cf198 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index.mdx @@ -4,10 +4,10 @@ title: "mfa-webauthn-platform-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L26) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L27) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L28) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L29) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge">ScreenMembersOnMfaWebAuthnPlatformChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge">ScreenMembersOnMfaWebAuthnPlatformChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L30) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L25) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L31) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L32) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L24) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='reportBrowserError' type={<span>void | Promise<void></span>}> > **reportBrowserError**(`options`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L38) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challen <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`options?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L40) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L40) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challen <ParamField body='useMfaWebAuthnPlatformChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers">MfaWebAuthnPlatformChallengeMembers</a>}> > **useMfaWebAuthnPlatformChallenge**(): [`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:55](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L55) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:55](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L55) **Returns** @@ -262,7 +262,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challen <ParamField body='verify' type={<span>void | Promise<void></span>}> > **verify**(`options?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L36) **Parameters** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index.mdx index 5204e1ff6..c89b90b9f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index.mdx @@ -4,10 +4,10 @@ title: "mfa-webauthn-platform-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L28) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L29) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L30) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L31) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment">ScreenMembersOnMfaWebAuthnPlatformEnrollment</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment">ScreenMembersOnMfaWebAuthnPlatformEnrollment</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L32) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L27) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L33) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L33) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L34) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L26) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='refuseEnrollmentOnThisDevice' type={<span>void | Promise<void></span>}> > **refuseEnrollmentOnThisDevice**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:44](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L44) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:44](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L44) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollm <ParamField body='reportBrowserError' type={<span>void | Promise<void></span>}> > **reportBrowserError**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L40) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L40) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollm <ParamField body='snoozeEnrollment' type={<span>void | Promise<void></span>}> > **snoozeEnrollment**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:42](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L42) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:42](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L42) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollm <ParamField body='submitPasskeyCredential' type={<span>void | Promise<void></span>}> > **submitPasskeyCredential**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L38) **Parameters** @@ -284,7 +284,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollm <ParamField body='useMfaWebAuthnPlatformEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers">MfaWebAuthnPlatformEnrollmentMembers</a>}> > **useMfaWebAuthnPlatformEnrollment**(): [`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L59) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L59) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index.mdx index 3de87b4e6..916f4ac1f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index.mdx @@ -4,10 +4,10 @@ title: "mfa-webauthn-roaming-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L26) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L27) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L28) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L29) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge">ScreenMembersOnMfaWebAuthnRoamingChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge">ScreenMembersOnMfaWebAuthnRoamingChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L30) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L25) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L31) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L32) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L24) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='reportWebAuthnError' type={<span>void | Promise<void></span>}> > **reportWebAuthnError**(`options`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challeng <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`options?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L39) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L39) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challeng <ParamField body='useMfaWebAuthnRoamingChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers">MfaWebAuthnRoamingChallengeMembers</a>}> > **useMfaWebAuthnRoamingChallenge**(): [`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L54) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L54) **Returns** @@ -262,7 +262,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challeng <ParamField body='verify' type={<span>void | Promise<void></span>}> > **verify**(`options?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L36) **Parameters** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index.mdx index e0eba5ff3..d32389560 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index.mdx @@ -4,10 +4,10 @@ title: "mfa-webauthn-roaming-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L26) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L27) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L28) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L29) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment">ScreenMembersOnMfaWebAuthnRoamingEnrollment</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment">ScreenMembersOnMfaWebAuthnRoamingEnrollment</a></span>}> > **useScreen**: () => [`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L30) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L25) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L31) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L32) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L24) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='enroll' type={<span>void | Promise<void></span>}> > **enroll**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L36) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollme <ParamField body='showError' type={<span>void | Promise<void></span>}> > **showError**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L37) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollme <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L38) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollme <ParamField body='useMfaWebAuthnRoamingEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers">MfaWebAuthnRoamingEnrollmentMembers</a>}> > **useMfaWebAuthnRoamingEnrollment**(): [`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers) -Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L53) +Defined in: [packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L53) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index.mdx index 90f8c84a3..85355cefa 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index.mdx @@ -4,10 +4,10 @@ title: "organization-picker" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='selectOrganization' type={<span>void | Promise<void></span>}> > **selectOrganization**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L34) **Parameters** @@ -242,7 +242,7 @@ Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:34](h <ParamField body='skipOrganizationSelection' type={<span>void | Promise<void></span>}> > **skipOrganizationSelection**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L36) **Parameters** @@ -258,7 +258,7 @@ Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:36](h <ParamField body='useOrganizationPicker' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers">OrganizationPickerMembers</a>}> > **useOrganizationPicker**(): [`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-picker.tsx#L51) +Defined in: [packages/auth0-acul-react/src/screens/organization-picker.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L51) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index.mdx index ccff4ab71..2a9efde6b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index.mdx @@ -4,10 +4,10 @@ title: "organization-selection" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection">ScreenMembersOnOrganizationSelection</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection">ScreenMembersOnOrganizationSelection</a></span>}> > **useScreen**: () => [`ScreenMembersOnOrganizationSelection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection) -Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueWithOrganizationName' type={<span>void | Promise<void></span>}> > **continueWithOrganizationName**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L34) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:34 <ParamField body='useOrganizationSelection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers">OrganizationSelectionMembers</a>}> > **useOrganizationSelection**(): [`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers) -Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/organization-selection.tsx#L49) +Defined in: [packages/auth0-acul-react/src/screens/organization-selection.tsx:49](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L49) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index.mdx index 34aef81a5..0f33796ae 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index.mdx @@ -4,10 +4,10 @@ title: "passkey-enrollment-local" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal">ScreenMembersOnPasskeyEnrollmentLocal</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal">ScreenMembersOnPasskeyEnrollmentLocal</a></span>}> > **useScreen**: () => [`ScreenMembersOnPasskeyEnrollmentLocal`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='abortPasskeyEnrollment' type={<span>void | Promise<void></span>}> > **abortPasskeyEnrollment**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx: <ParamField body='continuePasskeyEnrollment' type={<span>void | Promise<void></span>}> > **continuePasskeyEnrollment**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L35) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx: <ParamField body='usePasskeyEnrollmentLocal' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers">PasskeyEnrollmentLocalMembers</a>}> > **usePasskeyEnrollmentLocal**(): [`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L52) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L52) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index.mdx index eb88d86a7..928ff9e08 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index.mdx @@ -4,10 +4,10 @@ title: "passkey-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment">ScreenMembersOnPasskeyEnrollment</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment">ScreenMembersOnPasskeyEnrollment</a></span>}> > **useScreen**: () => [`ScreenMembersOnPasskeyEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='abortPasskeyEnrollment' type={<span>void | Promise<void></span>}> > **abortPasskeyEnrollment**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L36) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:36](ht <ParamField body='continuePasskeyEnrollment' type={<span>void | Promise<void></span>}> > **continuePasskeyEnrollment**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L34) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:34](ht <ParamField body='usePasskeyEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers">PasskeyEnrollmentMembers</a>}> > **usePasskeyEnrollment**(): [`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers) -Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L51) +Defined in: [packages/auth0-acul-react/src/screens/passkey-enrollment.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L51) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index.mdx index 990cfe379..618026aad 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index.mdx @@ -4,10 +4,10 @@ title: "phone-identifier-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge">ScreenMembersOnPhoneIdentifierChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge">ScreenMembersOnPhoneIdentifierChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnPhoneIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='resendCode' type={<span>void | Promise<void></span>}> > **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.ts <ParamField body='returnToPrevious' type={<span>void | Promise<void></span>}> > **returnToPrevious**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L38) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.ts <ParamField body='submitPhoneChallenge' type={<span>void | Promise<void></span>}> > **submitPhoneChallenge**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L35) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.ts <ParamField body='switchToText' type={<span>void | Promise<void></span>}> > **switchToText**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:42](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L42) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:42](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L42) **Parameters** @@ -284,7 +284,7 @@ Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.ts <ParamField body='switchToVoice' type={<span>void | Promise<void></span>}> > **switchToVoice**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L40) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L40) **Parameters** @@ -300,7 +300,7 @@ Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.ts <ParamField body='usePhoneIdentifierChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers">PhoneIdentifierChallengeMembers</a>}> > **usePhoneIdentifierChallenge**(): [`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L59) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L59) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index.mdx index 7c9553faa..5bc60e0ed 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index.mdx @@ -4,10 +4,10 @@ title: "phone-identifier-enrollment" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment">ScreenMembersOnPhoneIdentifierEnrollment</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment">ScreenMembersOnPhoneIdentifierEnrollment</a></span>}> > **useScreen**: () => [`ScreenMembersOnPhoneIdentifierEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continuePhoneEnrollment' type={<span>void | Promise<void></span>}> > **continuePhoneEnrollment**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L35) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.t <ParamField body='returnToPrevious' type={<span>void | Promise<void></span>}> > **returnToPrevious**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L37) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.t <ParamField body='usePhoneIdentifierEnrollment' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers">PhoneIdentifierEnrollmentMembers</a>}> > **usePhoneIdentifierEnrollment**(): [`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers) -Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L52) +Defined in: [packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L52) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index.mdx index 2f53e7775..858ab453d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index.mdx @@ -4,10 +4,10 @@ title: "redeem-ticket" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L21) +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L21) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L22) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L23) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L24) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L25) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L20) +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L20) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L26) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L27) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L19) +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L19) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L31) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:31](https:/ <ParamField body='useRedeemTicket' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers">RedeemTicketMembers</a>}> > **useRedeemTicket**(): [`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers) -Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:45](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L45) +Defined in: [packages/auth0-acul-react/src/screens/redeem-ticket.tsx:45](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L45) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index.mdx index 412d5a511..c7e999ee0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index.mdx @@ -4,10 +4,10 @@ title: "reset-password-email" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail">ScreenMembersOnResetPasswordEmail</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail">ScreenMembersOnResetPasswordEmail</a></span>}> > **useScreen**: () => [`ScreenMembersOnResetPasswordEmail`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='resendEmail' type={<span>void | Promise<void></span>}> > **resendEmail**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L34) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:34]( <ParamField body='useResetPasswordEmail' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers">ResetPasswordEmailMembers</a>}> > **useResetPasswordEmail**(): [`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L48) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-email.tsx:48](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L48) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index.mdx index 0f59e1660..59d32ce52 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index.mdx @@ -4,10 +4,10 @@ title: "reset-password-error" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L17) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L17) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L18) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L18) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L19) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L19) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L20) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L20) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError">ScreenMembersOnResetPasswordError</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError">ScreenMembersOnResetPasswordError</a></span>}> > **useScreen**: () => [`ScreenMembersOnResetPasswordError`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L21) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L21) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L16) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L16) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L22) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L23) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L15) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L15) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='useResetPasswordError' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers">ResetPasswordErrorMembers</a>}> > **useResetPasswordError**(): [`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-error.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L38) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index.mdx index 7092268e0..fe2cbbde4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index.mdx @@ -4,10 +4,10 @@ title: "reset-password-mfa-email-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L28) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L29) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L30) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L31) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge">ScreenMembersOnResetPasswordMfaEmailChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge">ScreenMembersOnResetPasswordMfaEmailChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnResetPasswordMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L32) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L27) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L33) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L33) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L34) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L26) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L38) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-chal <ParamField body='resendCode' type={<span>void | Promise<void></span>}> > **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L39) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L39) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-chal <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L40) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L40) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-chal <ParamField body='useResetPasswordMfaEmailChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers">ResetPasswordMfaEmailChallengeMembers</a>}> > **useResetPasswordMfaEmailChallenge**(): [`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L58) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L58) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index.mdx index 33e15df1a..cd7ba97aa 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index.mdx @@ -4,10 +4,10 @@ title: "reset-password-mfa-otp-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L35) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challe <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L36) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challe <ParamField body='useResetPasswordMfaOtpChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers">ResetPasswordMfaOtpChallengeMembers</a>}> > **useResetPasswordMfaOtpChallenge**(): [`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L51) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx:51](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L51) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index.mdx index 716c3a47c..ec5f8aa1b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index.mdx @@ -4,10 +4,10 @@ title: "reset-password-mfa-phone-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L27) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L28) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L29) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L30) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge">ScreenMembersOnResetPasswordMfaPhoneChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge">ScreenMembersOnResetPasswordMfaPhoneChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnResetPasswordMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L31) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L26) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L32) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L33) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L33) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L25) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-chal <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L38) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-chal <ParamField body='useResetPasswordMfaPhoneChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers">ResetPasswordMfaPhoneChallengeMembers</a>}> > **useResetPasswordMfaPhoneChallenge**(): [`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L53) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx:53](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L53) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index.mdx index 3813f1739..276aef3cc 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index.mdx @@ -4,10 +4,10 @@ title: "reset-password-mfa-push-challenge-push" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L26) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L27) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L28) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L29) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush">ScreenMembersOnResetPasswordMfaPushChallengePush</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush">ScreenMembersOnResetPasswordMfaPushChallengePush</a></span>}> > **useScreen**: () => [`ScreenMembersOnResetPasswordMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L30) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L25) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L31) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L32) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L24) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L36) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-chall <ParamField body='enterCodeManually' type={<span>void | Promise<void></span>}> > **enterCodeManually**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L39) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L39) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-chall <ParamField body='resendPushNotification' type={<span>void | Promise<void></span>}> > **resendPushNotification**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L37) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-chall <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:41](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L41) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:41](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L41) **Parameters** @@ -284,7 +284,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-chall <ParamField body='useResetPasswordMfaPushChallengePush' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers">ResetPasswordMfaPushChallengePushMembers</a>}> > **useResetPasswordMfaPushChallengePush**(): [`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L59) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx:59](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L59) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index.mdx index 754cc20c2..8979bf92c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index.mdx @@ -4,10 +4,10 @@ title: "reset-password-mfa-recovery-code-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L26) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L27) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L28) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L29) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers">ScreenMembers</a></span>}> > **useScreen**: () => [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L30) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L25) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L31) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L32) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L24) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`code`, `payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L36) **Parameters** @@ -240,7 +240,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-c <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L38) **Parameters** @@ -256,7 +256,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-c <ParamField body='useResetPasswordMfaRecoveryCodeChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers">ResetPasswordMfaRecoveryCodeChallengeMembers</a>}> > **useResetPasswordMfaRecoveryCodeChallenge**(): [`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L54) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L54) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index.mdx index e0b68b247..7a89eb623 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index.mdx @@ -4,10 +4,10 @@ title: "reset-password-mfa-sms-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge">ScreenMembersOnResetPasswordMfaSmsChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge">ScreenMembersOnResetPasswordMfaSmsChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnResetPasswordMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMfaSmsChallenge' type={<span>void | Promise<void></span>}> > **continueMfaSmsChallenge**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L35) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challe <ParamField body='getACall' type={<span>void | Promise<void></span>}> > **getACall**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L40) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L40) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challe <ParamField body='resendCode' type={<span>void | Promise<void></span>}> > **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L37) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challe <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L38) **Parameters** @@ -284,7 +284,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challe <ParamField body='useResetPasswordMfaSmsChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers">ResetPasswordMfaSmsChallengeMembers</a>}> > **useResetPasswordMfaSmsChallenge**(): [`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:57](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L57) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx:57](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L57) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index.mdx index cfa1339ce..8ba10cccd 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index.mdx @@ -4,10 +4,10 @@ title: "reset-password-mfa-voice-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L27) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L28) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L29) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L30) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge">ScreenMembersOnResetPasswordMfaVoiceChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge">ScreenMembersOnResetPasswordMfaVoiceChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnResetPasswordMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L31) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L26) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L32) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L33) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L33) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L25) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueMethod' type={<span>void | Promise<void></span>}> > **continueMethod**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-chal <ParamField body='resendCode' type={<span>void | Promise<void></span>}> > **resendCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L39) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L39) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-chal <ParamField body='switchToSms' type={<span>void | Promise<void></span>}> > **switchToSms**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L38) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-chal <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L40) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L40) **Parameters** @@ -284,7 +284,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-chal <ParamField body='useResetPasswordMfaVoiceChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers">ResetPasswordMfaVoiceChallengeMembers</a>}> > **useResetPasswordMfaVoiceChallenge**(): [`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L58) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L58) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index.mdx index ba7ecc03f..942c360c1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index.mdx @@ -4,10 +4,10 @@ title: "reset-password-mfa-webauthn-platform-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L28) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L29) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L30) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L31) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge">ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge">ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L32) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L27) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L33) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L33) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L34) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L26) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='continueWithPasskey' type={<span>void | Promise<void></span>}> > **continueWithPasskey**(`options?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L38) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-p <ParamField body='reportBrowserError' type={<span>void | Promise<void></span>}> > **reportBrowserError**(`options`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L40) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L40) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-p <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`options?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:42](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L42) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:42](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L42) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-p <ParamField body='useResetPasswordMfaWebAuthnPlatformChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers">ResetPasswordMfaWebAuthnPlatformChallengeMembers</a>}> > **useResetPasswordMfaWebAuthnPlatformChallenge**(): [`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L58) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx:58](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L58) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index.mdx index 4a531195b..7cac4f91d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index.mdx @@ -4,10 +4,10 @@ title: "reset-password-mfa-webauthn-roaming-challenge" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L28) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L29) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L30) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L31) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge">ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge">ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge</a></span>}> > **useScreen**: () => [`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L32) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L27) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L33) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:33](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L33) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L34) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L26) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='showError' type={<span>void | Promise<void></span>}> > **showError**(`options`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L40) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:40](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L40) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-r <ParamField body='tryAnotherMethod' type={<span>void | Promise<void></span>}> > **tryAnotherMethod**(`options?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:41](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L41) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:41](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L41) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-r <ParamField body='useResetPasswordMfaWebAuthnRoamingChallenge' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers">ResetPasswordMfaWebAuthnRoamingChallengeMembers</a>}> > **useResetPasswordMfaWebAuthnRoamingChallenge**(): [`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:57](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L57) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:57](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L57) **Returns** @@ -262,7 +262,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-r <ParamField body='useSecurityKey' type={<span>void | Promise<void></span>}> > **useSecurityKey**(`options?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L38) **Parameters** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index.mdx index 6f845ac17..c208b53df 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index.mdx @@ -4,10 +4,10 @@ title: "reset-password-request" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest">ScreenMembersOnResetPasswordRequest</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest">ScreenMembersOnResetPasswordRequest</a></span>}> > **useScreen**: () => [`ScreenMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest">TransactionMembersOnResetPasswordRequest</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest">TransactionMembersOnResetPasswordRequest</a></span>}> > **useTransaction**: () => [`TransactionMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='backToLogin' type={<span>void | Promise<void></span>}> > **backToLogin**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:37 <ParamField body='resetPassword' type={<span>void | Promise<void></span>}> > **resetPassword**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L35) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:35 <ParamField body='useResetPasswordRequest' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers">ResetPasswordRequestMembers</a>}> > **useResetPasswordRequest**(): [`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L54) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-request.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L54) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index.mdx index e2b2a615d..6fc8ca09c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index.mdx @@ -4,10 +4,10 @@ title: "reset-password-success" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L17) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:17](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L17) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L18) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:18](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L18) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L19) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:19](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L19) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L20) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:20](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L20) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess">ScreenMembersOnResetPasswordSuccess</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess">ScreenMembersOnResetPasswordSuccess</a></span>}> > **useScreen**: () => [`ScreenMembersOnResetPasswordSuccess`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L21) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L21) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L16) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:16](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L16) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}> > **useTransaction**: () => [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L22) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L23) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L15) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:15](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L15) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='useResetPasswordSuccess' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers">ResetPasswordSuccessMembers</a>}> > **useResetPasswordSuccess**(): [`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L38) +Defined in: [packages/auth0-acul-react/src/screens/reset-password-success.tsx:38](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L38) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index.mdx index 123a118bc..6d0e86c6c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index.mdx @@ -4,10 +4,10 @@ title: "reset-password" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L24) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L25) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L26) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L27) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword">ScreenMembersOnResetPassword</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword">ScreenMembersOnResetPassword</a></span>}> > **useScreen**: () => [`ScreenMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword) -Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L28) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L23) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword">TransactionMembersOnResetPassword</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword">TransactionMembersOnResetPassword</a></span>}> > **useTransaction**: () => [`TransactionMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword) -Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L29) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L30) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L22) +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L22) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='resetPassword' type={<span>void | Promise<void></span>}> > **resetPassword**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L34) +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L34) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:34](https: <ParamField body='useResetPassword' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers">ResetPasswordMembers</a>}> > **useResetPassword**(): [`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers) -Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/reset-password.tsx#L52) +Defined in: [packages/auth0-acul-react/src/screens/reset-password.tsx:52](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L52) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index.mdx index 4207fd299..b8f44cc94 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index.mdx @@ -4,10 +4,10 @@ title: "signup-id" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L26) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L27) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L28) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L29) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId">ScreenMembersOnSignupId</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId">ScreenMembersOnSignupId</a></span>}> > **useScreen**: () => [`ScreenMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId) -Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L30) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L25) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a></span>}> > **useTransaction**: () => [`TransactionMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId) -Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L31) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L32) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L24) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='federatedSignup' type={<span>void | Promise<void></span>}> > **federatedSignup**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:37](https://git <ParamField body='pickCountryCode' type={<span>void | Promise<void></span>}> > **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L39) +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L39) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:39](https://git <ParamField body='signup' type={<span>void | Promise<void></span>}> > **signup**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L36) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:36](https://git <ParamField body='useSignupId' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers">SignupIdMembers</a>}> > **useSignupId**(): [`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:60](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-id.tsx#L60) +Defined in: [packages/auth0-acul-react/src/screens/signup-id.tsx:60](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L60) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index.mdx index 3c2c446b7..9ef5cbf5a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index.mdx @@ -4,10 +4,10 @@ title: "signup-password" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L25) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L26) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L27) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L28) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword">ScreenMembersOnSignupPassword</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword">ScreenMembersOnSignupPassword</a></span>}> > **useScreen**: () => [`ScreenMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword) -Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L29) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L24) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword">TransactionMembersOnSignupPassword</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword">TransactionMembersOnSignupPassword</a></span>}> > **useTransaction**: () => [`TransactionMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword) -Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L30) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L31) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L23) +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L23) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='federatedSignup' type={<span>void | Promise<void></span>}> > **federatedSignup**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L36) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:36](https <ParamField body='signup' type={<span>void | Promise<void></span>}> > **signup**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L35) +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:35](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L35) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:35](https <ParamField body='useSignupPassword' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers">SignupPasswordMembers</a>}> > **useSignupPassword**(): [`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup-password.tsx#L54) +Defined in: [packages/auth0-acul-react/src/screens/signup-password.tsx:54](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L54) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index.mdx index 563bfb13a..907c38323 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index.mdx @@ -4,10 +4,10 @@ title: "signup" ## Variables -<ParamField body='useBranding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a>}> +<ParamField body='useBranding' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}> > **useBranding**: () => [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L26) +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:26](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L26) Hook to access branding and theme configuration. @@ -27,10 +27,10 @@ function CustomTheme() { ``` </ParamField> -<ParamField body='useClient' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a>}> +<ParamField body='useClient' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}> > **useClient**: () => [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L27) +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:27](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L27) Hook to access Auth0 application (client) configuration. @@ -50,10 +50,10 @@ function AppInfo() { ``` </ParamField> -<ParamField body='useOrganization' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a>}> +<ParamField body='useOrganization' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> > **useOrganization**: () => [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L28) +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L28) Hook to access organization context and settings. @@ -76,10 +76,10 @@ function OrgSelector() { ``` </ParamField> -<ParamField body='usePrompt' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a>}> +<ParamField body='usePrompt' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}> > **usePrompt**: () => [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PromptMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L29) +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:29](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L29) Hook to access prompt configuration and flow settings. @@ -99,10 +99,10 @@ function FlowInfo() { ``` </ParamField> -<ParamField body='useScreen' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup">ScreenMembersOnSignup</a>}> +<ParamField body='useScreen' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup">ScreenMembersOnSignup</a></span>}> > **useScreen**: () => [`ScreenMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup) -Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L30) +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:30](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L30) Hook to access current screen information and metadata. @@ -122,10 +122,10 @@ function ScreenDebug() { ``` </ParamField> -<ParamField body='useTenant' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a>}> +<ParamField body='useTenant' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}> > **useTenant**: () => [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L25) +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L25) Hook to access tenant configuration and settings. @@ -145,10 +145,10 @@ function TenantInfo() { ``` </ParamField> -<ParamField body='useTransaction' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup">TransactionMembersOnSignup</a>}> +<ParamField body='useTransaction' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup">TransactionMembersOnSignup</a></span>}> > **useTransaction**: () => [`TransactionMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup) -Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L31) +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:31](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L31) Hook to access transaction state and authentication flow data. @@ -168,10 +168,10 @@ function TransactionInfo() { ``` </ParamField> -<ParamField body='useUntrustedData' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>}> +<ParamField body='useUntrustedData' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> > **useUntrustedData**: () => [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L32) +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:32](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L32) Hook to access untrusted data from URL parameters and form submissions. @@ -191,10 +191,10 @@ function PrefilledForm() { ``` </ParamField> -<ParamField body='useUser' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a>}> +<ParamField body='useUser' type={<span>() => <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}> > **useUser**: () => [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L24) +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L24) Hook to access user information and profile data. @@ -220,7 +220,7 @@ function UserProfile() { <ParamField body='federatedSignup' type={<span>void | Promise<void></span>}> > **federatedSignup**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L37) +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:37](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L37) **Parameters** @@ -236,7 +236,7 @@ Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:37](https://github <ParamField body='pickCountryCode' type={<span>void | Promise<void></span>}> > **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L39) +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:39](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L39) **Parameters** @@ -252,7 +252,7 @@ Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:39](https://github <ParamField body='signup' type={<span>void | Promise<void></span>}> > **signup**(`payload`): `void` \| `Promise`\<`void`\> -Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L36) +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:36](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L36) **Parameters** @@ -268,7 +268,7 @@ Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:36](https://github <ParamField body='useSignup' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers">SignupMembers</a>}> > **useSignup**(): [`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers) -Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:63](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/screens/signup.tsx#L63) +Defined in: [packages/auth0-acul-react/src/screens/signup.tsx:63](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L63) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks.mdx index 2e7ad3ad6..3384a10ec 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks.mdx @@ -2,7 +2,7 @@ title: "ContextHooks<T>" --- -Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:7](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L7) +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:7](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/context/index.tsx#L7) Factory class that creates context hooks for accessing Auth0 Universal Login data. These hooks provide access to various aspects of the authentication flow and tenant configuration. @@ -17,7 +17,7 @@ These hooks provide access to various aspects of the authentication flow and ten > **new ContextHooks**\<`T`\>(`instance`): `ContextHooks`\<`T`\> -Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:8](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L8) +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:8](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/context/index.tsx#L8) #### Parameters @@ -33,7 +33,7 @@ Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:8](https://gi <ParamField body='useUser()' type='T["user"]'> > **useUser**(): `T`\[`"user"`\] -Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L21) +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:21](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/context/index.tsx#L21) Hook to access user information and profile data. @@ -56,7 +56,7 @@ function UserProfile() { <ParamField body='useTenant()' type='T["tenant"]'> > **useTenant**(): `T`\[`"tenant"`\] -Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L34) +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:34](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/context/index.tsx#L34) Hook to access tenant configuration and settings. @@ -79,7 +79,7 @@ function TenantInfo() { <ParamField body='useBranding()' type='T["branding"]'> > **useBranding**(): `T`\[`"branding"`\] -Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:47](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L47) +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:47](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/context/index.tsx#L47) Hook to access branding and theme configuration. @@ -102,7 +102,7 @@ function CustomTheme() { <ParamField body='useClient()' type='T["client"]'> > **useClient**(): `T`\[`"client"`\] -Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:60](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L60) +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:60](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/context/index.tsx#L60) Hook to access Auth0 application (client) configuration. @@ -125,7 +125,7 @@ function AppInfo() { <ParamField body='useOrganization()' type='T["organization"]'> > **useOrganization**(): `T`\[`"organization"`\] -Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:76](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L76) +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:76](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/context/index.tsx#L76) Hook to access organization context and settings. @@ -151,7 +151,7 @@ function OrgSelector() { <ParamField body='usePrompt()' type='T["prompt"]'> > **usePrompt**(): `T`\[`"prompt"`\] -Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:89](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L89) +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:89](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/context/index.tsx#L89) Hook to access prompt configuration and flow settings. @@ -174,7 +174,7 @@ function FlowInfo() { <ParamField body='useUntrustedData()' type='T["untrustedData"]'> > **useUntrustedData**(): `T`\[`"untrustedData"`\] -Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:102](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L102) +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:102](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/context/index.tsx#L102) Hook to access untrusted data from URL parameters and form submissions. @@ -197,7 +197,7 @@ function PrefilledForm() { <ParamField body='useScreen()' type='T["screen"]'> > **useScreen**(): `T`\[`"screen"`\] -Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:115](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L115) +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:115](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/context/index.tsx#L115) Hook to access current screen information and metadata. @@ -220,7 +220,7 @@ function ScreenDebug() { <ParamField body='useTransaction()' type='T["transaction"]'> > **useTransaction**(): `T`\[`"transaction"`\] -Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:128](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/context/index.tsx#L128) +Defined in: [packages/auth0-acul-react/src/hooks/context/index.tsx:128](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/context/index.tsx#L128) Hook to access transaction state and authentication flow data. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/index.mdx index 7e02e74f7..9b7a2ae62 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/index.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/index.mdx @@ -301,60 +301,22 @@ title: "Types" ## References -### ULError +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>} type='Interfaces'/> -Renames and re-exports [Error](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error) +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes">useAuth0Themes</a>} type='Hooks'/> -*** +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen">useCurrentScreen</a>} type='Hooks'/> -### useAuth0Themes +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors">useErrors</a>} type='Hooks'/> -Re-exports [useAuth0Themes](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useAuth0Themes) +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useLoginIdentifiers">useLoginIdentifiers</a>} type='Hooks'/> -*** +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useSignupIdentifiers">useSignupIdentifiers</a>} type='Hooks'/> -### useCurrentScreen +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useMfaPolling">useMfaPolling</a>} type='Hooks'/> -Re-exports [useCurrentScreen](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useCurrentScreen) +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend">useResend</a>} type='Hooks'/> -*** +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/usePasswordValidation">usePasswordValidation</a>} type='Hooks'/> -### useErrors - -Re-exports [useErrors](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useErrors) - -*** - -### useLoginIdentifiers - -Re-exports [useLoginIdentifiers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useLoginIdentifiers) - -*** - -### useSignupIdentifiers - -Re-exports [useSignupIdentifiers](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useSignupIdentifiers) - -*** - -### useMfaPolling - -Re-exports [useMfaPolling](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useMfaPolling) - -*** - -### useResend - -Re-exports [useResend](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend) - -*** - -### usePasswordValidation - -Re-exports [usePasswordValidation](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/usePasswordValidation) - -*** - -### useUsernameValidation - -Re-exports [useUsernameValidation](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useUsernameValidation) \ No newline at end of file +<ParamField body={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useUsernameValidation">useUsernameValidation</a>} type='Hooks'/> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential.mdx index 9b5c628e5..51309c8f8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential.mdx @@ -20,7 +20,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:10 </ParamField> -<ParamField body='transports?' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/AuthenticatorTransport">AuthenticatorTransport</a>[]}> +<ParamField body='transports?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/AuthenticatorTransport">AuthenticatorTransport</a>[]</span>}> > `optional` **transports**: [`AuthenticatorTransport`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/AuthenticatorTransport)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:11 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding.mdx index e5392fff4..1ed03768f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding.mdx @@ -13,16 +13,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.t </ParamField> -<ParamField body='colors?' type='object'> -> `optional` **colors**: `object` +<ParamField body='colors?' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:19 -**primary?** - -> `optional` **primary**: `string` - -**pageBackground?** - -> `optional` **pageBackground**: `string` </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers.mdx index 1cec27ff4..4f4c77ef8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingMembers.mdx @@ -6,14 +6,14 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:53 ## Properties -<ParamField body='settings' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings">BrandingSettings</a> }> +<ParamField body='settings' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings">BrandingSettings</a>}> > **settings**: [`BrandingSettings`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:54 </ParamField> -<ParamField body='themes' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes">BrandingThemes</a> }> +<ParamField body='themes' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes">BrandingThemes</a>}> > **themes**: [`BrandingThemes`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:55 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings.mdx index 99716ffef..78a1286c4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings.mdx @@ -6,18 +6,8 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:29 ## Properties -<ParamField body='colors?' type='object'> -> `optional` **colors**: `object` +<ParamField body='colors?' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:30 - -**primary?** - -> `optional` **primary**: `string` - -**pageBackground?** - -> `optional` **pageBackground**: `string` \| \{ `type`: `string`; `start`: `string`; `end`: `string`; `angleDegree`: `number`; \} </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes.mdx index 7801cd09d..ffe3dfb81 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes.mdx @@ -6,32 +6,26 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:43 ## Properties -<ParamField body='default' type='object'> -> **default**: `object` +<ParamField body='default' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:44 +<Expandable title="properties"> + <ParamField body='borders' type='Record<string, string | boolean | number>'> -**borders** + </ParamField> + <ParamField body='colors' type='Record<string, string>'> -> **borders**: `Record`\<`string`, `string` \| `boolean` \| `number`\> + </ParamField> + <ParamField body='displayName' type='string'> -**colors** + </ParamField> + <ParamField body='fonts' type='Record<string, string | boolean | object>'> -> **colors**: `Record`\<`string`, `string`\> + </ParamField> + <ParamField body='pageBackground' type='Record<string, string>'> -**displayName** + </ParamField> + <ParamField body='widget' type='Record<string, string | number>'> -> **displayName**: `string` - -**fonts** - -> **fonts**: `Record`\<`string`, `string` \| `boolean` \| `object`\> - -**pageBackground** - -> **pageBackground**: `Record`\<`string`, `string`\> - -**widget** - -> **widget**: `Record`\<`string`, `string` \| `number`\> + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers.mdx index 5a1827411..6d3c66370 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers.mdx @@ -20,22 +20,25 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/client.d.ts:12 </ParamField> -<ParamField body='logoUrl' type='string '> +<ParamField body='logoUrl' type='string'> > **logoUrl**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/client.d.ts:13 </ParamField> -<ParamField body='description' type='string '> +<ParamField body='description' type='string'> > **description**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/client.d.ts:14 </ParamField> -<ParamField body='metadata' type='{[key: string]: string; } '> -> **metadata**: \{\[`key`: `string`\]: `string`; \} \| `null` +<ParamField body='metadata' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/client.d.ts:15 +<Expandable title="properties"> + <ParamField body='key' type='string]: string'> + + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions.mdx index bc97e0e10..97bffe97e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions.mdx @@ -16,7 +16,7 @@ Options for confirming logout ## Properties -<ParamField body='action' type='"accept" '> +<ParamField body='action' type='"accept" | "deny"'> > **action**: `"accept"` \| `"deny"` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/logout.d.ts:8 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection.mdx index 8c3c0538d..57b56cbd7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection.mdx @@ -24,7 +24,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='metadata?' type='Record<string, string>'> +<ParamField body='metadata?' type='Record<string, string>'> > `optional` **metadata**: `Record`\<`string`, `string`\> Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:4 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CredentialResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CredentialResponse.mdx index 1514df10f..14dfe00c6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CredentialResponse.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CredentialResponse.mdx @@ -6,14 +6,14 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:14 ## Properties -<ParamField body='clientDataJSON' type='string '> +<ParamField body='clientDataJSON' type='string'> > **clientDataJSON**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:15 </ParamField> -<ParamField body='attestationObject' type='string '> +<ParamField body='attestationObject' type='string'> > **attestationObject**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:16 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions.mdx index 77cc9bf4b..61f32e643 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions.mdx @@ -8,50 +8,77 @@ CurrentScreenOptions details. ## Properties -<ParamField body='client' type='{ id: string; metadata: Record<string, string> '> -> **client**: \{ `id`: `string`; `metadata`: `Record`\<`string`, `string`\> \| `null`; \} \| `null` +<ParamField body='client' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:26 +<Expandable title="properties"> + <ParamField body='id' type='string'> + </ParamField> + <ParamField body='metadata' type='Record<string, string>'> + + </ParamField> +</Expandable> </ParamField> -<ParamField body='organization' type='{ id: string; metadata: Record<string, string> '> -> **organization**: \{ `id`: `string`; `metadata`: `Record`\<`string`, `string`\> \| `null`; \} \| `null` +<ParamField body='organization' type="object"> + +<Expandable title="properties"> + <ParamField body='id' type='string'> -Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:30 + </ParamField> + <ParamField body='metadata' type='Record<string, string>'> + </ParamField> +</Expandable> </ParamField> -<ParamField body='prompt' type='{ name: string; } '> -> **prompt**: \{ `name`: `string`; \} \| `null` +<ParamField body='prompt' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:34 +<Expandable title="properties"> + <ParamField body='name' type='string'> + </ParamField> +</Expandable> </ParamField> -<ParamField body='screen' type='{ name: string; } '> -> **screen**: \{ `name`: `string`; \} \| `null` +<ParamField body='screen' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:37 +<Expandable title="properties"> + <ParamField body='name' type='string'> + </ParamField> +</Expandable> </ParamField> -<ParamField body='tenant' type='{ enabledLocales: string[]; } '> -> **tenant**: \{ `enabledLocales`: `string`[]; \} \| `null` +<ParamField body='tenant' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:40 +<Expandable title="properties"> + <ParamField body='enabledLocales' type='string[]'> + </ParamField> +</Expandable> </ParamField> -<ParamField body='transaction' type={{ errors: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> -> **transaction**: \{ `errors`: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null`; `state`: `string`; `locale`: `string`; \} \| `null` +<ParamField body='transaction' type="object"> + +<Expandable title="properties"> + <ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[]</span>}> -Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:43 + </ParamField> + <ParamField body='state' type='string'> + </ParamField> + <ParamField body='locale' type='string'> + + </ParamField> +</Expandable> </ParamField> -<ParamField body='untrustedData' type='{ authorizationParams: Record<string, string> '> -> **untrustedData**: \{ `authorizationParams`: `Record`\<`string`, `string`\> \| `null`; \} \| `null` +<ParamField body='untrustedData' type="object"> + +<Expandable title="properties"> + <ParamField body='authorizationParams' type='Record<string, string>'> -Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:48 + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection.mdx index a4468dc9a..bc45a8094 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection.mdx @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='metadata?' type='Record<string, string>'> +<ParamField body='metadata?' type='Record<string, string>'> > `optional` **metadata**: `Record`\<`string`, `string`\> Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:4 @@ -43,20 +43,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='options' type='object'> -> **options**: `object` +<ParamField body='options' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:117 +<Expandable title="properties"> + <ParamField body='showAsButton' type='boolean'> -**iconUrl?** - -> `optional` **iconUrl**: `string` - -**displayName?** - -> `optional` **displayName**: `string` - -**showAsButton** - -> **showAsButton**: `boolean` + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.mdx index 031193fb1..be716a209 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error.mdx @@ -31,7 +31,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='rules?' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule">PasswordComplexityRule</a>[]}> +<ParamField body='rules?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule">PasswordComplexityRule</a>[]</span>}> > `optional` **rules**: [`PasswordComplexityRule`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:141 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem.mdx index 4cad872ad..aeaa3c74f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem.mdx @@ -2,7 +2,7 @@ title: "ErrorItem" --- -Defined in: [packages/auth0-acul-react/src/state/error-store.ts:3](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/state/error-store.ts#L3) +Defined in: [packages/auth0-acul-react/src/state/error-store.ts:3](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/state/error-store.ts#L3) ## Extends @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='rules?' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule">PasswordComplexityRule</a>[]}> +<ParamField body='rules?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule">PasswordComplexityRule</a>[]</span>}> > `optional` **rules**: [`PasswordComplexityRule`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:141 @@ -57,19 +57,19 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts <ParamField body='id' type='string'> > **id**: `string` -Defined in: [packages/auth0-acul-react/src/state/error-store.ts:4](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/state/error-store.ts#L4) +Defined in: [packages/auth0-acul-react/src/state/error-store.ts:4](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/state/error-store.ts#L4) </ParamField> <ParamField body='label?' type='string'> > `optional` **label**: `string` -Defined in: [packages/auth0-acul-react/src/state/error-store.ts:5](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/state/error-store.ts#L5) +Defined in: [packages/auth0-acul-react/src/state/error-store.ts:5](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/state/error-store.ts#L5) </ParamField> <ParamField body='kind?' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind">ErrorKind</a>}> > `optional` **kind**: [`ErrorKind`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind) -Defined in: [packages/auth0-acul-react/src/state/error-store.ts:6](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/state/error-store.ts#L6) +Defined in: [packages/auth0-acul-react/src/state/error-store.ts:6](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/state/error-store.ts#L6) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult.mdx index affe1cb3e..f4194ac71 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult.mdx @@ -2,7 +2,7 @@ title: "ErrorsResult" --- -Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:12](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L12) +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:12](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L12) ## Extends @@ -18,7 +18,7 @@ Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:12](https://gi > **byKind**(`kind`, `opts?`): readonly [`ErrorItem`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem)[] -Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:13](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L13) +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:13](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L13) #### Parameters @@ -42,7 +42,7 @@ readonly [`ErrorItem`](/docs/customize/login-pages/advanced-customizations/refer > **byField**(`field`, `opts?`): readonly [`ErrorItem`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem)[] -Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:14](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L14) +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:14](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L14) #### Parameters diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme.mdx index 31b2fb65f..9c69deeb4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FlattenedTheme.mdx @@ -6,35 +6,35 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:52 ## Properties -<ParamField body='colors' type='Record<string, string>'> +<ParamField body='colors' type='Record<string, string>'> > **colors**: `Record`\<`string`, `string`\> Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:53 </ParamField> -<ParamField body='fonts' type='Record<string, string '> +<ParamField body='fonts' type='Record<string, string | number | boolean | object>'> > **fonts**: `Record`\<`string`, `string` \| `number` \| `boolean` \| `object`\> Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:54 </ParamField> -<ParamField body='borders' type='Record<string, string '> +<ParamField body='borders' type='Record<string, string | number | boolean>'> > **borders**: `Record`\<`string`, `string` \| `number` \| `boolean`\> Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:55 </ParamField> -<ParamField body='pageBackground' type='Record<string, string>'> +<ParamField body='pageBackground' type='Record<string, string>'> > **pageBackground**: `Record`\<`string`, `string`\> Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:56 </ParamField> -<ParamField body='widget' type='Record<string, string '> +<ParamField body='widget' type='Record<string, string | number>'> > **widget**: `Record`\<`string`, `string` \| `number`\> Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:57 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers.mdx index 2ac826a61..4bd909a5f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers.mdx @@ -109,7 +109,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/base-context.d.t </ParamField> -<ParamField body='submitCaptcha()' type='(payload) => void'> +<ParamField body='submitCaptcha()' type='(payload) => void'> > **submitCaptcha**: (`payload`) => `void` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/interstitial-captcha.d.ts:7 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions.mdx index 0c6e39319..312f0f817 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions.mdx @@ -18,7 +18,7 @@ This typically involves selecting the method (SMS or Voice) to receive the verif ## Properties -<ParamField body='type' type='"voice" '> +<ParamField body='type' type='"voice" | "sms"'> > **type**: `"voice"` \| `"sms"` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:36 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions.mdx index c315657b5..d65e2308d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions.mdx @@ -25,7 +25,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrol </ParamField> -<ParamField body='type' type='"voice" '> +<ParamField body='type' type='"voice" | "sms"'> > **type**: `"voice"` \| `"sms"` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:15 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult.mdx index 760c2e5b8..beff38263 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult.mdx @@ -2,7 +2,7 @@ title: "MfaPollingResult" --- -Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L17) +Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:17](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L17) Result object returned by [useMfaPolling](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useMfaPolling). @@ -11,7 +11,7 @@ Result object returned by [useMfaPolling](/docs/customize/login-pages/advanced-c <ParamField body='isRunning' type='boolean'> > **isRunning**: `boolean` -Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L25) +Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L25) Indicates whether the MFA push polling process is currently active. @@ -21,10 +21,10 @@ Indicates whether the MFA push polling process is currently active. </ParamField> -<ParamField body='startPolling()' type='() => void'> +<ParamField body='startPolling()' type='() => void'> > **startPolling**: () => `void` -Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:33](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L33) +Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:33](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L33) Starts or resumes the polling process. @@ -37,10 +37,10 @@ Starts or resumes the polling process. </ParamField> -<ParamField body='stopPolling()' type='() => void'> +<ParamField body='stopPolling()' type='() => void'> > **stopPolling**: () => `void` -Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:41](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L41) +Defined in: [packages/auth0-acul-react/src/hooks/utility/polling-manager.ts:41](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/polling-manager.ts#L41) Stops the polling process immediately. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl.mdx index c479f300e..74b162694 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl.mdx @@ -12,7 +12,7 @@ approved. ## Properties -<ParamField body='stopPolling()' type='() => void'> +<ParamField body='stopPolling()' type='() => void'> > **stopPolling**: () => `void` Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/polling-control.d.ts:66 @@ -39,7 +39,7 @@ control.stopPolling(); </ParamField> -<ParamField body='startPolling()' type='() => void'> +<ParamField body='startPolling()' type='() => void'> > **startPolling**: () => `void` Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/polling-control.d.ts:78 @@ -61,7 +61,7 @@ control.startPolling(); // Begin checking the MFA push challenge </ParamField> -<ParamField body='isRunning()' type='() => boolean'> +<ParamField body='isRunning()' type='() => boolean'> > **isRunning**: () => `boolean` Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/polling-control.d.ts:94 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers.mdx index a2848870a..17826700d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers.mdx @@ -6,43 +6,46 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.t ## Properties -<ParamField body='id' type='string '> +<ParamField body='id' type='string'> > **id**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:25 </ParamField> -<ParamField body='name' type='string '> +<ParamField body='name' type='string'> > **name**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:26 </ParamField> -<ParamField body='usage' type='string '> +<ParamField body='usage' type='string'> > **usage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:27 </ParamField> -<ParamField body='displayName' type='string '> +<ParamField body='displayName' type='string'> > **displayName**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:28 </ParamField> -<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding">Branding</a> }> +<ParamField body='branding' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding">Branding</a>}> > **branding**: [`Branding`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:29 </ParamField> -<ParamField body='metadata' type='{[key: string]: string; } '> -> **metadata**: \{\[`key`: `string`\]: `string`; \} \| `null` +<ParamField body='metadata' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:30 +<Expandable title="properties"> + <ParamField body='key' type='string]: string'> + + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations.mdx index 3a20f4020..f4157581a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations.mdx @@ -6,21 +6,21 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:28 ## Properties -<ParamField body='organizationId' type='string '> +<ParamField body='organizationId' type='string'> > **organizationId**: `string` \| `undefined` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:29 </ParamField> -<ParamField body='organizationName' type='string '> +<ParamField body='organizationName' type='string'> > **organizationName**: `string` \| `undefined` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:30 </ParamField> -<ParamField body='displayName' type='string '> +<ParamField body='displayName' type='string'> > **displayName**: `string` \| `undefined` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:31 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate.mdx index 6ff0639a6..f5c3623f6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate.mdx @@ -6,60 +6,44 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:19 ## Properties -<ParamField body='public\_key' type='object'> -> **public\_key**: `object` +<ParamField body='public\_key' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:20 +<Expandable title="properties"> + <ParamField body='user' type='object'> -**user** + </ParamField> + <ParamField body='user.id' type='string'> -> **user**: `object` + </ParamField> + <ParamField body='user.name' type='string'> -**user.id** + </ParamField> + <ParamField body='user.displayName' type='string'> -> **id**: `string` + </ParamField> + <ParamField body='rp' type='object'> -**user.name** + </ParamField> + <ParamField body='rp.id' type='string'> -> **name**: `string` + </ParamField> + <ParamField body='rp.name' type='string'> -**user.displayName** + </ParamField> + <ParamField body='challenge' type='string'> -> **displayName**: `string` + </ParamField> + <ParamField body='pubKeyCredParams' type='[{ type: string; alg: number; }]'> -**rp** + </ParamField> + <ParamField body='authenticatorSelection' type='object'> -> **rp**: `object` + </ParamField> + <ParamField body='authenticatorSelection.residentKey' type='string'> -**rp.id** + </ParamField> + <ParamField body='authenticatorSelection.userVerification' type='string'> -> **id**: `string` - -**rp.name** - -> **name**: `string` - -**challenge** - -> **challenge**: `string` - -**pubKeyCredParams** - -> **pubKeyCredParams**: \[\{ `type`: `string`; `alg`: `number`; \}\] - -**authenticatorSelection** - -> **authenticatorSelection**: `object` - -**authenticatorSelection.residentKey** - -> **residentKey**: `string` - -**authenticatorSelection.userVerification** - -> **userVerification**: `string` - -**authenticatorSelection.authenticatorAttachment?** - -> `optional` **authenticatorAttachment**: `string` + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse.mdx index c167994ad..32ea5c61e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreateResponse.mdx @@ -13,7 +13,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:20 </ParamField> -<ParamField body='rawId' type='string '> +<ParamField body='rawId' type='string'> > **rawId**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:21 @@ -27,7 +27,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:22 </ParamField> -<ParamField body='authenticatorAttachment' type='string '> +<ParamField body='authenticatorAttachment' type='string'> > **authenticatorAttachment**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:23 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule.mdx index c62bbc38d..092b586c5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule.mdx @@ -20,7 +20,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='status' type='"valid" '> +<ParamField body='status' type='"valid" | "error"'> > **status**: `"valid"` \| `"error"` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:128 @@ -34,23 +34,13 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='args?' type='object'> -> `optional` **args**: `object` +<ParamField body='args?' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:130 - -**count** - -> **count**: `number` - -**total?** - -> `optional` **total**: `number` - -**example?** - -> `optional` **example**: `string` +<Expandable title="properties"> + <ParamField body='count' type='number'> + </ParamField> +</Expandable> </ParamField> <ParamField body='items?' type='PasswordComplexityRule[]'> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy.mdx index 14a685abc..eebe4d106 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy.mdx @@ -20,14 +20,14 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='policy' type='"none" '> +<ParamField body='policy' type='"none" | "low" | "fair" | "good" | "excellent"'> > **policy**: `"none"` \| `"low"` \| `"fair"` \| `"good"` \| `"excellent"` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:54 </ParamField> -<ParamField body='passwordSecurityInfo?' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule">PasswordComplexityRule</a>[]}> +<ParamField body='passwordSecurityInfo?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule">PasswordComplexityRule</a>[]</span>}> > `optional` **passwordSecurityInfo**: [`PasswordComplexityRule`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:55 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult.mdx index 04244e67c..58fc9e481 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult.mdx @@ -17,7 +17,7 @@ Overall outcome of all password policy checks. </ParamField> -<ParamField body='results' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule">PasswordComplexityRule</a>[]}> +<ParamField body='results' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule">PasswordComplexityRule</a>[]</span>}> > **results**: [`PasswordComplexityRule`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/validate-password.d.ts:16 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions.mdx index b1cac9b29..ad611658b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions.mdx @@ -10,7 +10,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifie ## Properties -<ParamField body='type' type='"text" '> +<ParamField body='type' type='"text" | "voice"'> > **type**: `"text"` \| `"voice"` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:16 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions.mdx index f95add17d..4b17b1443 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions.mdx @@ -8,16 +8,14 @@ ReportBrowserErrorOptions ## Properties -<ParamField body='error' type='object'> -> **error**: `object` +<ParamField body='error' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:40 +<Expandable title="properties"> + <ParamField body='name' type='string'> -**name** + </ParamField> + <ParamField body='message' type='string'> -> **name**: `string` - -**message** - -> **message**: `string` + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl.mdx index 7ad05cd8f..dcbbcb0f6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl.mdx @@ -8,7 +8,7 @@ Control object returned by resendManager method ## Properties -<ParamField body='startResend()' type='() => void'> +<ParamField body='startResend()' type='() => void'> > **startResend**: () => `void` Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/resend-control.d.ts:19 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx index 619501cef..305c99d99 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx @@ -16,7 +16,7 @@ ContinueOptions ## Properties -<ParamField body='type' type='"voice" '> +<ParamField body='type' type='"voice" | "sms"'> > **type**: `"voice"` \| `"sms"` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:37 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx index 2f22f9d6f..27e355316 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx @@ -16,7 +16,7 @@ TryAnotherMethodOptions ## Properties -<ParamField body='type' type='"voice" '> +<ParamField body='type' type='"voice" | "sms"'> > **type**: `"voice"` \| `"sms"` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:54 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.mdx index eb9f0adc4..997f80175 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.mdx @@ -72,21 +72,21 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -100,28 +100,28 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation.mdx index 49bd4b500..d96f03400 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnAcceptInvitation.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -98,12 +98,14 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ inviter: string; email: string; } '> -> **data**: \{ `inviter`: `string`; `email`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:9 +<Expandable title="properties"> + <ParamField body='inviter' type='string'> -**Overrides** + </ParamField> + <ParamField body='email' type='string'> -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent.mdx index ea9ba8949..38006784d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -80,7 +80,7 @@ Screen-specific data. </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -91,7 +91,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -102,7 +102,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -113,7 +113,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='scopes' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope">Scope</a>[]}> +<ParamField body='scopes' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope">Scope</a>[]</span>}> > **scopes**: [`Scope`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/consent.d.ts:20 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent.mdx index e5ff88204..08451ca3f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -80,7 +80,7 @@ Screen-specific data. </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -91,7 +91,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -102,7 +102,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -113,7 +113,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='scopes' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope">Scope</a>[]}> +<ParamField body='scopes' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope">Scope</a>[]</span>}> > **scopes**: [`Scope`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Scope)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/customized-consent.d.ts:24 @@ -124,7 +124,7 @@ This list should be displayed to the user for their review. </ParamField> -<ParamField body='authorizationDetails' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AuthorizationDetail">AuthorizationDetail</a>[]}> +<ParamField body='authorizationDetails' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AuthorizationDetail">AuthorizationDetail</a>[]</span>}> > **authorizationDetails**: [`AuthorizationDetail`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AuthorizationDetail)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/customized-consent.d.ts:32 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx index 2816a6fdf..9030b5c51 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,12 +100,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ textCode: string; } '> -> **data**: \{ `textCode`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-confirmation.d.ts:8 +<Expandable title="properties"> + <ParamField body='textCode' type='string'> -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx index 8b1874f25..b5053fdd0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -98,12 +98,17 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ messageType?: string; email?: string; resendLimitReached?: boolean; } '> -> **data**: \{ `messageType?`: `string`; `email?`: `string`; `resendLimitReached?`: `boolean`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:11 +<Expandable title="properties"> + <ParamField body='messageType?' type='string'> -**Overrides** + </ParamField> + <ParamField body='email?' type='string'> -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> + <ParamField body='resendLimitReached?' type='boolean'> + + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge.mdx index 2e52f4325..e05a2ea4f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge.mdx @@ -24,7 +24,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -35,7 +35,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -46,7 +46,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -68,7 +68,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -79,7 +79,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -90,7 +90,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -101,7 +101,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult.mdx index 893afa2ee..bcad8f79b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -80,7 +80,7 @@ Navigation links available on this screen. </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -91,7 +91,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -102,34 +102,16 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ status: string; } '> -> **data**: \{ `status`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-verification-result.d.ts:20 - -Screen-specific data. - -**Type Declaration** - -\{ `status`: `string`; \} - -**status** - -> **status**: `string` - -The status of the email verification process. -Possible values might include "success", "failure", "already_verified", etc. -This status should be displayed to the user to inform them of the outcome. - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) +<Expandable title="properties"> + <ParamField body='status' type='string'> + </ParamField> +</Expandable> </ParamField> -<ParamField body='loginLink' type='string '> +<ParamField body='loginLink' type='string'> > **loginLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-verification-result.d.ts:32 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin.mdx index b1b997b85..bafddc2ff 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,26 +100,25 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='signupLink' type='string '> +<ParamField body='signupLink' type='string'> > **signupLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:19 </ParamField> -<ParamField body='resetPasswordLink' type='string '> +<ParamField body='resetPasswordLink' type='string'> > **resetPasswordLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:20 </ParamField> -<ParamField body='data' type='{ username?: string; } '> -> **data**: \{ `username?`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:21 +<Expandable title="properties"> + <ParamField body='username?' type='string'> -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId.mdx index 30a9d7f77..2be98ef68 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -109,22 +109,28 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='signupLink' type='string '> +<ParamField body='signupLink' type='string'> > **signupLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:27 </ParamField> -<ParamField body='resetPasswordLink' type='string '> +<ParamField body='resetPasswordLink' type='string'> > **resetPasswordLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:28 </ParamField> -<ParamField body='publicKey' type={{ challenge: string; allowCredentials?: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential">AllowCredential</a>[]; } }> -> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential)[]; \} \| `null` +<ParamField body='publicKey' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:29 +<Expandable title="properties"> + <ParamField body='challenge' type='string'> + + </ParamField> + <ParamField body='allowCredentials?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential">AllowCredential</a>[]</span>}> + + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword.mdx index 76816be4d..d35351cde 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -98,33 +98,32 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='signupLink' type='string '> +<ParamField body='signupLink' type='string'> > **signupLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:13 </ParamField> -<ParamField body='resetPasswordLink' type='string '> +<ParamField body='resetPasswordLink' type='string'> > **resetPasswordLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:14 </ParamField> -<ParamField body='editIdentifierLink' type='string '> +<ParamField body='editIdentifierLink' type='string'> > **editIdentifierLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:15 </ParamField> -<ParamField body='data' type='{ username: string; } '> -> **data**: \{ `username`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:16 +<Expandable title="properties"> + <ParamField body='username' type='string'> -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx index 2cf93f805..befe2507f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -98,33 +98,35 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='editIdentifierLink' type='string '> +<ParamField body='editIdentifierLink' type='string'> > **editIdentifierLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:7 </ParamField> -<ParamField body='resetPasswordLink' type='string '> +<ParamField body='resetPasswordLink' type='string'> > **resetPasswordLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:8 </ParamField> -<ParamField body='signupLink' type='string '> +<ParamField body='signupLink' type='string'> > **signupLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:9 </ParamField> -<ParamField body='data' type='{ email?: string; username?: string; } '> -> **data**: \{ `email?`: `string`; `username?`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:10 +<Expandable title="properties"> + <ParamField body='email?' type='string'> -**Overrides** + </ParamField> + <ParamField body='username?' type='string'> -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx index db1cfd559..2c66472ef 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -98,41 +98,35 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='signupLink' type='string '> +<ParamField body='signupLink' type='string'> > **signupLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:14 </ParamField> -<ParamField body='resetPasswordLink' type='string '> +<ParamField body='resetPasswordLink' type='string'> > **resetPasswordLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:15 </ParamField> -<ParamField body='backLink' type='string '> +<ParamField body='backLink' type='string'> > **backLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:16 </ParamField> -<ParamField body='data' type='object'> -> **data**: `object` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:17 +<Expandable title="properties"> + <ParamField body='username' type='string'> -**username** + </ParamField> + <ParamField body='phone\_number' type='string'> -> **username**: `string` - -**phone\_number** - -> **phone\_number**: `string` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes.mdx index 4d8d00cd2..15bd4169f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,24 +100,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type={{ phone_prefixes: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[]; } }> -> **data**: \{ `phone_prefixes`: [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[]; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-country-codes.d.ts:8 +<Expandable title="properties"> + <ParamField body='phone_prefixes' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[]</span>}> -**Type Declaration** - -\{ `phone_prefixes`: [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[]; \} - -**phone\_prefixes** - -> **phone\_prefixes**: [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] - -List of available phone prefixes - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge.mdx index e100a86aa..a269cdea9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailChallenge.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,12 +100,14 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ email: string; showRememberDevice?: boolean; } '> -> **data**: \{ `email`: `string`; `showRememberDevice?`: `boolean`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:10 +<Expandable title="properties"> + <ParamField body='email' type='string'> -**Overrides** + </ParamField> + <ParamField body='showRememberDevice?' type='boolean'> -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList.mdx index 3fb892058..0ab071273 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,24 +100,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ enrolled_emails: string[]; } '> -> **data**: \{ `enrolled_emails`: `string`[]; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-list.d.ts:8 +<Expandable title="properties"> + <ParamField body='enrolled_emails' type='string[]'> -**Type Declaration** - -\{ `enrolled_emails`: `string`[]; \} - -**enrolled\_emails** - -> **enrolled\_emails**: `string`[] - -List of enrolled email addresses - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult.mdx index 93ea37160..7ae751435 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,28 +100,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ status: string; } '> -> **data**: \{ `status`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-enroll-result.d.ts:17 +<Expandable title="properties"> + <ParamField body='status' type='string'> -Screen-specific data. - -**Type Declaration** - -\{ `status`: `string`; \} - -**status** - -> **status**: `string` - -The status of the MFA enrollment process. -Possible values might include "success", "failure", or other specific status codes. -This status can be used to display an appropriate message to the user. - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions.mdx index 16993ab7c..b8b34fd9b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,24 +100,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ enrolled_factors: string[]; } '> -> **data**: \{ `enrolled_factors`: `string`[]; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-login-options.d.ts:9 +<Expandable title="properties"> + <ParamField body='enrolled_factors' type='string[]'> -**Type Declaration** - -\{ `enrolled_factors`: `string`[]; \} - -**enrolled\_factors** - -> **enrolled\_factors**: `string`[] - -List of enrolled MFA factors for the user - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge.mdx index d46299992..f029cedd7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,12 +100,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ showRememberDevice?: boolean; } '> -> **data**: \{ `showRememberDevice?`: `boolean`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:8 +<Expandable title="properties"> + <ParamField body='showRememberDevice?' type='boolean'> -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx index d41c09abb..4758dd0bd 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,24 +100,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ text_code: string; } '> -> **data**: \{ `text_code`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-code.d.ts:29 +<Expandable title="properties"> + <ParamField body='text_code' type='string'> -**Type Declaration** - -\{ `text_code`: `string`; \} - -**text\_code** - -> **text\_code**: `string` - -The text code to display to the user. - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx index 29d1ada67..6e5744a79 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,12 +100,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ qr_code: string; } '> -> **data**: \{ `qr_code`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-qr.d.ts:8 +<Expandable title="properties"> + <ParamField body='qr_code' type='string'> -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx index 87b2f0878..265183ec5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,24 +100,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ phoneNumber: string; } '> -> **data**: \{ `phoneNumber`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:19 +<Expandable title="properties"> + <ParamField body='phoneNumber' type='string'> -**Type Declaration** - -\{ `phoneNumber`: `string`; \} - -**phoneNumber** - -> **phoneNumber**: `string` - -The phone number (often masked) associated with this MFA challenge. - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush.mdx index d9ec4db44..351a59d21 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,30 +100,14 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ deviceName: string; showRememberDevice?: boolean; } '> -> **data**: \{ `deviceName`: `string`; `showRememberDevice?`: `boolean`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:10 +<Expandable title="properties"> + <ParamField body='deviceName' type='string'> -**Type Declaration** + </ParamField> + <ParamField body='showRememberDevice?' type='boolean'> -\{ `deviceName`: `string`; `showRememberDevice?`: `boolean`; \} - -**deviceName** - -> **deviceName**: `string` - -The name of the device receiving the push notification - -**showRememberDevice?** - -> `optional` **showRememberDevice**: `boolean` - -Whether to show the remember device option - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx index 5ebd6d8c9..4d66e5373 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,12 +100,17 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ qrCode: string; qrUri: string; showCodeCopy: boolean; } '> -> **data**: \{ `qrCode`: `string`; `qrUri`: `string`; `showCodeCopy`: `boolean`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-enrollment-qr.d.ts:9 +<Expandable title="properties"> + <ParamField body='qrCode' type='string'> -**Overrides** + </ParamField> + <ParamField body='qrUri' type='string'> -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> + <ParamField body='showCodeCopy' type='boolean'> + + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome.mdx index ca3bc66aa..55ea455c8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -109,24 +109,20 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='screen' type='object'> -> **screen**: `object` +<ParamField body='screen' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcome.d.ts:8 +<Expandable title="properties"> + <ParamField body='name' type='string'> -**name** + </ParamField> + <ParamField body='links' type='object'> -> **name**: `string` - -**links** - -> **links**: `object` - -**links.ios** - -> **ios**: `string` + </ParamField> + <ParamField body='links.ios' type='string'> -**links.android** + </ParamField> + <ParamField body='links.android' type='string'> -> **android**: `string` + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx index f60c0e1bd..8d44cfdf9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,25 +100,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ textCode: string; } '> -> **data**: \{ `textCode`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge-new-code.d.ts:15 +<Expandable title="properties"> + <ParamField body='textCode' type='string'> -**Type Declaration** - -\{ `textCode`: `string`; \} - -**textCode** - -> **textCode**: `string` - -The newly generated recovery code to display to the user. -It is crucial that the user saves this code securely as it will be needed for future logins if other MFA factors are unavailable. - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx index f52d2758a..d1fbba327 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,24 +100,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ textCode: string; } '> -> **data**: \{ `textCode`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-enrollment.d.ts:8 +<Expandable title="properties"> + <ParamField body='textCode' type='string'> -**Type Declaration** - -\{ `textCode`: `string`; \} - -**textCode** - -> **textCode**: `string` - -The recovery code to display to the user. - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge.mdx index a3f701c59..fa1fd6e42 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,36 +100,17 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ phoneNumber?: string; showRememberDevice?: boolean; showLinkVoice?: boolean; } '> -> **data**: \{ `phoneNumber?`: `string`; `showRememberDevice?`: `boolean`; `showLinkVoice?`: `boolean`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:15 +<Expandable title="properties"> + <ParamField body='phoneNumber?' type='string'> -**Type Declaration** + </ParamField> + <ParamField body='showRememberDevice?' type='boolean'> -\{ `phoneNumber?`: `string`; `showRememberDevice?`: `boolean`; `showLinkVoice?`: `boolean`; \} + </ParamField> + <ParamField body='showLinkVoice?' type='boolean'> -**phoneNumber?** - -> `optional` **phoneNumber**: `string` - -The phone number where the SMS was sent - -**showRememberDevice?** - -> `optional` **showRememberDevice**: `boolean` - -Whether to show the remember device option - -**showLinkVoice?** - -> `optional` **showLinkVoice**: `boolean` - -Whether to show the link to switch to voice call verification - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx index 50795761e..2e6f6e434 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -98,12 +98,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ phone?: string; } '> -> **data**: \{ `phone?`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:10 +<Expandable title="properties"> + <ParamField body='phone?' type='string'> -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx index 548ffafd5..73a34028c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,38 +100,17 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ phoneNumber?: string; showRememberDevice?: boolean; showLinkSms?: boolean; } '> -> **data**: \{ `phoneNumber?`: `string`; `showRememberDevice?`: `boolean`; `showLinkSms?`: `boolean`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:30 +<Expandable title="properties"> + <ParamField body='phoneNumber?' type='string'> -Additional screen data specific to MFA voice challenge. + </ParamField> + <ParamField body='showRememberDevice?' type='boolean'> -**Type Declaration** + </ParamField> + <ParamField body='showLinkSms?' type='boolean'> -\{ `phoneNumber?`: `string`; `showRememberDevice?`: `boolean`; `showLinkSms?`: `boolean`; \} - -**phoneNumber?** - -> `optional` **phoneNumber**: `string` - -The phone number where the voice code was sent. - -**showRememberDevice?** - -> `optional` **showRememberDevice**: `boolean` - -Whether to show the remember device option. - -**showLinkSms?** - -> `optional` **showLinkSms**: `boolean` - -Whether to show the link to switch to SMS verification. - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx index 73e8c5620..c94cceb70 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,37 +100,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ nickname: string; } '> -> **data**: \{ `nickname`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-change-key-nickname.d.ts:19 +<Expandable title="properties"> + <ParamField body='nickname' type='string'> -Screen-specific data. - -**Type Declaration** - -\{ `nickname`: `string`; \} - -**nickname** - -> **nickname**: `string` - -The current nickname of the WebAuthn security key that the user is about to change. -This value should be displayed to the user for context. - -**Examples** - -```ts -"My YubiKey" -``` - -```ts -"Work Security Key" -``` - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx index 075760f57..f20c96c44 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,45 +100,14 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type={{ nickname: string; webauthnType: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType">WebAuthnType</a>; } }> -> **data**: \{ `nickname`: `string`; `webauthnType`: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType); \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-enrollment-success.d.ts:21 +<Expandable title="properties"> + <ParamField body='nickname' type='string'> -Screen-specific data. + </ParamField> + <ParamField body='webauthnType' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType">WebAuthnType</a>}> -**Type Declaration** - -\{ `nickname`: `string`; `webauthnType`: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType); \} - -**nickname** - -> **nickname**: `string` - -The nickname that the user (or system) assigned to the newly enrolled WebAuthn authenticator. -This helps the user identify the authenticator later. - -**Examples** - -```ts -"YubiKey 5" -``` - -```ts -"My Laptop's Touch ID" -``` - -**webauthnType** - -> **webauthnType**: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType) - -The type of WebAuthn authenticator that was successfully enrolled. -- `'webauthn-roaming'`: Indicates a roaming authenticator like a USB security key. -- `'webauthn-platform'`: Indicates a platform authenticator like Touch ID or Windows Hello. - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError.mdx index 5ce784d33..06f7679d3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,30 +100,14 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type={{ errorType: string; webauthnType: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType">WebAuthnType</a>; } }> -> **data**: \{ `errorType`: `string`; `webauthnType`: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType); \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-error.d.ts:26 +<Expandable title="properties"> + <ParamField body='errorType' type='string'> -**Type Declaration** + </ParamField> + <ParamField body='webauthnType' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType">WebAuthnType</a>}> -\{ `errorType`: `string`; `webauthnType`: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType); \} - -**errorType** - -> **errorType**: `string` - -A code or message describing the WebAuthn error. - -**webauthnType** - -> **webauthnType**: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/WebAuthnType) - -The type of WebAuthn authenticator involved. - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx index 68c62f3fe..c4dc7ffaa 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -80,7 +80,7 @@ Screen-specific data. </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -91,7 +91,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -102,7 +102,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -113,14 +113,16 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='publicKey' type={{ challenge: string; allowCredentials?: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential">AllowCredential</a>[]; } }> -> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential)[]; \} \| `null` +<ParamField body='publicKey' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:22 +<Expandable title="properties"> + <ParamField body='challenge' type='string'> -The public key credential request options (specifically the challenge) -needed to call `navigator.credentials.get()`. This is derived from `universal_login_context.screen.data.passkey.public_key`. + </ParamField> + <ParamField body='allowCredentials?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential">AllowCredential</a>[]</span>}> + </ParamField> +</Expandable> </ParamField> <ParamField body='showRememberDevice' type='boolean'> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx index 88face9d6..7f8696201 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -100,7 +100,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -111,8 +111,17 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='publicKey' type='{ user: { id: string; name: string; displayName: string; }; rp: { id: string; name: string; }; challenge: string; pubKeyCredParams: [{ type: string; alg: number; }]; authenticatorSelection: { residentKey: string; userVerification: string; authenticatorAttachment?: string; }; } '> -> **publicKey**: \{ `user`: \{ `id`: `string`; `name`: `string`; `displayName`: `string`; \}; `rp`: \{ `id`: `string`; `name`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `type`: `string`; `alg`: `number`; \}\]; `authenticatorSelection`: \{ `residentKey`: `string`; `userVerification`: `string`; `authenticatorAttachment?`: `string`; \}; \} \| `null` +<ParamField body='publicKey' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:17 +<Expandable title="properties"> + <ParamField body='user' type='{ id: string'> + + </ParamField> + <ParamField body='name' type='string'> + + </ParamField> + <ParamField body='displayName' type='string'> + + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx index 2b07c1f5c..a94355516 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -80,7 +80,7 @@ Screen-specific data. </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -91,7 +91,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -102,7 +102,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -120,15 +120,21 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-ro </ParamField> -<ParamField body='webauthnType' type='string '> +<ParamField body='webauthnType' type='string'> > **webauthnType**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:18 </ParamField> -<ParamField body='publicKey' type={{ challenge: string; allowCredentials?: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential">AllowCredential</a>[]; } }> -> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential)[]; \} \| `null` +<ParamField body='publicKey' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:19 +<Expandable title="properties"> + <ParamField body='challenge' type='string'> + + </ParamField> + <ParamField body='allowCredentials?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential">AllowCredential</a>[]</span>}> + + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx index 6644d7fe8..e1efba062 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -100,7 +100,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -111,15 +111,24 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='webauthnType' type='string '> +<ParamField body='webauthnType' type='string'> > **webauthnType**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:8 </ParamField> -<ParamField body='publicKey' type='{ user: { id: string; name: string; displayName: string; }; rp: { id: string; name: string; }; challenge: string; pubKeyCredParams: [{ type: string; alg: number; }]; authenticatorSelection: { residentKey: string; userVerification: string; authenticatorAttachment?: string; }; } '> -> **publicKey**: \{ `user`: \{ `id`: `string`; `name`: `string`; `displayName`: `string`; \}; `rp`: \{ `id`: `string`; `name`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `type`: `string`; `alg`: `number`; \}\]; `authenticatorSelection`: \{ `residentKey`: `string`; `userVerification`: `string`; `authenticatorAttachment?`: `string`; \}; \} \| `null` +<ParamField body='publicKey' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:9 +<Expandable title="properties"> + <ParamField body='user' type='{ id: string'> + + </ParamField> + <ParamField body='name' type='string'> + + </ParamField> + <ParamField body='displayName' type='string'> + + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection.mdx index 292056cc0..f3d003d3d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -100,7 +100,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment.mdx index 9b9741354..90bc48662 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -109,22 +109,31 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='backLink' type='string '> +<ParamField body='backLink' type='string'> > **backLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:16 </ParamField> -<ParamField body='loginLink' type='string '> +<ParamField body='loginLink' type='string'> > **loginLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:17 </ParamField> -<ParamField body='publicKey' type='{ user: { id: string; name: string; displayName: string; }; rp: { id: string; name: string; }; challenge: string; pubKeyCredParams: [{ type: string; alg: number; }]; authenticatorSelection: { residentKey: string; userVerification: string; authenticatorAttachment?: string; }; } '> -> **publicKey**: \{ `user`: \{ `id`: `string`; `name`: `string`; `displayName`: `string`; \}; `rp`: \{ `id`: `string`; `name`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `type`: `string`; `alg`: `number`; \}\]; `authenticatorSelection`: \{ `residentKey`: `string`; `userVerification`: `string`; `authenticatorAttachment?`: `string`; \}; \} \| `null` +<ParamField body='publicKey' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:18 +<Expandable title="properties"> + <ParamField body='user' type='{ id: string'> + + </ParamField> + <ParamField body='name' type='string'> + + </ParamField> + <ParamField body='displayName' type='string'> + + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx index eb55404fa..d0e1ff905 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -109,8 +109,17 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='publicKey' type='{ user: { id: string; name: string; displayName: string; }; rp: { id: string; name: string; }; challenge: string; pubKeyCredParams: [{ type: string; alg: number; }]; authenticatorSelection: { residentKey: string; userVerification: string; authenticatorAttachment?: string; }; } '> -> **publicKey**: \{ `user`: \{ `id`: `string`; `name`: `string`; `displayName`: `string`; \}; `rp`: \{ `id`: `string`; `name`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `type`: `string`; `alg`: `number`; \}\]; `authenticatorSelection`: \{ `residentKey`: `string`; `userVerification`: `string`; `authenticatorAttachment?`: `string`; \}; \} \| `null` +<ParamField body='publicKey' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment-local.d.ts:20 +<Expandable title="properties"> + <ParamField body='user' type='{ id: string'> + + </ParamField> + <ParamField body='name' type='string'> + + </ParamField> + <ParamField body='displayName' type='string'> + + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx index 856c8daf1..b7804ecee 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -98,12 +98,23 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ messageType?: "text" '> -> **data**: \{ `messageType?`: `"text"` \| `"voice"`; `phone?`: `string`; `resendLimitReached?`: `boolean`; `showLinkSms?`: `boolean`; `showLinkVoice?`: `boolean`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:23 +<Expandable title="properties"> + <ParamField body='messageType?' type='"text" | "voice"'> -**Overrides** + </ParamField> + <ParamField body='phone?' type='string'> -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> + <ParamField body='resendLimitReached?' type='boolean'> + + </ParamField> + <ParamField body='showLinkSms?' type='boolean'> + + </ParamField> + <ParamField body='showLinkVoice?' type='boolean'> + + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx index 28b48899e..525d34bba 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -98,18 +98,19 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ phone?: "string"; messageType?: "text" '> -> **data**: \{ `phone?`: `"string"`; `messageType?`: `"text"` \| `"voice"`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:9 +<Expandable title="properties"> + <ParamField body='phone?' type='"string"'> -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> + <ParamField body='messageType?' type='"text" | "voice"'> + </ParamField> +</Expandable> </ParamField> -<ParamField body='editIdentifierLink' type='string '> +<ParamField body='editIdentifierLink' type='string'> > **editIdentifierLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:13 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword.mdx index 29134b494..e3f0dbef7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -98,12 +98,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ username?: string; } '> -> **data**: \{ `username?`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:14 +<Expandable title="properties"> + <ParamField body='username?' type='string'> -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail.mdx index 186872730..58857f545 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -98,12 +98,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ username?: string; } '> -> **data**: \{ `username?`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-email.d.ts:11 +<Expandable title="properties"> + <ParamField body='username?' type='string'> -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError.mdx index a712169db..2246508d6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -98,12 +98,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ username?: string; } '> -> **data**: \{ `username?`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-error.d.ts:10 +<Expandable title="properties"> + <ParamField body='username?' type='string'> -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx index b60e3ce20..e13ce235d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,12 +100,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ email: string; } '> -> **data**: \{ `email`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-email-challenge.d.ts:8 +<Expandable title="properties"> + <ParamField body='email' type='string'> -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx index 68f5f1724..57c5ac6d7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,24 +100,11 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ phoneNumber: string; } '> -> **data**: \{ `phoneNumber`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:19 +<Expandable title="properties"> + <ParamField body='phoneNumber' type='string'> -**Type Declaration** - -\{ `phoneNumber`: `string`; \} - -**phoneNumber** - -> **phoneNumber**: `string` - -The phone number (often masked) associated with this MFA challenge. - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx index d595bddc7..1accccc7a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,12 +100,14 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ deviceName: string; rememberDevice?: boolean; } '> -> **data**: \{ `deviceName`: `string`; `rememberDevice?`: `boolean`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-push-challenge-push.d.ts:9 +<Expandable title="properties"> + <ParamField body='deviceName' type='string'> -**Overrides** + </ParamField> + <ParamField body='rememberDevice?' type='boolean'> -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx index 6713a019c..4447a91b8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -98,28 +98,14 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ phoneNumber: string; showLinkVoice?: boolean; } '> -> **data**: \{ `phoneNumber`: `string`; `showLinkVoice?`: `boolean`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:10 +<Expandable title="properties"> + <ParamField body='phoneNumber' type='string'> -**Type Declaration** + </ParamField> + <ParamField body='showLinkVoice?' type='boolean'> -\{ `phoneNumber`: `string`; `showLinkVoice?`: `boolean`; \} - -**phoneNumber** - -> **phoneNumber**: `string` - -**showLinkVoice?** - -> `optional` **showLinkVoice**: `boolean` - -Whether to show the link to switch to voice call verification - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx index 3ed5f855b..252cfd4c1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -100,30 +100,14 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ phoneNumber: string; showLinkSms?: boolean; } '> -> **data**: \{ `phoneNumber`: `string`; `showLinkSms?`: `boolean`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-voice-challenge.d.ts:9 +<Expandable title="properties"> + <ParamField body='phoneNumber' type='string'> -**Type Declaration** + </ParamField> + <ParamField body='showLinkSms?' type='boolean'> -\{ `phoneNumber`: `string`; `showLinkSms?`: `boolean`; \} - -**phoneNumber** - -> **phoneNumber**: `string` - -The phone number to send the voice call to. - -**showLinkSms?** - -> `optional` **showLinkSms**: `boolean` - -Whether to show the link to switch to SMS verification. - -`null` - -**Overrides** - -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx index 53624aeff..4c6d91e6f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -80,7 +80,7 @@ Screen-specific data. </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -91,7 +91,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -102,7 +102,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -113,15 +113,16 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='publicKey' type={{ challenge: string; allowCredentials?: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential">AllowCredential</a>[]; } }> -> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential)[]; \} \| `null` +<ParamField body='publicKey' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:35 +<Expandable title="properties"> + <ParamField body='challenge' type='string'> -A convenience accessor for `data.passkey.public_key`. - Provides the challenge and other parameters for the - WebAuthn `navigator.credentials.get()` API call. + </ParamField> + <ParamField body='allowCredentials?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential">AllowCredential</a>[]</span>}> + </ParamField> +</Expandable> </ParamField> <ParamField body='showRememberDevice' type='boolean'> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx index 30da8fbab..133f5114b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx @@ -23,7 +23,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -67,7 +67,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -81,7 +81,7 @@ including WebAuthn challenge options and the "show remember device" flag. </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -92,7 +92,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -103,7 +103,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -114,14 +114,16 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='publicKey' type={{ challenge: string; allowCredentials?: <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential">AllowCredential</a>[]; } }> -> **publicKey**: \{ `challenge`: `string`; `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential)[]; \} \| `null` +<ParamField body='publicKey' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:50 +<Expandable title="properties"> + <ParamField body='challenge' type='string'> -A convenience accessor for `screen.data.passkey.public_key`. -Provides the challenge and related options for `navigator.credentials.get()`. + </ParamField> + <ParamField body='allowCredentials?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AllowCredential">AllowCredential</a>[]</span>}> + </ParamField> +</Expandable> </ParamField> <ParamField body='showRememberDevice' type='boolean'> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest.mdx index 96c56d506..192b8b4d0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -98,12 +98,17 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='data' type='{ phone?: string; email?: string; username?: string; } '> -> **data**: \{ `phone?`: `string`; `email?`: `string`; `username?`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:17 +<Expandable title="properties"> + <ParamField body='phone?' type='string'> -**Overrides** + </ParamField> + <ParamField body='email?' type='string'> -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> + <ParamField body='username?' type='string'> + + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess.mdx index d191cbfb8..d80245945 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup.mdx index 830b4f20b..0778fe87e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -109,7 +109,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='loginLink' type='string '> +<ParamField body='loginLink' type='string'> > **loginLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:22 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId.mdx index 0e56f5f27..b339f49fe 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='data' type='Record<string, string '> +<ParamField body='data' type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix">PhonePrefix</a>[] | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate">PasskeyCreate</a>></span>}> > **data**: `Record`\<`string`, `string` \| `boolean` \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhonePrefix)[] \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate)\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:76 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -109,7 +109,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='loginLink' type='string '> +<ParamField body='loginLink' type='string'> > **loginLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:23 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword.mdx index e3350f334..ed22f2afc 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword.mdx @@ -21,7 +21,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 </ParamField> -<ParamField body='captchaImage' type='string '> +<ParamField body='captchaImage' type='string'> > **captchaImage**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 </ParamField> -<ParamField body='captchaSiteKey' type='string '> +<ParamField body='captchaSiteKey' type='string'> > **captchaSiteKey**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 </ParamField> -<ParamField body='captchaProvider' type='string '> +<ParamField body='captchaProvider' type='string'> > **captchaProvider**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 @@ -65,7 +65,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 </ParamField> -<ParamField body='links' type='Record<string, string> '> +<ParamField body='links' type='Record<string, string>'> > **links**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 </ParamField> -<ParamField body='texts' type='Record<string, string> '> +<ParamField body='texts' type='Record<string, string>'> > **texts**: `Record`\<`string`, `string`\> \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 </ParamField> -<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a> }> +<ParamField body='captcha' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext">CaptchaContext</a>}> > **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CaptchaContext) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 @@ -98,26 +98,31 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:79 </ParamField> -<ParamField body='loginLink' type='string '> +<ParamField body='loginLink' type='string'> > **loginLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:25 </ParamField> -<ParamField body='editLink' type='string '> +<ParamField body='editLink' type='string'> > **editLink**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:26 </ParamField> -<ParamField body='data' type='{ email?: string; phoneNumber?: string; username?: string; } '> -> **data**: \{ `email?`: `string`; `phoneNumber?`: `string`; `username?`: `string`; \} \| `null` +<ParamField body='data' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:27 +<Expandable title="properties"> + <ParamField body='email?' type='string'> -**Overrides** + </ParamField> + <ParamField body='phoneNumber?' type='string'> -[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers.md#data) + </ParamField> + <ParamField body='username?' type='string'> + + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions.mdx index 763961140..cbe9ababf 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions.mdx @@ -22,7 +22,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/resend-control.d. </ParamField> -<ParamField body='onTimeout()?' type='() => void'> +<ParamField body='onTimeout()?' type='() => void'> > `optional` **onTimeout**: () => `void` Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/resend-control.d.ts:13 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions.mdx index 810542d20..c4c93be82 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions.mdx @@ -10,7 +10,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordl ## Properties -<ParamField body='code' type='string '> +<ParamField body='code' type='string | number'> > **code**: `string` \| `number` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:19 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers.mdx index 96e9bb3c5..c5d795f68 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TenantMembers.mdx @@ -6,28 +6,28 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/tenant.d.ts:7 ## Properties -<ParamField body='name' type='string '> +<ParamField body='name' type='string'> > **name**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/tenant.d.ts:8 </ParamField> -<ParamField body='friendlyName' type='string '> +<ParamField body='friendlyName' type='string'> > **friendlyName**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/tenant.d.ts:9 </ParamField> -<ParamField body='enabledLocales' type='string[] '> +<ParamField body='enabledLocales' type='string[]'> > **enabledLocales**: `string`[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/tenant.d.ts:10 </ParamField> -<ParamField body='enabledFactors' type='string[] '> +<ParamField body='enabledFactors' type='string[]'> > **enabledFactors**: `string`[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/tenant.d.ts:11 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.mdx index 191bf9b5a..d13055e36 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers.mdx @@ -33,21 +33,21 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryCode' type='string '> +<ParamField body='countryCode' type='string'> > **countryCode**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 </ParamField> -<ParamField body='countryPrefix' type='string '> +<ParamField body='countryPrefix' type='string'> > **countryPrefix**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 </ParamField> -<ParamField body='connectionStrategy' type='string '> +<ParamField body='connectionStrategy' type='string'> > **connectionStrategy**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 @@ -61,21 +61,21 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[]</span>}> > **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 </ParamField> -<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a>}> > **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 </ParamField> -<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='alternateConnections' type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[]</span>}> > **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin.mdx index bc6bc2f6b..bce09f2d8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin.mdx @@ -34,7 +34,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryCode' type='string '> +<ParamField body='countryCode' type='string'> > **countryCode**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 @@ -45,7 +45,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryPrefix' type='string '> +<ParamField body='countryPrefix' type='string'> > **countryPrefix**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 @@ -56,7 +56,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='connectionStrategy' type='string '> +<ParamField body='connectionStrategy' type='string'> > **connectionStrategy**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 @@ -78,7 +78,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[]</span>}> > **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 @@ -89,7 +89,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a>}> > **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 @@ -100,7 +100,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='alternateConnections' type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[]</span>}> > **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 @@ -132,14 +132,14 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:37 </ParamField> -<ParamField body='passwordPolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy">PasswordPolicy</a> }> +<ParamField body='passwordPolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy">PasswordPolicy</a>}> > **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:38 </ParamField> -<ParamField body='allowedIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +<ParamField body='allowedIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> > **allowedIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:39 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId.mdx index 1f132b007..4ecacdc05 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId.mdx @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryCode' type='string '> +<ParamField body='countryCode' type='string'> > **countryCode**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryPrefix' type='string '> +<ParamField body='countryPrefix' type='string'> > **countryPrefix**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 @@ -54,7 +54,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='connectionStrategy' type='string '> +<ParamField body='connectionStrategy' type='string'> > **connectionStrategy**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[]</span>}> > **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a>}> > **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='alternateConnections' type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[]</span>}> > **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 @@ -137,14 +137,14 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:3 </ParamField> -<ParamField body='usernamePolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy">UsernamePolicy</a> }> +<ParamField body='usernamePolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy">UsernamePolicy</a>}> > **usernamePolicy**: [`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:36 </ParamField> -<ParamField body='allowedIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +<ParamField body='allowedIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> > **allowedIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:37 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword.mdx index aa7860ae6..def17806d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword.mdx @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryCode' type='string '> +<ParamField body='countryCode' type='string'> > **countryCode**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryPrefix' type='string '> +<ParamField body='countryPrefix' type='string'> > **countryPrefix**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 @@ -54,7 +54,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='connectionStrategy' type='string '> +<ParamField body='connectionStrategy' type='string'> > **connectionStrategy**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[]</span>}> > **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a>}> > **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='alternateConnections' type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[]</span>}> > **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx index 5be573aab..7bdde0e67 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryCode' type='string '> +<ParamField body='countryCode' type='string'> > **countryCode**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryPrefix' type='string '> +<ParamField body='countryPrefix' type='string'> > **countryPrefix**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 @@ -54,7 +54,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='connectionStrategy' type='string '> +<ParamField body='connectionStrategy' type='string'> > **connectionStrategy**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[]</span>}> > **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a>}> > **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='alternateConnections' type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[]</span>}> > **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 @@ -109,7 +109,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='isSignupEnabled' type='boolean '> +<ParamField body='isSignupEnabled' type='boolean'> > **isSignupEnabled**: `boolean` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:16 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx index b48852531..dbd7e7e45 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryCode' type='string '> +<ParamField body='countryCode' type='string'> > **countryCode**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryPrefix' type='string '> +<ParamField body='countryPrefix' type='string'> > **countryPrefix**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 @@ -54,7 +54,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='connectionStrategy' type='string '> +<ParamField body='connectionStrategy' type='string'> > **connectionStrategy**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[]</span>}> > **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a>}> > **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='alternateConnections' type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[]</span>}> > **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword.mdx index e8224c0ec..6336fdda6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword.mdx @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryCode' type='string '> +<ParamField body='countryCode' type='string'> > **countryCode**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryPrefix' type='string '> +<ParamField body='countryPrefix' type='string'> > **countryPrefix**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 @@ -54,7 +54,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='connectionStrategy' type='string '> +<ParamField body='connectionStrategy' type='string'> > **connectionStrategy**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[]</span>}> > **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a>}> > **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='alternateConnections' type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[]</span>}> > **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 @@ -109,7 +109,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='passwordPolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy">PasswordPolicy</a> }> +<ParamField body='passwordPolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy">PasswordPolicy</a>}> > **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:19 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest.mdx index e6e7d9a3e..7d6d97d46 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest.mdx @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryCode' type='string '> +<ParamField body='countryCode' type='string'> > **countryCode**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryPrefix' type='string '> +<ParamField body='countryPrefix' type='string'> > **countryPrefix**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 @@ -54,7 +54,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='connectionStrategy' type='string '> +<ParamField body='connectionStrategy' type='string'> > **connectionStrategy**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[]</span>}> > **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a>}> > **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='alternateConnections' type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[]</span>}> > **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 @@ -109,14 +109,14 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='allowedIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +<ParamField body='allowedIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> > **allowedIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:12 </ParamField> -<ParamField body='requiredIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +<ParamField body='requiredIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> > **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:13 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup.mdx index d235dc034..ad4edc018 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup.mdx @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryCode' type='string '> +<ParamField body='countryCode' type='string'> > **countryCode**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryPrefix' type='string '> +<ParamField body='countryPrefix' type='string'> > **countryPrefix**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 @@ -54,7 +54,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='connectionStrategy' type='string '> +<ParamField body='connectionStrategy' type='string'> > **connectionStrategy**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[]</span>}> > **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a>}> > **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='alternateConnections' type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[]</span>}> > **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 @@ -116,28 +116,28 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:25 </ParamField> -<ParamField body='usernamePolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy">UsernamePolicy</a> }> +<ParamField body='usernamePolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy">UsernamePolicy</a>}> > **usernamePolicy**: [`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:26 </ParamField> -<ParamField body='requiredIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +<ParamField body='requiredIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> > **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:27 </ParamField> -<ParamField body='optionalIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +<ParamField body='optionalIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> > **optionalIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:28 </ParamField> -<ParamField body='passwordPolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy">PasswordPolicy</a> }> +<ParamField body='passwordPolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy">PasswordPolicy</a>}> > **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:29 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId.mdx index 9112605f1..4b7fe979d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId.mdx @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryCode' type='string '> +<ParamField body='countryCode' type='string'> > **countryCode**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryPrefix' type='string '> +<ParamField body='countryPrefix' type='string'> > **countryPrefix**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 @@ -54,7 +54,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='connectionStrategy' type='string '> +<ParamField body='connectionStrategy' type='string'> > **connectionStrategy**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[]</span>}> > **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a>}> > **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='alternateConnections' type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[]</span>}> > **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 @@ -116,21 +116,21 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts: </ParamField> -<ParamField body='usernamePolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy">UsernamePolicy</a> }> +<ParamField body='usernamePolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy">UsernamePolicy</a>}> > **usernamePolicy**: [`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:27 </ParamField> -<ParamField body='requiredIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +<ParamField body='requiredIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> > **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:28 </ParamField> -<ParamField body='optionalIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +<ParamField body='optionalIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> > **optionalIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:29 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword.mdx index ff7a3b4e3..2f0d48b90 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword.mdx @@ -32,7 +32,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryCode' type='string '> +<ParamField body='countryCode' type='string'> > **countryCode**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 @@ -43,7 +43,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='countryPrefix' type='string '> +<ParamField body='countryPrefix' type='string'> > **countryPrefix**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 @@ -54,7 +54,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='connectionStrategy' type='string '> +<ParamField body='connectionStrategy' type='string'> > **connectionStrategy**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 @@ -76,7 +76,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[] }> +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error">Error</a>[]</span>}> > **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:158 @@ -87,7 +87,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='currentConnection' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a>}> > **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:159 @@ -98,7 +98,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='alternateConnections' type={(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> }> +<ParamField body='alternateConnections' type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[]</span>}> > **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection))[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:160 @@ -116,21 +116,21 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password </ParamField> -<ParamField body='passwordPolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy">PasswordPolicy</a> }> +<ParamField body='passwordPolicy' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy">PasswordPolicy</a>}> > **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy) \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:35 </ParamField> -<ParamField body='requiredIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +<ParamField body='requiredIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> > **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:36 </ParamField> -<ParamField body='optionalIdentifiers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[] }> +<ParamField body='optionalIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> > **optionalIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:37 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.mdx index fc4ed5271..fc8a1bd69 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.mdx @@ -14,15 +14,20 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d ## Properties -<ParamField body='submittedFormData' type='{[key: string]: string '> -> **submittedFormData**: \{\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `null` \| `undefined`; \} \| `null` +<ParamField body='submittedFormData' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:14 +<Expandable title="properties"> + <ParamField body='key' type='string]: string | number | boolean| undefined'> + </ParamField> +</Expandable> </ParamField> -<ParamField body='authorizationParams' type='{[key: ext-${string} ]: string; login_hint?: string; screen_hint?: string; ui_locales?: string; } '> -> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null` +<ParamField body='authorizationParams' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:17 +<Expandable title="properties"> + <ParamField body='key' type='ext-${string'> + + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx index 0c976bebc..9afcc1be3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx @@ -12,23 +12,20 @@ Interface for untrusted data specific to mfa-email-challenge screen ## Properties -<ParamField body='authorizationParams' type='{[key: ext-${string} ]: string; login_hint?: string; screen_hint?: string; ui_locales?: string; } '> -> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null` +<ParamField body='authorizationParams' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:17 - -**Inherited from** - -[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`authorizationParams`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#authorizationparams) +<Expandable title="properties"> + <ParamField body='key' type='ext-${string'> + </ParamField> +</Expandable> </ParamField> -<ParamField body='submittedFormData' type='{ rememberDevice: boolean; } '> -> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null` - -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:19 +<ParamField body='submittedFormData' type="object"> -**Overrides** +<Expandable title="properties"> + <ParamField body='rememberDevice' type='boolean'> -[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`submittedFormData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#submittedformdata) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx index e88e80204..e41d9f14c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx @@ -12,23 +12,20 @@ Interface for untrusted data specific to mfa-otp-challenge screen ## Properties -<ParamField body='authorizationParams' type='{[key: ext-${string} ]: string; login_hint?: string; screen_hint?: string; ui_locales?: string; } '> -> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null` +<ParamField body='authorizationParams' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:17 - -**Inherited from** - -[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`authorizationParams`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#authorizationparams) +<Expandable title="properties"> + <ParamField body='key' type='ext-${string'> + </ParamField> +</Expandable> </ParamField> -<ParamField body='submittedFormData' type='{ rememberDevice: boolean; } '> -> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null` - -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:16 +<ParamField body='submittedFormData' type="object"> -**Overrides** +<Expandable title="properties"> + <ParamField body='rememberDevice' type='boolean'> -[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`submittedFormData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#submittedformdata) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx index 9569a1785..6d257a5ec 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx @@ -12,23 +12,20 @@ Interface for untrusted data specific to mfa-push-challenge-push screen ## Properties -<ParamField body='authorizationParams' type='{[key: ext-${string} ]: string; login_hint?: string; screen_hint?: string; ui_locales?: string; } '> -> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null` +<ParamField body='authorizationParams' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:17 - -**Inherited from** - -[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`authorizationParams`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#authorizationparams) +<Expandable title="properties"> + <ParamField body='key' type='ext-${string'> + </ParamField> +</Expandable> </ParamField> -<ParamField body='submittedFormData' type='{ rememberDevice: boolean; } '> -> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null` - -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:21 +<ParamField body='submittedFormData' type="object"> -**Overrides** +<Expandable title="properties"> + <ParamField body='rememberDevice' type='boolean'> -[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`submittedFormData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#submittedformdata) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx index b76881f58..d6fe6f6f4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx @@ -12,23 +12,20 @@ Interface for untrusted data specific to mfa-sms-challenge screen ## Properties -<ParamField body='authorizationParams' type='{[key: ext-${string} ]: string; login_hint?: string; screen_hint?: string; ui_locales?: string; } '> -> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null` +<ParamField body='authorizationParams' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:17 - -**Inherited from** - -[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`authorizationParams`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#authorizationparams) +<Expandable title="properties"> + <ParamField body='key' type='ext-${string'> + </ParamField> +</Expandable> </ParamField> -<ParamField body='submittedFormData' type='{ rememberDevice: boolean; } '> -> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null` - -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:48 +<ParamField body='submittedFormData' type="object"> -**Overrides** +<Expandable title="properties"> + <ParamField body='rememberDevice' type='boolean'> -[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`submittedFormData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#submittedformdata) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx index ceb411151..9f03a294c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx @@ -12,23 +12,20 @@ Interface for untrusted data specific to mfa-voice-challenge screen ## Properties -<ParamField body='authorizationParams' type='{[key: ext-${string} ]: string; login_hint?: string; screen_hint?: string; ui_locales?: string; } '> -> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null` +<ParamField body='authorizationParams' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:17 - -**Inherited from** - -[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`authorizationParams`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#authorizationparams) +<Expandable title="properties"> + <ParamField body='key' type='ext-${string'> + </ParamField> +</Expandable> </ParamField> -<ParamField body='submittedFormData' type='{ rememberDevice: boolean; } '> -> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null` - -Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-challenge.d.ts:132 +<ParamField body='submittedFormData' type="object"> -**Overrides** +<Expandable title="properties"> + <ParamField body='rememberDevice' type='boolean'> -[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers).[`submittedFormData`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.md#submittedformdata) + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions.mdx index b8621d009..d086340dc 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorOptions.mdx @@ -2,12 +2,12 @@ title: "UseErrorOptions" --- -Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:17](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L17) +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:17](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L17) ## Properties <ParamField body='includeDevErrors?' type='boolean'> > `optional` **includeDevErrors**: `boolean` -Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L18) +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:18](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L18) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult.mdx index 0c516fcf5..90f9e62a5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult.mdx @@ -2,28 +2,28 @@ title: "UseErrorsResult" --- -Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:21](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L21) +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:21](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L21) ## Properties <ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult">ErrorsResult</a>}> > **errors**: [`ErrorsResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult) -Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:22](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L22) +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:22](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L22) </ParamField> <ParamField body='hasError' type='boolean'> > **hasError**: `boolean` -Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L23) +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L23) </ParamField> -<ParamField body='dismiss()' type='(id) => void'> +<ParamField body='dismiss()' type='(id) => void'> > **dismiss**: (`id`) => `void` -Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:24](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L24) +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:24](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L24) **Parameters** @@ -37,10 +37,10 @@ Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:24](https://gi </ParamField> -<ParamField body='dismissAll()' type='() => void'> +<ParamField body='dismissAll()' type='() => void'> > **dismissAll**: () => `void` -Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:25](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/common/errors.ts#L25) +Defined in: [packages/auth0-acul-react/src/hooks/common/errors.ts:25](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L25) **Returns** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions.mdx index 09135dde7..5ee4b6419 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendOptions.mdx @@ -2,7 +2,7 @@ title: "UseResendOptions" --- -Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:18](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L18) +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:18](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L18) Optional configuration for [useResend](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend). @@ -11,17 +11,17 @@ Optional configuration for [useResend](/docs/customize/login-pages/advanced-cust <ParamField body='timeoutSeconds?' type='number'> > `optional` **timeoutSeconds**: `number` -Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:23](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L23) +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:23](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L23) Countdown duration (in seconds) before another resend is allowed. Defaults to `10`. </ParamField> -<ParamField body='onTimeout()?' type='() => void'> +<ParamField body='onTimeout()?' type='() => void'> > `optional` **onTimeout**: () => `void` -Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:28](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L28) +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:28](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L28) Callback fired when the countdown finishes and the resend action becomes available again. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn.mdx index 007139d8d..7b6c3f4f9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseResendReturn.mdx @@ -2,7 +2,7 @@ title: "UseResendReturn" --- -Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:8](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L8) +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:8](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L8) Return type for [useResend](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/functions/useResend). @@ -11,7 +11,7 @@ Return type for [useResend](/docs/customize/login-pages/advanced-customizations/ <ParamField body='remaining' type='number'> > **remaining**: `number` -Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:10](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L10) +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:10](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L10) Seconds remaining until the next resend attempt is allowed. @@ -20,16 +20,16 @@ Seconds remaining until the next resend attempt is allowed. <ParamField body='disabled' type='boolean'> > **disabled**: `boolean` -Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:12](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L12) +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:12](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L12) Whether the resend action is currently disabled. </ParamField> -<ParamField body='startResend()' type='() => void'> +<ParamField body='startResend()' type='() => void'> > **startResend**: () => `void` -Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:14](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L14) +Defined in: [packages/auth0-acul-react/src/hooks/utility/resend-manager.ts:14](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/utility/resend-manager.ts#L14) Start a resend attempt immediately, if allowed. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers.mdx index 58cb65990..61c7a9bdb 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers.mdx @@ -6,85 +6,90 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:34 ## Properties -<ParamField body='id' type='string '> +<ParamField body='id' type='string'> > **id**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:35 </ParamField> -<ParamField body='email' type='string '> +<ParamField body='email' type='string'> > **email**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:36 </ParamField> -<ParamField body='username' type='string '> +<ParamField body='username' type='string'> > **username**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:37 </ParamField> -<ParamField body='phoneNumber' type='string '> +<ParamField body='phoneNumber' type='string'> > **phoneNumber**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:38 </ParamField> -<ParamField body='picture' type='string '> +<ParamField body='picture' type='string'> > **picture**: `string` \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:39 </ParamField> -<ParamField body='enrolledFactors' type='string[] '> +<ParamField body='enrolledFactors' type='string[]'> > **enrolledFactors**: `string`[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:40 </ParamField> -<ParamField body='enrolledEmails' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledEmail">EnrolledEmail</a>[] }> +<ParamField body='enrolledEmails' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledEmail">EnrolledEmail</a>[]</span>}> > **enrolledEmails**: [`EnrolledEmail`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledEmail)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:41 </ParamField> -<ParamField body='enrolledPhoneNumbers' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledPhoneNumber">EnrolledPhoneNumber</a>[] }> +<ParamField body='enrolledPhoneNumbers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledPhoneNumber">EnrolledPhoneNumber</a>[]</span>}> > **enrolledPhoneNumbers**: [`EnrolledPhoneNumber`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledPhoneNumber)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:42 </ParamField> -<ParamField body='enrolledDevices' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledDevice">EnrolledDevice</a>[] }> +<ParamField body='enrolledDevices' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledDevice">EnrolledDevice</a>[]</span>}> > **enrolledDevices**: [`EnrolledDevice`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnrolledDevice)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:43 </ParamField> -<ParamField body='organizations' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations">Organizations</a>[] }> +<ParamField body='organizations' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations">Organizations</a>[]</span>}> > **organizations**: [`Organizations`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Organizations)[] \| `null` Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:44 </ParamField> -<ParamField body='userMetadata' type='{[key: string]: string; } '> -> **userMetadata**: \{\[`key`: `string`\]: `string`; \} \| `null` +<ParamField body='userMetadata' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:45 +<Expandable title="properties"> + <ParamField body='key' type='string]: string'> + </ParamField> +</Expandable> </ParamField> -<ParamField body='appMetadata' type='{[key: string]: string; } '> -> **appMetadata**: \{\[`key`: `string`\]: `string`; \} \| `null` +<ParamField body='appMetadata' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:48 +<Expandable title="properties"> + <ParamField body='key' type='string]: string'> + + </ParamField> +</Expandable> </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy.mdx index 3687e45f2..1d3b6db04 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy.mdx @@ -27,16 +27,7 @@ Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts </ParamField> -<ParamField body='allowedFormats?' type='object'> -> `optional` **allowedFormats**: `object` +<ParamField body='allowedFormats?' type="object"> -Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:46 -**usernameInEmailFormat?** - -> `optional` **usernameInEmailFormat**: `boolean` - -**usernameInPhoneFormat?** - -> `optional` **usernameInPhoneFormat**: `boolean` </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult.mdx index 623e230c3..b3cdebf75 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult.mdx @@ -17,7 +17,7 @@ Indicates whether the username passed all validation rules. </ParamField> -<ParamField body='errors' type={<a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationError">UsernameValidationError</a>[]}> +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationError">UsernameValidationError</a>[]</span>}> > **errors**: [`UsernameValidationError`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationError)[] Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/validate-username.d.ts:38 diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind.mdx index 39d329ac2..9cb1e8ae0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind.mdx @@ -4,4 +4,4 @@ title: "Type Alias: ErrorKind" > **ErrorKind** = `"server"` \| `"client"` \| `"developer"` -Defined in: [packages/auth0-acul-react/src/state/error-store.ts:9](https://github.com/WriteChoiceMigration/universal-login/blob/79e6cc195f7925469d498589518d9c044e7ab14f/packages/auth0-acul-react/src/state/error-store.ts#L9) \ No newline at end of file +Defined in: [packages/auth0-acul-react/src/state/error-store.ts:9](https://github.com/WriteChoiceMigration/universal-login/blob/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/state/error-store.ts#L9) \ No newline at end of file From ceeda9549f312a6c663bc76dc383be025301141a Mon Sep 17 00:00:00 2001 From: gabrielraeder <gabrielraeder@outlook.com.br> Date: Mon, 17 Nov 2025 12:02:35 -0300 Subject: [PATCH 5/7] new js sdk formated pages --- main/docs.json | 807 ++++++++---------- .../reference/js-sdk/README.md | 46 - .../Screens/classes/AcceptInvitation.mdx | 273 ++++++ .../js-sdk/Screens/classes/AculError.mdx | 84 ++ .../Screens/classes/Auth0ServerError.mdx | 78 ++ .../js-sdk/Screens/classes/Consent.mdx | 433 ++++++++++ .../Screens/classes/CustomizedConsent.mdx | 433 ++++++++++ .../Screens/classes/DeviceCodeActivation.mdx | 300 +++++++ .../classes/DeviceCodeActivationAllowed.mdx | 217 +++++ .../classes/DeviceCodeActivationDenied.mdx | 217 +++++ .../classes/DeviceCodeConfirmation.mdx | 326 +++++++ .../classes/EmailIdentifierChallenge.mdx | 441 ++++++++++ .../Screens/classes/EmailOTPChallenge.mdx | 417 +++++++++ .../classes/EmailVerificationResult.mdx | 262 ++++++ .../Screens/classes/InterstitialCaptcha.mdx | 264 ++++++ .../js-sdk/Screens/classes/Login.mdx | 427 +++++++++ .../classes/LoginEmailVerification.mdx | 581 +++++++++++++ .../js-sdk/Screens/classes/LoginId.mdx | 698 +++++++++++++++ .../js-sdk/Screens/classes/LoginPassword.mdx | 348 ++++++++ .../classes/LoginPasswordlessEmailCode.mdx | 402 +++++++++ .../classes/LoginPasswordlessSmsOtp.mdx | 399 +++++++++ .../js-sdk/Screens/classes/Logout.mdx | 276 ++++++ .../js-sdk/Screens/classes/LogoutAborted.mdx | 217 +++++ .../js-sdk/Screens/classes/LogoutComplete.mdx | 217 +++++ .../Screens/classes/MfaBeginEnrollOptions.mdx | 269 ++++++ .../Screens/classes/MfaCountryCodes.mdx | 352 ++++++++ .../classes/MfaDetectBrowserCapabilities.mdx | 271 ++++++ .../Screens/classes/MfaEmailChallenge.mdx | 538 ++++++++++++ .../js-sdk/Screens/classes/MfaEmailList.mdx | 347 ++++++++ .../Screens/classes/MfaEnrollResult.mdx | 271 ++++++ .../Screens/classes/MfaLoginOptions.mdx | 323 +++++++ .../Screens/classes/MfaOtpChallenge.mdx | 344 ++++++++ .../Screens/classes/MfaOtpEnrollmentCode.mdx | 350 ++++++++ .../Screens/classes/MfaOtpEnrollmentQr.mdx | 399 +++++++++ .../Screens/classes/MfaPhoneChallenge.mdx | 430 ++++++++++ .../Screens/classes/MfaPhoneEnrollment.mdx | 426 +++++++++ .../Screens/classes/MfaPushChallengePush.mdx | 400 +++++++++ .../Screens/classes/MfaPushEnrollmentQr.mdx | 380 +++++++++ .../js-sdk/Screens/classes/MfaPushList.mdx | 328 +++++++ .../js-sdk/Screens/classes/MfaPushWelcome.mdx | 329 +++++++ .../classes/MfaRecoveryCodeChallenge.mdx | 358 ++++++++ .../MfaRecoveryCodeChallengeNewCode.mdx | 337 ++++++++ .../classes/MfaRecoveryCodeEnrollment.mdx | 304 +++++++ .../Screens/classes/MfaSmsChallenge.mdx | 591 +++++++++++++ .../Screens/classes/MfaSmsEnrollment.mdx | 404 +++++++++ .../js-sdk/Screens/classes/MfaSmsList.mdx | 353 ++++++++ .../Screens/classes/MfaVoiceChallenge.mdx | 619 ++++++++++++++ .../Screens/classes/MfaVoiceEnrollment.mdx | 410 +++++++++ .../classes/MfaWebAuthnChangeKeyNickname.mdx | 322 +++++++ .../classes/MfaWebAuthnEnrollmentSuccess.mdx | 344 ++++++++ .../Screens/classes/MfaWebAuthnError.mdx | 494 +++++++++++ .../classes/MfaWebAuthnNotAvailableError.mdx | 311 +++++++ .../classes/MfaWebAuthnPlatformChallenge.mdx | 453 ++++++++++ .../classes/MfaWebAuthnPlatformEnrollment.mdx | 473 ++++++++++ .../classes/MfaWebAuthnRoamingChallenge.mdx | 454 ++++++++++ .../classes/MfaWebAuthnRoamingEnrollment.mdx | 409 +++++++++ .../Screens/classes/OrganizationPicker.mdx | 346 ++++++++ .../Screens/classes/OrganizationSelection.mdx | 287 +++++++ .../Screens/classes/PasskeyEnrollment.mdx | 309 +++++++ .../classes/PasskeyEnrollmentLocal.mdx | 317 +++++++ .../classes/PhoneIdentifierChallenge.mdx | 533 ++++++++++++ .../classes/PhoneIdentifierEnrollment.mdx | 308 +++++++ .../js-sdk/Screens/classes/RedeemTicket.mdx | 283 ++++++ .../js-sdk/Screens/classes/ResetPassword.mdx | 301 +++++++ .../Screens/classes/ResetPasswordEmail.mdx | 256 ++++++ .../Screens/classes/ResetPasswordError.mdx | 212 +++++ .../ResetPasswordMfaEmailChallenge.mdx | 469 ++++++++++ .../classes/ResetPasswordMfaOtpChallenge.mdx | 336 ++++++++ .../ResetPasswordMfaPhoneChallenge.mdx | 420 +++++++++ .../ResetPasswordMfaPushChallengePush.mdx | 546 ++++++++++++ .../ResetPasswordMfaRecoveryCodeChallenge.mdx | 361 ++++++++ .../classes/ResetPasswordMfaSmsChallenge.mdx | 520 +++++++++++ .../ResetPasswordMfaVoiceChallenge.mdx | 497 +++++++++++ ...etPasswordMfaWebAuthnPlatformChallenge.mdx | 372 ++++++++ ...setPasswordMfaWebAuthnRoamingChallenge.mdx | 380 +++++++++ .../Screens/classes/ResetPasswordRequest.mdx | 350 ++++++++ .../Screens/classes/ResetPasswordSuccess.mdx | 209 +++++ .../js-sdk/Screens/classes/SDKUsageError.mdx | 78 ++ .../js-sdk/Screens/classes/Signup.mdx | 528 ++++++++++++ .../js-sdk/Screens/classes/SignupId.mdx | 528 ++++++++++++ .../js-sdk/Screens/classes/SignupPassword.mdx | 456 ++++++++++ .../js-sdk/Screens/classes/UserInputError.mdx | 78 ++ .../Screens/functions/getCurrentScreen.mdx | 17 + .../functions/getCurrentScreenOptions.mdx | 17 + .../functions/getCurrentThemeOptions.mdx | 17 + .../js-sdk/Screens/functions/getErrors.mdx | 17 + .../reference/js-sdk/Screens/index.mdx | 384 +++++++++ .../interfaces/AbortEnrollmentOptions.mdx | 27 + .../interfaces/AcceptInvitationMembers.mdx | 149 ++++ .../Screens/interfaces/AllowCredential.mdx | 38 + .../interfaces/AuthorizationDetail.mdx | 27 + .../js-sdk/Screens/interfaces/BaseMembers.mdx | 165 ++++ .../js-sdk/Screens/interfaces/Branding.mdx | 41 + .../Screens/interfaces/BrandingMembers.mdx | 30 + .../Screens/interfaces/BrandingSettings.mdx | 64 ++ .../Screens/interfaces/BrandingThemes.mdx | 53 ++ .../Screens/interfaces/CaptchaContext.mdx | 38 + .../Screens/interfaces/ClientMembers.mdx | 54 ++ .../interfaces/ConfirmLogoutOptions.mdx | 35 + .../js-sdk/Screens/interfaces/Connection.mdx | 42 + .../Screens/interfaces/ConsentMembers.mdx | 279 ++++++ .../Screens/interfaces/ContinueOTPOptions.mdx | 46 + .../Screens/interfaces/ContinueOptions.mdx | 46 + .../interfaces/ContinuePayloadOptions.mdx | 46 + .../ContinueWithCodeOptionPayload.mdx | 55 ++ .../ContinueWithOrganizationNameOptions.mdx | 39 + .../Screens/interfaces/CredentialResponse.mdx | 38 + .../interfaces/CurrentScreenOptions.mdx | 90 ++ .../Screens/interfaces/CustomOptions.mdx | 50 ++ .../interfaces/CustomizedConsentMembers.mdx | 283 ++++++ .../DeviceCodeActivationAllowedMembers.mdx | 118 +++ .../DeviceCodeActivationContinueOptions.mdx | 36 + .../DeviceCodeActivationDeniedMembers.mdx | 118 +++ .../DeviceCodeActivationMembers.mdx | 156 ++++ .../DeviceCodeConfirmationMembers.mdx | 175 ++++ .../interfaces/EmailChallengeOptions.mdx | 35 + .../EmailIdentifierChallengeMembers.mdx | 191 +++++ .../interfaces/EmailOTPChallengeMembers.mdx | 199 +++++ .../EmailVerificationResultMembers.mdx | 127 +++ .../Screens/interfaces/EnrolledDevice.mdx | 30 + .../Screens/interfaces/EnrolledEmail.mdx | 30 + .../interfaces/EnrolledPhoneNumber.mdx | 30 + .../interfaces/EnterpriseConnection.mdx | 75 ++ .../js-sdk/Screens/interfaces/Error.mdx | 46 + .../interfaces/FederatedLoginOptions.mdx | 27 + .../FederatedLoginPasswordOptions.mdx | 27 + .../FederatedLoginPayloadOptions.mdx | 35 + .../interfaces/FederatedSignupOptions.mdx | 27 + .../FederatedSignupPasswordPayloadOptions.mdx | 27 + .../FederatedSignupPayloadOptions.mdx | 27 + .../Screens/interfaces/FlattenedTheme.mdx | 54 ++ .../js-sdk/Screens/interfaces/Identifier.mdx | 59 ++ .../interfaces/InterstitialCaptchaMembers.mdx | 134 +++ .../LoginEmailVerificationMembers.mdx | 367 ++++++++ .../Screens/interfaces/LoginEnrollOptions.mdx | 35 + .../Screens/interfaces/LoginIdMembers.mdx | 204 +++++ .../Screens/interfaces/LoginMembers.mdx | 223 +++++ .../Screens/interfaces/LoginOptions.mdx | 35 + .../interfaces/LoginPasswordMembers.mdx | 156 ++++ .../interfaces/LoginPasswordOptions.mdx | 43 + .../LoginPasswordlessEmailCodeMembers.mdx | 174 ++++ .../LoginPasswordlessSmsOtpMembers.mdx | 182 ++++ .../interfaces/LoginPayloadOptions.mdx | 57 ++ .../interfaces/LogoutAbortedMembers.mdx | 118 +++ .../interfaces/LogoutCompleteMembers.mdx | 118 +++ .../Screens/interfaces/LogoutMembers.mdx | 146 ++++ .../MfaBeginEnrollOptionsMembers.mdx | 146 ++++ .../interfaces/MfaCountryCodesMembers.mdx | 173 ++++ .../MfaDetectBrowserCapabilitiesMembers.mdx | 158 ++++ .../interfaces/MfaEmailChallengeMembers.mdx | 257 ++++++ .../interfaces/MfaEmailListMembers.mdx | 173 ++++ .../Screens/interfaces/MfaEnrollOptions.mdx | 35 + .../interfaces/MfaEnrollResultMembers.mdx | 131 +++ .../interfaces/MfaLoginOptionsMembers.mdx | 201 +++++ .../interfaces/MfaOtpChallengeMembers.mdx | 176 ++++ .../interfaces/MfaOtpContinueOptions.mdx | 40 + .../MfaOtpEnrollmentCodeMembers.mdx | 180 ++++ .../MfaOtpEnrollmentQrContinueOptions.mdx | 32 + .../interfaces/MfaOtpEnrollmentQrMembers.mdx | 202 +++++ .../MfaOtpTryAnotherMethodOptions.mdx | 25 + .../MfaPhoneChallengeContinueOptions.mdx | 50 ++ .../interfaces/MfaPhoneChallengeMembers.mdx | 302 +++++++ ...PhoneChallengePickAuthenticatorOptions.mdx | 24 + .../MfaPhoneChallengePickPhoneOptions.mdx | 25 + .../MfaPhoneEnrollmentContinueOptions.mdx | 42 + .../interfaces/MfaPhoneEnrollmentMembers.mdx | 204 +++++ .../MfaPushChallengePushMembers.mdx | 260 ++++++ .../interfaces/MfaPushEnrollmentQrMembers.mdx | 167 ++++ .../Screens/interfaces/MfaPushListMembers.mdx | 172 ++++ .../interfaces/MfaPushPollingControl.mdx | 139 +++ .../interfaces/MfaPushWelcomeMembers.mdx | 155 ++++ ...faRecoveryCodeChallengeContinueOptions.mdx | 32 + .../MfaRecoveryCodeChallengeMembers.mdx | 185 ++++ ...eryCodeChallengeNewCodeContinueOptions.mdx | 25 + ...MfaRecoveryCodeChallengeNewCodeMembers.mdx | 202 +++++ ...aRecoveryCodeEnrollmentContinueOptions.mdx | 30 + .../MfaRecoveryCodeEnrollmentMembers.mdx | 159 ++++ .../interfaces/MfaSmsChallengeMembers.mdx | 236 +++++ .../interfaces/MfaSmsChallengeOptions.mdx | 35 + .../interfaces/MfaSmsEnrollmentMembers.mdx | 179 ++++ .../interfaces/MfaSmsEnrollmentOptions.mdx | 35 + .../Screens/interfaces/MfaSmsListMembers.mdx | 180 ++++ .../Screens/interfaces/MfaSmsListOptions.mdx | 40 + .../MfaVoiceChallengeContinueOptions.mdx | 54 ++ .../interfaces/MfaVoiceChallengeMembers.mdx | 381 +++++++++ .../MfaVoiceEnrollmentContinueOptions.mdx | 32 + .../interfaces/MfaVoiceEnrollmentMembers.mdx | 215 +++++ ...bAuthnChangeKeyNicknameContinueOptions.mdx | 44 + .../MfaWebAuthnChangeKeyNicknameMembers.mdx | 235 +++++ .../MfaWebAuthnEnrollmentSuccessMembers.mdx | 196 +++++ .../interfaces/MfaWebAuthnErrorMembers.mdx | 326 +++++++ .../MfaWebAuthnNotAvailableErrorMembers.mdx | 183 ++++ .../MfaWebAuthnPlatformChallengeMembers.mdx | 354 ++++++++ ...thnPlatformChallengeReportErrorOptions.mdx | 31 + ...atformChallengeTryAnotherMethodOptions.mdx | 22 + .../MfaWebAuthnPlatformEnrollmentMembers.mdx | 334 ++++++++ .../MfaWebAuthnRoamingChallengeMembers.mdx | 340 ++++++++ ...uthnRoamingChallengeReportErrorOptions.mdx | 26 + ...oamingChallengeTryAnotherMethodOptions.mdx | 22 + .../MfaWebAuthnRoamingEnrollmentMembers.mdx | 295 +++++++ ...amingEnrollmentTryAnotherMethodOptions.mdx | 25 + .../interfaces/OrganizationMembers.mdx | 62 ++ .../interfaces/OrganizationPickerMembers.mdx | 179 ++++ .../OrganizationSelectionMembers.mdx | 152 ++++ .../Screens/interfaces/Organizations.mdx | 46 + .../Screens/interfaces/OtpCodeOptions.mdx | 35 + .../Screens/interfaces/PasskeyCreate.mdx | 95 +++ .../interfaces/PasskeyCreateResponse.mdx | 54 ++ .../PasskeyEnrollmentLocalMembers.mdx | 155 ++++ .../interfaces/PasskeyEnrollmentMembers.mdx | 155 ++++ .../interfaces/PasswordComplexityRule.mdx | 78 ++ .../Screens/interfaces/PasswordPolicy.mdx | 46 + .../interfaces/PasswordValidationResult.mdx | 53 ++ .../interfaces/PhoneChallengeOptions.mdx | 35 + .../interfaces/PhoneEnrollmentOptions.mdx | 27 + .../PhoneIdentifierChallengeMembers.mdx | 227 +++++ .../PhoneIdentifierEnrollmentMembers.mdx | 155 ++++ .../js-sdk/Screens/interfaces/PhonePrefix.mdx | 47 + .../Screens/interfaces/PromptMembers.mdx | 22 + .../interfaces/RedeemTicketMembers.mdx | 176 ++++ .../interfaces/ReportBrowserErrorOptions.mdx | 40 + .../Screens/interfaces/ResendCodeOptions.mdx | 23 + .../interfaces/ResendCodeOptionsPayload.mdx | 25 + .../interfaces/ResendCodePayloadOptions.mdx | 23 + .../Screens/interfaces/ResendControl.mdx | 27 + .../interfaces/ResetPasswordEmailMembers.mdx | 137 +++ .../interfaces/ResetPasswordEmailOptions.mdx | 18 + .../interfaces/ResetPasswordErrorMembers.mdx | 118 +++ .../interfaces/ResetPasswordMembers.mdx | 156 ++++ .../ResetPasswordMfaEmailChallengeMembers.mdx | 229 +++++ ...PasswordMfaOtpChallengeContinueOptions.mdx | 35 + .../ResetPasswordMfaOtpChallengeMembers.mdx | 172 ++++ ...MfaOtpChallengeTryAnotherMethodOptions.mdx | 23 + ...sswordMfaPhoneChallengeContinueOptions.mdx | 42 + .../ResetPasswordMfaPhoneChallengeMembers.mdx | 289 +++++++ ...aPhoneChallengeTryAnotherMethodOptions.mdx | 44 + ...setPasswordMfaPushChallengePushMembers.mdx | 256 ++++++ ...asswordMfaRecoveryCodeChallengeMembers.mdx | 187 ++++ .../ResetPasswordMfaSmsChallengeMembers.mdx | 217 +++++ .../ResetPasswordMfaSmsChallengeOptions.mdx | 27 + ...sswordMfaVoiceChallengeContinueOptions.mdx | 37 + .../ResetPasswordMfaVoiceChallengeMembers.mdx | 285 +++++++ ...bAuthnPlatformChallengeContinueOptions.mdx | 41 + ...ordMfaWebAuthnPlatformChallengeMembers.mdx | 348 ++++++++ ...thnPlatformChallengeReportErrorOptions.mdx | 33 + ...atformChallengeTryAnotherMethodOptions.mdx | 25 + ...wordMfaWebAuthnRoamingChallengeMembers.mdx | 274 ++++++ ...bAuthnRoamingChallengeShowErrorOptions.mdx | 51 ++ ...oamingChallengeTryAnotherMethodOptions.mdx | 41 + ...nRoamingChallengeUseSecurityKeyOptions.mdx | 43 + .../interfaces/ResetPasswordOptions.mdx | 35 + .../ResetPasswordRequestMembers.mdx | 168 ++++ .../ResetPasswordRequestOptions.mdx | 35 + .../ResetPasswordSuccessMembers.mdx | 118 +++ .../js-sdk/Screens/interfaces/Scope.mdx | 30 + .../Screens/interfaces/ScreenMembers.mdx | 145 ++++ .../ScreenMembersOnAcceptInvitation.mdx | 121 +++ .../interfaces/ScreenMembersOnConsent.mdx | 137 +++ .../ScreenMembersOnCustomizedConsent.mdx | 160 ++++ .../ScreenMembersOnDeviceCodeConfirmation.mdx | 122 +++ ...creenMembersOnEmailIdentifierChallenge.mdx | 122 +++ .../ScreenMembersOnEmailOTPChallenge.mdx | 121 +++ ...ScreenMembersOnEmailVerificationResult.mdx | 164 ++++ .../interfaces/ScreenMembersOnLogin.mdx | 138 +++ .../interfaces/ScreenMembersOnLoginId.mdx | 141 +++ .../ScreenMembersOnLoginPassword.mdx | 144 ++++ ...eenMembersOnLoginPasswordlessEmailCode.mdx | 145 ++++ ...ScreenMembersOnLoginPasswordlessSmsOtp.mdx | 153 ++++ .../ScreenMembersOnMfaCountryCodes.mdx | 135 +++ .../ScreenMembersOnMfaEmailChallenge.mdx | 123 +++ .../ScreenMembersOnMfaEmailList.mdx | 135 +++ .../ScreenMembersOnMfaEnrollResult.mdx | 148 ++++ .../ScreenMembersOnMfaLoginOptions.mdx | 135 +++ .../ScreenMembersOnMfaOtpChallenge.mdx | 122 +++ .../ScreenMembersOnMfaOtpEnrollmentCode.mdx | 137 +++ .../ScreenMembersOnMfaOtpEnrollmentQr.mdx | 122 +++ .../ScreenMembersOnMfaPhoneChallenge.mdx | 139 +++ .../ScreenMembersOnMfaPushChallengePush.mdx | 143 ++++ .../ScreenMembersOnMfaPushEnrollmentQr.mdx | 124 +++ .../ScreenMembersOnMfaPushWelcome.mdx | 147 ++++ ...mbersOnMfaRecoveryCodeChallengeNewCode.mdx | 143 ++++ ...reenMembersOnMfaRecoveryCodeEnrollment.mdx | 137 +++ .../ScreenMembersOnMfaSmsChallenge.mdx | 157 ++++ .../ScreenMembersOnMfaSmsEnrollment.mdx | 120 +++ .../ScreenMembersOnMfaVoiceChallenge.mdx | 164 ++++ ...nMembersOnMfaWebAuthnChangeKeyNickname.mdx | 158 ++++ ...nMembersOnMfaWebAuthnEnrollmentSuccess.mdx | 173 ++++ .../ScreenMembersOnMfaWebAuthnError.mdx | 154 ++++ ...nMembersOnMfaWebAuthnPlatformChallenge.mdx | 153 ++++ ...MembersOnMfaWebAuthnPlatformEnrollment.mdx | 132 +++ ...enMembersOnMfaWebAuthnRoamingChallenge.mdx | 145 ++++ ...nMembersOnMfaWebAuthnRoamingEnrollment.mdx | 135 +++ .../ScreenMembersOnOrganizationSelection.mdx | 167 ++++ .../ScreenMembersOnPasskeyEnrollment.mdx | 141 +++ .../ScreenMembersOnPasskeyEnrollmentLocal.mdx | 125 +++ ...creenMembersOnPhoneIdentifierChallenge.mdx | 124 +++ ...reenMembersOnPhoneIdentifierEnrollment.mdx | 129 +++ .../ScreenMembersOnResetPassword.mdx | 120 +++ .../ScreenMembersOnResetPasswordEmail.mdx | 120 +++ .../ScreenMembersOnResetPasswordError.mdx | 120 +++ ...embersOnResetPasswordMfaEmailChallenge.mdx | 122 +++ ...embersOnResetPasswordMfaPhoneChallenge.mdx | 139 +++ ...ersOnResetPasswordMfaPushChallengePush.mdx | 118 +++ ...nMembersOnResetPasswordMfaSmsChallenge.mdx | 140 +++ ...embersOnResetPasswordMfaVoiceChallenge.mdx | 148 ++++ ...etPasswordMfaWebAuthnPlatformChallenge.mdx | 157 ++++ ...setPasswordMfaWebAuthnRoamingChallenge.mdx | 160 ++++ .../ScreenMembersOnResetPasswordRequest.mdx | 122 +++ .../ScreenMembersOnResetPasswordSuccess.mdx | 116 +++ .../interfaces/ScreenMembersOnSignup.mdx | 125 +++ .../interfaces/ScreenMembersOnSignupId.mdx | 125 +++ .../ScreenMembersOnSignupPassword.mdx | 138 +++ .../interfaces/SelectCountryCodeOptions.mdx | 46 + .../interfaces/SelectMfaEmailOptions.mdx | 40 + .../interfaces/SelectMfaPushDeviceOptions.mdx | 36 + .../interfaces/SelectOrganizationOptions.mdx | 30 + .../Screens/interfaces/ShowErrorOptions.mdx | 39 + .../Screens/interfaces/SignupIdMembers.mdx | 204 +++++ .../Screens/interfaces/SignupMembers.mdx | 268 ++++++ .../Screens/interfaces/SignupOptions.mdx | 51 ++ .../interfaces/SignupPasswordMembers.mdx | 174 ++++ .../interfaces/SignupPasswordOptions.mdx | 59 ++ .../interfaces/SignupPayloadOptions.mdx | 59 ++ .../Screens/interfaces/StartResendOptions.mdx | 43 + .../interfaces/SubmitCaptchaOptions.mdx | 27 + .../Screens/interfaces/SubmitCodeOptions.mdx | 35 + .../Screens/interfaces/SubmitOTPOptions.mdx | 43 + .../SubmitPasskeyCredentialOptions.mdx | 24 + .../Screens/interfaces/TenantMembers.mdx | 46 + .../Screens/interfaces/TransactionMembers.mdx | 99 +++ .../interfaces/TransactionMembersOnLogin.mdx | 159 ++++ .../TransactionMembersOnLoginId.mdx | 165 ++++ .../TransactionMembersOnLoginPassword.mdx | 178 ++++ ...ionMembersOnLoginPasswordlessEmailCode.mdx | 125 +++ ...actionMembersOnLoginPasswordlessSmsOtp.mdx | 125 +++ .../TransactionMembersOnResetPassword.mdx | 125 +++ ...ansactionMembersOnResetPasswordRequest.mdx | 141 +++ .../interfaces/TransactionMembersOnSignup.mdx | 157 ++++ .../TransactionMembersOnSignupId.mdx | 149 ++++ .../TransactionMembersOnSignupPassword.mdx | 149 ++++ ...TryAnotherMethodMfaOtpChallengeOptions.mdx | 23 + .../interfaces/TryAnotherMethodOptions.mdx | 23 + .../TryAnotherMethodPayloadOptions.mdx | 23 + .../interfaces/UntrustedDataMembers.mdx | 43 + ...ntrustedDataMembersOnMfaEmailChallenge.mdx | 45 + .../UntrustedDataMembersOnMfaOtpChallenge.mdx | 45 + ...ustedDataMembersOnMfaPushChallengePush.mdx | 41 + .../UntrustedDataMembersOnMfaSmsChallenge.mdx | 45 + ...ntrustedDataMembersOnMfaVoiceChallenge.mdx | 45 + .../js-sdk/Screens/interfaces/UserMembers.mdx | 110 +++ .../Screens/interfaces/UsernamePolicy.mdx | 57 ++ .../interfaces/UsernameValidationError.mdx | 67 ++ .../interfaces/UsernameValidationResult.mdx | 49 ++ .../VerifyPlatformAuthenticatorOptions.mdx | 40 + .../interfaces/VerifySecurityKeyOptions.mdx | 35 + .../WebAuthnEnrollSuccessContinueOptions.mdx | 25 + .../interfaces/WebAuthnErrorDetails.mdx | 52 ++ .../interfaces/WithRememberOptions.mdx | 30 + .../type-aliases/AuthenticatorTransport.mdx | 16 + .../Screens/type-aliases/IdentifierType.mdx | 18 + .../type-aliases/MfaEnrollFactorType.mdx | 18 + .../type-aliases/MfaLoginFactorType.mdx | 28 + .../type-aliases/MfaPollingOptions.mdx | 113 +++ .../type-aliases/OnStatusChangeCallback.mdx | 35 + .../type-aliases/ScreenIdentifierType.mdx | 26 + .../Screens/type-aliases/WebAuthnType.mdx | 16 + .../js-sdk/classes/AcceptInvitation.mdx | 131 --- .../reference/js-sdk/classes/AculError.mdx | 16 - .../js-sdk/classes/Auth0ServerError.mdx | 16 - .../reference/js-sdk/classes/BaseContext.mdx | 60 -- .../reference/js-sdk/classes/Branding.mdx | 38 - .../classes/BruteForceProtectionUnblock.mdx | 151 ---- .../BruteForceProtectionUnblockFailure.mdx | 89 -- .../BruteForceProtectionUnblockSuccess.mdx | 86 -- .../reference/js-sdk/classes/Client.mdx | 30 - .../reference/js-sdk/classes/Consent.mdx | 273 ------ .../js-sdk/classes/CustomizedConsent.mdx | 319 ------- .../js-sdk/classes/DeviceCodeActivation.mdx | 140 --- .../classes/DeviceCodeActivationAllowed.mdx | 89 -- .../classes/DeviceCodeActivationDenied.mdx | 84 -- .../js-sdk/classes/DeviceCodeConfirmation.mdx | 179 ---- .../classes/EmailIdentifierChallenge.mdx | 285 ------- .../js-sdk/classes/EmailOTPChallenge.mdx | 86 -- .../classes/EmailVerificationResult.mdx | 184 ---- .../reference/js-sdk/classes/FormHandler.mdx | 36 - .../js-sdk/classes/InterstitialCaptcha.mdx | 152 ---- .../reference/js-sdk/classes/Login.mdx | 280 ------ .../js-sdk/classes/LoginEmailVerification.mdx | 378 -------- .../reference/js-sdk/classes/LoginId.mdx | 178 ---- .../js-sdk/classes/LoginPassword.mdx | 90 -- .../classes/LoginPasswordlessEmailCode.mdx | 218 ----- .../classes/LoginPasswordlessSmsOtp.mdx | 264 ------ .../reference/js-sdk/classes/Logout.mdx | 168 ---- .../js-sdk/classes/LogoutAborted.mdx | 123 --- .../js-sdk/classes/LogoutComplete.mdx | 123 --- .../js-sdk/classes/MfaBeginEnrollOptions.mdx | 168 ---- .../js-sdk/classes/MfaCountryCodes.mdx | 173 ---- .../classes/MfaDetectBrowserCapabilities.mdx | 165 ---- .../js-sdk/classes/MfaEmailChallenge.mdx | 343 -------- .../reference/js-sdk/classes/MfaEmailList.mdx | 167 ---- .../js-sdk/classes/MfaEnrollResult.mdx | 221 ----- .../js-sdk/classes/MfaLoginOptions.mdx | 184 ---- .../js-sdk/classes/MfaOtpChallenge.mdx | 244 ------ .../js-sdk/classes/MfaOtpEnrollmentCode.mdx | 194 ----- .../js-sdk/classes/MfaOtpEnrollmentQr.mdx | 211 ----- .../js-sdk/classes/MfaPhoneChallenge.mdx | 302 ------- .../js-sdk/classes/MfaPhoneEnrollment.mdx | 233 ----- .../js-sdk/classes/MfaPushChallengePush.mdx | 424 --------- .../js-sdk/classes/MfaPushEnrollmentQr.mdx | 165 ---- .../reference/js-sdk/classes/MfaPushList.mdx | 167 ---- .../js-sdk/classes/MfaPushWelcome.mdx | 160 ---- .../classes/MfaRecoveryCodeChallenge.mdx | 175 ---- .../MfaRecoveryCodeChallengeNewCode.mdx | 213 ----- .../classes/MfaRecoveryCodeEnrollment.mdx | 138 --- .../js-sdk/classes/MfaSmsChallenge.mdx | 335 -------- .../js-sdk/classes/MfaSmsEnrollment.mdx | 189 ---- .../reference/js-sdk/classes/MfaSmsList.mdx | 154 ---- .../js-sdk/classes/MfaVoiceChallenge.mdx | 508 ----------- .../js-sdk/classes/MfaVoiceEnrollment.mdx | 205 ----- .../classes/MfaWebAuthnChangeKeyNickname.mdx | 69 -- .../classes/MfaWebAuthnEnrollmentSuccess.mdx | 70 -- .../js-sdk/classes/MfaWebAuthnError.mdx | 97 --- .../classes/MfaWebAuthnNotAvailableError.mdx | 69 -- .../classes/MfaWebAuthnPlatformChallenge.mdx | 88 -- .../classes/MfaWebAuthnPlatformEnrollment.mdx | 97 --- .../classes/MfaWebAuthnRoamingChallenge.mdx | 82 -- .../classes/MfaWebAuthnRoamingEnrollment.mdx | 86 -- .../reference/js-sdk/classes/Organization.mdx | 34 - .../js-sdk/classes/OrganizationPicker.mdx | 164 ---- .../js-sdk/classes/OrganizationSelection.mdx | 142 --- .../js-sdk/classes/PasskeyEnrollment.mdx | 91 -- .../js-sdk/classes/PasskeyEnrollmentLocal.mdx | 187 ---- .../classes/PhoneIdentifierChallenge.mdx | 299 ------- .../classes/PhoneIdentifierEnrollment.mdx | 183 ---- .../reference/js-sdk/classes/Prompt.mdx | 14 - .../reference/js-sdk/classes/RedeemTicket.mdx | 147 ---- .../js-sdk/classes/ResetPassword.mdx | 205 ----- .../js-sdk/classes/ResetPasswordEmail.mdx | 112 --- .../js-sdk/classes/ResetPasswordError.mdx | 98 --- .../ResetPasswordMfaEmailChallenge.mdx | 262 ------ .../classes/ResetPasswordMfaOtpChallenge.mdx | 193 ----- .../ResetPasswordMfaPhoneChallenge.mdx | 273 ------ .../ResetPasswordMfaPushChallengePush.mdx | 241 ------ .../ResetPasswordMfaRecoveryCodeChallenge.mdx | 177 ---- .../classes/ResetPasswordMfaSmsChallenge.mdx | 259 ------ .../ResetPasswordMfaVoiceChallenge.mdx | 301 ------- ...etPasswordMfaWebAuthnPlatformChallenge.mdx | 88 -- ...setPasswordMfaWebAuthnRoamingChallenge.mdx | 88 -- .../js-sdk/classes/ResetPasswordRequest.mdx | 144 ---- .../js-sdk/classes/ResetPasswordSuccess.mdx | 89 -- .../js-sdk/classes/SDKUsageError.mdx | 16 - .../reference/js-sdk/classes/Screen.mdx | 66 -- .../js-sdk/classes/ScreenOverride.mdx | 65 -- .../reference/js-sdk/classes/Signup.mdx | 317 ------- .../reference/js-sdk/classes/SignupId.mdx | 333 -------- .../js-sdk/classes/SignupPassword.mdx | 281 ------ .../reference/js-sdk/classes/Tenant.mdx | 26 - .../reference/js-sdk/classes/Transaction.mdx | 75 -- .../js-sdk/classes/TransactionOverride.mdx | 96 --- .../js-sdk/classes/UntrustedData.mdx | 38 - .../js-sdk/classes/UntrustedDataOverride.mdx | 37 - .../reference/js-sdk/classes/User.mdx | 69 -- .../js-sdk/classes/UserInputError.mdx | 16 - .../functions/base64UrlToUint8Array.mdx | 18 - .../functions/createPasskeyCredentials.mdx | 18 - .../js-sdk/functions/createPollingControl.mdx | 18 - .../js-sdk/functions/createResendControl.mdx | 27 - .../js-sdk/functions/decodePublicKey.mdx | 18 - .../functions/extractIdentifiersByStatus.mdx | 21 - .../js-sdk/functions/flattenBorders.mdx | 18 - .../js-sdk/functions/flattenColors.mdx | 21 - .../js-sdk/functions/flattenFonts.mdx | 18 - .../functions/flattenPageBackground.mdx | 31 - .../js-sdk/functions/flattenWidget.mdx | 18 - .../js-sdk/functions/getActiveIdentifiers.mdx | 18 - .../functions/getAllowedIdentifiers.mdx | 18 - .../js-sdk/functions/getBackLink.mdx | 18 - .../functions/getBrowserCapabilities.mdx | 15 - .../js-sdk/functions/getCurrentScreen.mdx | 15 - .../functions/getCurrentScreenOptions.mdx | 15 - .../functions/getEditIdentifierLink.mdx | 18 - .../reference/js-sdk/functions/getErrors.mdx | 15 - .../functions/getForgotPasswordLink.mdx | 18 - .../js-sdk/functions/getLoginIdentifiers.mdx | 18 - .../js-sdk/functions/getLoginLink.mdx | 18 - .../functions/getOptionalIdentifiers.mdx | 18 - .../functions/getPasskeyCredentials.mdx | 18 - .../js-sdk/functions/getPasswordPolicy.mdx | 18 - .../js-sdk/functions/getPublicKey.mdx | 18 - .../functions/getRequiredIdentifiers.mdx | 18 - .../js-sdk/functions/getResetPasswordLink.mdx | 18 - .../reference/js-sdk/functions/getScopes.mdx | 18 - .../functions/getShowRememberDevice.mdx | 18 - .../js-sdk/functions/getSignupIdentifiers.mdx | 24 - .../js-sdk/functions/getSignupLink.mdx | 18 - .../js-sdk/functions/getUsernamePolicy.mdx | 18 - .../js-sdk/functions/getWebAuthnType.mdx | 18 - .../functions/hasFlexibleIdentifier.mdx | 18 - .../js-sdk/functions/internalPoll.mdx | 15 - .../isAuthenticatorAssertionResponse.mdx | 18 - .../reference/js-sdk/functions/isBrave.mdx | 15 - .../functions/isForgotPasswordEnabled.mdx | 18 - .../js-sdk/functions/isJsAvailable.mdx | 15 - .../js-sdk/functions/isPasskeyEnabled.mdx | 18 - .../js-sdk/functions/isPasskeySupported.mdx | 15 - .../reference/js-sdk/functions/isRunning.mdx | 15 - .../js-sdk/functions/isSignupEnabled.mdx | 18 - .../js-sdk/functions/isUsernameRequired.mdx | 18 - .../js-sdk/functions/isWebAuthAvailable.mdx | 15 - .../functions/isWebAuthPlatformAvailable.mdx | 15 - .../js-sdk/functions/parseErrorMessage.mdx | 21 - .../functions/registerPasskeyAutofill.mdx | 31 - .../js-sdk/functions/safeBase64Url.mdx | 18 - .../js-sdk/functions/startPolling.mdx | 15 - .../js-sdk/functions/stopPolling.mdx | 15 - .../functions/uint8ArrayToBase64Url.mdx | 18 - .../functions/updatePayloadByIdentifier.mdx | 25 - .../js-sdk/functions/validatePassword.mdx | 21 - .../js-sdk/functions/validateUsername.mdx | 21 - .../interfaces/AbortEnrollmentOptions.mdx | 27 - .../interfaces/AcceptInvitationMembers.mdx | 60 -- .../js-sdk/interfaces/AllowCredential.mdx | 31 - .../js-sdk/interfaces/AuthorizationDetail.mdx | 27 - .../js-sdk/interfaces/BaseContext.mdx | 55 -- .../js-sdk/interfaces/BaseMembers.mdx | 55 -- .../reference/js-sdk/interfaces/Branding.mdx | 36 - .../js-sdk/interfaces/BrandingContext.mdx | 101 --- .../js-sdk/interfaces/BrandingMembers.mdx | 27 - .../js-sdk/interfaces/BrandingSettings.mdx | 61 -- .../js-sdk/interfaces/BrandingThemes.mdx | 44 - ...teForceProtectionUnblockFailureMembers.mdx | 47 - ...teForceProtectionUnblockFailureOptions.mdx | 23 - .../BruteForceProtectionUnblockMembers.mdx | 56 -- ...teForceProtectionUnblockSuccessMembers.mdx | 51 -- .../js-sdk/interfaces/CaptchaContext.mdx | 31 - .../js-sdk/interfaces/ClientContext.mdx | 43 - .../js-sdk/interfaces/ClientMembers.mdx | 41 - .../ConditionalMediationCapable.mdx | 23 - .../interfaces/ConfirmLogoutOptions.mdx | 28 - .../js-sdk/interfaces/Connection.mdx | 31 - .../js-sdk/interfaces/ConsentMembers.mdx | 117 --- .../js-sdk/interfaces/ContinueOptions.mdx | 30 - .../interfaces/ContinueWithCodeOptions.mdx | 34 - .../ContinueWithOrganizationNameOptions.mdx | 35 - .../interfaces/ContinueWithPasskeyOptions.mdx | 32 - .../js-sdk/interfaces/CountryCode.mdx | 27 - .../js-sdk/interfaces/CredentialResponse.mdx | 31 - .../interfaces/CurrentScreenOptions.mdx | 101 --- .../js-sdk/interfaces/CustomOptions.mdx | 23 - .../interfaces/CustomizedConsentMembers.mdx | 119 --- .../js-sdk/interfaces/DBConnection.mdx | 164 ---- .../DeviceCodeActivationAllowedMembers.mdx | 45 - .../DeviceCodeActivationDeniedMembers.mdx | 45 - .../DeviceCodeActivationMembers.mdx | 61 -- .../DeviceCodeConfirmationMembers.mdx | 67 -- .../interfaces/EmailChallengeOptions.mdx | 31 - .../EmailIdentifierChallengeMembers.mdx | 63 -- .../interfaces/EmailOTPChallengeMembers.mdx | 74 -- .../EmailVerificationResultMembers.mdx | 53 -- .../js-sdk/interfaces/EnrolledDevice.mdx | 27 - .../js-sdk/interfaces/EnrolledEmail.mdx | 27 - .../js-sdk/interfaces/EnrolledPhoneNumber.mdx | 27 - .../interfaces/EnterpriseConnection.mdx | 44 - .../EnterpriseConnectionContext.mdx | 44 - .../reference/js-sdk/interfaces/Error.mdx | 35 - .../interfaces/ExtendedScreenContext.mdx | 41 - .../ExtendedUntrustedDataContext.mdx | 46 - .../interfaces/FederatedLoginOptions.mdx | 31 - .../interfaces/FederatedSignupOptions.mdx | 27 - .../js-sdk/interfaces/FlattenedTheme.mdx | 39 - .../js-sdk/interfaces/FormOptions.mdx | 39 - .../js-sdk/interfaces/Identifier.mdx | 38 - .../interfaces/InterstitialCaptchaMembers.mdx | 50 -- .../reference/js-sdk/interfaces/Login.mdx | 233 ----- .../LoginEmailVerificationMembers.mdx | 149 ---- .../js-sdk/interfaces/LoginEnrollOptions.mdx | 31 - .../reference/js-sdk/interfaces/LoginId.mdx | 118 --- .../js-sdk/interfaces/LoginIdMembers.mdx | 68 -- .../js-sdk/interfaces/LoginMembers.mdx | 85 -- .../js-sdk/interfaces/LoginOptions.mdx | 43 - .../js-sdk/interfaces/LoginPassword.mdx | 59 -- .../interfaces/LoginPasswordMembers.mdx | 56 -- .../interfaces/LoginPasswordOptions.mdx | 35 - .../LoginPasswordlessEmailCodeMembers.mdx | 60 -- .../LoginPasswordlessSmsOtpMembers.mdx | 65 -- .../interfaces/LogoutAbortedMembers.mdx | 45 - .../interfaces/LogoutCompleteMembers.mdx | 45 - .../js-sdk/interfaces/LogoutMembers.mdx | 55 -- .../MfaBeginEnrollOptionsMembers.mdx | 55 -- .../interfaces/MfaCountryCodesMembers.mdx | 65 -- .../MfaDetectBrowserCapabilitiesMembers.mdx | 60 -- .../interfaces/MfaEmailChallengeMembers.mdx | 98 --- .../js-sdk/interfaces/MfaEmailListMembers.mdx | 65 -- .../js-sdk/interfaces/MfaEnrollOptions.mdx | 31 - .../interfaces/MfaEnrollResultMembers.mdx | 57 -- .../interfaces/MfaLoginOptionsMembers.mdx | 77 -- .../interfaces/MfaOtpChallengeMembers.mdx | 68 -- .../MfaOtpEnrollmentCodeMembers.mdx | 71 -- .../interfaces/MfaOtpEnrollmentQrMembers.mdx | 77 -- .../interfaces/MfaPhoneChallengeMembers.mdx | 122 --- .../interfaces/MfaPhoneEnrollmentMembers.mdx | 81 -- .../MfaPushChallengePushMembers.mdx | 99 --- .../interfaces/MfaPushEnrollmentQrMembers.mdx | 62 -- .../js-sdk/interfaces/MfaPushListMembers.mdx | 64 -- .../interfaces/MfaPushPollingControl.mdx | 78 -- .../interfaces/MfaPushWelcomeMembers.mdx | 55 -- .../interfaces/MfaPushWelcomeOptions.mdx | 23 - .../MfaRecoveryCodeChallengeMembers.mdx | 73 -- ...MfaRecoveryCodeChallengeNewCodeMembers.mdx | 84 -- ...aRecoveryCodeEnrollmentContinueOptions.mdx | 26 - .../MfaRecoveryCodeEnrollmentMembers.mdx | 63 -- .../interfaces/MfaSmsChallengeMembers.mdx | 77 -- .../interfaces/MfaSmsChallengeOptions.mdx | 27 - .../interfaces/MfaSmsEnrollmentMembers.mdx | 59 -- .../interfaces/MfaSmsEnrollmentOptions.mdx | 31 - .../js-sdk/interfaces/MfaSmsListMembers.mdx | 67 -- .../js-sdk/interfaces/MfaSmsListOptions.mdx | 33 - .../MfaVoiceChallengeContinueOptions.mdx | 45 - .../interfaces/MfaVoiceChallengeMembers.mdx | 156 ---- .../interfaces/MfaVoiceEnrollmentMembers.mdx | 84 -- .../MfaWebAuthnChangeKeyNicknameMembers.mdx | 100 --- .../MfaWebAuthnEnrollmentSuccessMembers.mdx | 81 -- .../interfaces/MfaWebAuthnErrorMembers.mdx | 127 --- .../MfaWebAuthnNotAvailableErrorMembers.mdx | 71 -- .../MfaWebAuthnPlatformChallengeMembers.mdx | 149 ---- .../MfaWebAuthnPlatformEnrollmentMembers.mdx | 148 ---- .../MfaWebAuthnRoamingChallengeMembers.mdx | 142 --- .../MfaWebAuthnRoamingEnrollmentMembers.mdx | 119 --- .../js-sdk/interfaces/OrganizationContext.mdx | 65 -- .../js-sdk/interfaces/OrganizationMembers.mdx | 45 - .../interfaces/OrganizationPickerMembers.mdx | 65 -- .../OrganizationSelectionMembers.mdx | 60 -- .../js-sdk/interfaces/Organizations.mdx | 35 - .../js-sdk/interfaces/OtpCodeOptions.mdx | 30 - .../reference/js-sdk/interfaces/Passkey.mdx | 23 - .../js-sdk/interfaces/PasskeyCreate.mdx | 85 -- .../interfaces/PasskeyCreateResponse.mdx | 39 - .../interfaces/PasskeyCredentialResponse.mdx | 58 -- .../js-sdk/interfaces/PasskeyEnroll.mdx | 85 -- .../js-sdk/interfaces/PasskeyEnrollment.mdx | 61 -- .../interfaces/PasskeyEnrollmentLocal.mdx | 157 ---- .../PasskeyEnrollmentLocalMembers.mdx | 55 -- .../interfaces/PasskeyEnrollmentMembers.mdx | 55 -- .../js-sdk/interfaces/PasskeyLogin.mdx | 32 - .../js-sdk/interfaces/PasskeyRead.mdx | 32 - .../interfaces/PasswordComplexityRule.mdx | 55 -- .../js-sdk/interfaces/PasswordPolicy.mdx | 35 - .../interfaces/PasswordValidationResult.mdx | 42 - .../interfaces/PasswordlessConnection.mdx | 38 - .../interfaces/PhoneChallengeOptions.mdx | 31 - .../interfaces/PhoneEnrollmentOptions.mdx | 27 - .../PhoneIdentifierChallengeMembers.mdx | 71 -- .../PhoneIdentifierEnrollmentMembers.mdx | 55 -- .../js-sdk/interfaces/PhonePrefix.mdx | 37 - .../interfaces/PickAuthenticatorOptions.mdx | 21 - .../js-sdk/interfaces/PickPhoneOptions.mdx | 21 - .../js-sdk/interfaces/PostPayloadOptions.mdx | 27 - .../js-sdk/interfaces/PromptContext.mdx | 23 - .../js-sdk/interfaces/PromptMembers.mdx | 23 - .../js-sdk/interfaces/RedeemTicketMembers.mdx | 70 -- .../interfaces/ReportBrowserErrorOptions.mdx | 30 - .../interfaces/ReportWebAuthnErrorOptions.mdx | 23 - .../js-sdk/interfaces/ResendCodeOptions.mdx | 25 - .../js-sdk/interfaces/ResendControl.mdx | 23 - .../interfaces/ResetPasswordEmailMembers.mdx | 51 -- .../interfaces/ResetPasswordEmailOptions.mdx | 23 - .../interfaces/ResetPasswordErrorMembers.mdx | 47 - .../interfaces/ResetPasswordErrorOptions.mdx | 23 - .../interfaces/ResetPasswordMembers.mdx | 56 -- .../ResetPasswordMfaEmailChallengeMembers.mdx | 87 -- .../ResetPasswordMfaOtpChallengeMembers.mdx | 64 -- .../ResetPasswordMfaPhoneChallengeMembers.mdx | 133 --- ...setPasswordMfaPushChallengePushMembers.mdx | 97 --- ...asswordMfaRecoveryCodeChallengeMembers.mdx | 74 -- .../ResetPasswordMfaSmsChallengeMembers.mdx | 72 -- .../ResetPasswordMfaVoiceChallengeMembers.mdx | 111 --- ...ordMfaWebAuthnPlatformChallengeMembers.mdx | 146 ---- ...wordMfaWebAuthnRoamingChallengeMembers.mdx | 111 --- .../interfaces/ResetPasswordOptions.mdx | 31 - .../ResetPasswordRequestMembers.mdx | 60 -- .../ResetPasswordRequestOptions.mdx | 31 - .../ResetPasswordSuccessMembers.mdx | 47 - .../ResetPasswordSuccessOptions.mdx | 23 - .../reference/js-sdk/interfaces/Scope.mdx | 27 - .../js-sdk/interfaces/ScreenContext.mdx | 39 - .../interfaces/ScreenContextOnLogin.mdx | 44 - .../ScreenContextOnLoginPassword.mdx | 47 - ...ScreenContextOnLoginPasswordlessSmsOtp.mdx | 47 - .../ScreenContextOnSignupPassword.mdx | 58 -- .../js-sdk/interfaces/ScreenData.mdx | 23 - ...setPasswordMfaWebAuthnRoamingChallenge.mdx | 39 - .../js-sdk/interfaces/ScreenDataOptions.mdx | 26 - .../js-sdk/interfaces/ScreenMembers.mdx | 55 -- .../ScreenMembersOnAcceptInvitation.mdx | 56 -- ...rsOnBruteForceProtectionUnblockFailure.mdx | 53 -- ...rsOnBruteForceProtectionUnblockSuccess.mdx | 45 - .../interfaces/ScreenMembersOnConsent.mdx | 54 -- .../ScreenMembersOnCustomizedConsent.mdx | 69 -- .../ScreenMembersOnDeviceCodeConfirmation.mdx | 53 -- ...creenMembersOnEmailIdentifierChallenge.mdx | 59 -- .../ScreenMembersOnEmailOTPChallenge.mdx | 47 - ...ScreenMembersOnEmailVerificationResult.mdx | 70 -- .../interfaces/ScreenMembersOnLogin.mdx | 61 -- .../interfaces/ScreenMembersOnLoginId.mdx | 58 -- .../ScreenMembersOnLoginPassword.mdx | 65 -- ...eenMembersOnLoginPasswordlessEmailCode.mdx | 68 -- ...ScreenMembersOnLoginPasswordlessSmsOtp.mdx | 68 -- .../ScreenMembersOnMfaCountryCodes.mdx | 52 -- .../ScreenMembersOnMfaEmailChallenge.mdx | 56 -- .../ScreenMembersOnMfaEmailList.mdx | 52 -- .../ScreenMembersOnMfaEnrollResult.mdx | 61 -- .../ScreenMembersOnMfaLoginOptions.mdx | 52 -- .../ScreenMembersOnMfaOtpChallenge.mdx | 53 -- .../ScreenMembersOnMfaOtpEnrollmentCode.mdx | 54 -- .../ScreenMembersOnMfaOtpEnrollmentQr.mdx | 53 -- .../ScreenMembersOnMfaPhoneChallenge.mdx | 56 -- .../ScreenMembersOnMfaPushChallengePush.mdx | 54 -- .../ScreenMembersOnMfaPushEnrollmentQr.mdx | 59 -- .../ScreenMembersOnMfaPushWelcome.mdx | 68 -- ...mbersOnMfaRecoveryCodeChallengeNewCode.mdx | 59 -- ...reenMembersOnMfaRecoveryCodeEnrollment.mdx | 54 -- .../ScreenMembersOnMfaSmsChallenge.mdx | 62 -- .../ScreenMembersOnMfaSmsEnrollment.mdx | 53 -- .../ScreenMembersOnMfaVoiceChallenge.mdx | 67 -- ...nMembersOnMfaWebAuthnChangeKeyNickname.mdx | 62 -- ...nMembersOnMfaWebAuthnEnrollmentSuccess.mdx | 69 -- .../ScreenMembersOnMfaWebAuthnError.mdx | 65 -- ...nMembersOnMfaWebAuthnPlatformChallenge.mdx | 67 -- ...MembersOnMfaWebAuthnPlatformEnrollment.mdx | 56 -- ...enMembersOnMfaWebAuthnRoamingChallenge.mdx | 58 -- ...nMembersOnMfaWebAuthnRoamingEnrollment.mdx | 54 -- .../ScreenMembersOnOrganizationSelection.mdx | 70 -- .../ScreenMembersOnPasskeyEnrollment.mdx | 58 -- .../ScreenMembersOnPasskeyEnrollmentLocal.mdx | 50 -- ...creenMembersOnPhoneIdentifierChallenge.mdx | 65 -- ...reenMembersOnPhoneIdentifierEnrollment.mdx | 60 -- .../ScreenMembersOnResetPassword.mdx | 53 -- .../ScreenMembersOnResetPasswordEmail.mdx | 53 -- .../ScreenMembersOnResetPasswordError.mdx | 53 -- ...embersOnResetPasswordMfaEmailChallenge.mdx | 53 -- ...embersOnResetPasswordMfaPhoneChallenge.mdx | 56 -- ...ersOnResetPasswordMfaPushChallengePush.mdx | 57 -- ...nMembersOnResetPasswordMfaSmsChallenge.mdx | 57 -- ...embersOnResetPasswordMfaVoiceChallenge.mdx | 59 -- ...etPasswordMfaWebAuthnPlatformChallenge.mdx | 68 -- ...setPasswordMfaWebAuthnRoamingChallenge.mdx | 72 -- .../ScreenMembersOnResetPasswordRequest.mdx | 59 -- .../ScreenMembersOnResetPasswordSuccess.mdx | 45 - .../interfaces/ScreenMembersOnSignup.mdx | 50 -- .../interfaces/ScreenMembersOnSignupId.mdx | 50 -- .../ScreenMembersOnSignupPassword.mdx | 67 -- .../interfaces/SelectCountryCodeOptions.mdx | 37 - .../interfaces/SelectMfaEmailOptions.mdx | 34 - .../interfaces/SelectMfaPushDeviceOptions.mdx | 32 - .../interfaces/SelectOrganizationOptions.mdx | 27 - .../js-sdk/interfaces/ShowErrorOptions.mdx | 42 - .../reference/js-sdk/interfaces/SignupId.mdx | 283 ------ .../js-sdk/interfaces/SignupIdMembers.mdx | 68 -- .../js-sdk/interfaces/SignupMembers.mdx | 94 -- .../js-sdk/interfaces/SignupOptions.mdx | 43 - .../js-sdk/interfaces/SignupPassword.mdx | 238 ------ .../interfaces/SignupPasswordMembers.mdx | 60 -- .../interfaces/SignupPasswordOptions.mdx | 43 - .../js-sdk/interfaces/SocialConnection.mdx | 27 - .../js-sdk/interfaces/StartResendOptions.mdx | 31 - .../interfaces/SubmitCaptchaOptions.mdx | 27 - .../js-sdk/interfaces/SubmitCodeOptions.mdx | 31 - .../js-sdk/interfaces/SubmitOTPOptions.mdx | 35 - .../SubmitPasskeyCredentialOptions.mdx | 23 - .../js-sdk/interfaces/TenantContext.mdx | 35 - .../js-sdk/interfaces/TenantMembers.mdx | 35 - .../js-sdk/interfaces/TransactionContext.mdx | 43 - .../interfaces/TransactionContextOnLogin.mdx | 38 - .../TransactionContextOnLoginPassword.mdx | 38 - .../js-sdk/interfaces/TransactionMembers.mdx | 55 -- .../interfaces/TransactionMembersOnLogin.mdx | 66 -- .../TransactionMembersOnLoginId.mdx | 70 -- .../TransactionMembersOnLoginPassword.mdx | 70 -- ...ionMembersOnLoginPasswordlessEmailCode.mdx | 50 -- ...actionMembersOnLoginPasswordlessSmsOtp.mdx | 50 -- .../TransactionMembersOnResetPassword.mdx | 50 -- ...ansactionMembersOnResetPasswordRequest.mdx | 58 -- .../interfaces/TransactionMembersOnSignup.mdx | 66 -- .../TransactionMembersOnSignupId.mdx | 62 -- .../TransactionMembersOnSignupPassword.mdx | 62 -- .../interfaces/TryAnotherMethodOptions.mdx | 33 - .../interfaces/UntrustedDataContext.mdx | 45 - .../interfaces/UntrustedDataMembers.mdx | 42 - ...ntrustedDataMembersOnMfaEmailChallenge.mdx | 40 - .../UntrustedDataMembersOnMfaOtpChallenge.mdx | 40 - ...ustedDataMembersOnMfaPushChallengePush.mdx | 41 - .../UntrustedDataMembersOnMfaSmsChallenge.mdx | 40 - ...ntrustedDataMembersOnMfaVoiceChallenge.mdx | 40 - .../interfaces/UseSecurityKeyOptions.mdx | 34 - .../js-sdk/interfaces/UserContext.mdx | 67 -- .../js-sdk/interfaces/UserMembers.mdx | 71 -- .../js-sdk/interfaces/UsernamePolicy.mdx | 44 - .../interfaces/UsernameValidationError.mdx | 49 -- .../interfaces/UsernameValidationResult.mdx | 39 - .../VerifyPlatformAuthenticatorOptions.mdx | 32 - .../interfaces/VerifySecurityKeyOptions.mdx | 26 - .../interfaces/WebAuthnErrorDetails.mdx | 43 - .../js-sdk/interfaces/WithRememberOptions.mdx | 26 - .../reference/js-sdk/navigation.json | 581 ------------- .../js-sdk/types/AuthenticatorTransport.mdx | 14 - .../js-sdk/types/Base64URLString.mdx | 14 - .../reference/js-sdk/types/IdentifierType.mdx | 14 - .../js-sdk/types/MfaPollingOptions.mdx | 45 - .../js-sdk/types/OnStatusChangeCallback.mdx | 14 - .../reference/js-sdk/types/WebAuthnType.mdx | 14 - 810 files changed, 60257 insertions(+), 34095 deletions(-) delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/README.md create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AcceptInvitation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Consent.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/CustomizedConsent.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationAllowed.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationDenied.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeConfirmation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailIdentifierChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailOTPChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailVerificationResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/InterstitialCaptcha.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Login.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginEmailVerification.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessSmsOtp.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Logout.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutAborted.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutComplete.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaBeginEnrollOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaCountryCodes.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaDetectBrowserCapabilities.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailList.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEnrollResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaLoginOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentQr.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushChallengePush.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushEnrollmentQr.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushList.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushWelcome.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsList.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationPicker.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationSelection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollmentLocal.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/RedeemTicket.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordEmail.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordRequest.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordSuccess.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Signup.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreen.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreenOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentThemeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getErrors.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/index.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CurrentScreenOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FlattenedTheme.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Organizations.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreateResponse.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectOrganizationOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/AuthenticatorTransport.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaEnrollFactorType.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaLoginFactorType.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/OnStatusChangeCallback.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType.mdx create mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AcceptInvitation.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AculError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Auth0ServerError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BaseContext.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblock.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockFailure.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockSuccess.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Client.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Consent.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/CustomizedConsent.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivation.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationAllowed.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationDenied.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeConfirmation.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailIdentifierChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailOTPChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailVerificationResult.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/FormHandler.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/InterstitialCaptcha.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Login.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginEmailVerification.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginId.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessEmailCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessSmsOtp.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Logout.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutAborted.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutComplete.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaBeginEnrollOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaCountryCodes.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaDetectBrowserCapabilities.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailList.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEnrollResult.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaLoginOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentQr.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushChallengePush.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushEnrollmentQr.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushList.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushWelcome.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallengeNewCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsList.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnChangeKeyNickname.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnEnrollmentSuccess.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnNotAvailableError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Organization.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationPicker.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationSelection.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollmentLocal.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Prompt.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/RedeemTicket.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordEmail.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaEmailChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaOtpChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPhoneChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPushChallengePush.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaSmsChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaVoiceChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordRequest.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordSuccess.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SDKUsageError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Screen.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Signup.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupId.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Tenant.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Transaction.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedData.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/User.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UserInputError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/base64UrlToUint8Array.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPasskeyCredentials.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPollingControl.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createResendControl.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/decodePublicKey.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/extractIdentifiersByStatus.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenBorders.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenColors.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenFonts.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenPageBackground.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenWidget.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getActiveIdentifiers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getAllowedIdentifiers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBackLink.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBrowserCapabilities.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreen.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreenOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getEditIdentifierLink.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getErrors.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getForgotPasswordLink.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginIdentifiers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginLink.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getOptionalIdentifiers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasskeyCredentials.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasswordPolicy.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPublicKey.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getRequiredIdentifiers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getResetPasswordLink.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getScopes.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getShowRememberDevice.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupIdentifiers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupLink.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getUsernamePolicy.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getWebAuthnType.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/hasFlexibleIdentifier.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/internalPoll.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isAuthenticatorAssertionResponse.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isBrave.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isForgotPasswordEnabled.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isJsAvailable.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeyEnabled.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeySupported.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isRunning.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isSignupEnabled.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isUsernameRequired.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthAvailable.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthPlatformAvailable.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/parseErrorMessage.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/registerPasskeyAutofill.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/safeBase64Url.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/startPolling.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/stopPolling.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/uint8ArrayToBase64Url.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/updatePayloadByIdentifier.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validatePassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validateUsername.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AbortEnrollmentOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AcceptInvitationMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AllowCredential.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseContext.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Branding.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingThemes.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockSuccessMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConditionalMediationCapable.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConfirmLogoutOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConsentMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithCodeOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithOrganizationNameOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithPasskeyOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CredentialResponse.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CurrentScreenOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomizedConsentMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationAllowedMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationDeniedMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeConfirmationMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailChallengeOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailIdentifierChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailOTPChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailVerificationResultMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FlattenedTheme.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FormOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/InterstitialCaptchaMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Login.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEmailVerificationMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEnrollOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginId.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginIdMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessEmailCodeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessSmsOtpMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutAbortedMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutCompleteMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaBeginEnrollOptionsMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaCountryCodesMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailListMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollResultMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaLoginOptionsMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentCodeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentQrMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneEnrollmentMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushChallengePushMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushEnrollmentQrMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushListMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeContinueOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceEnrollmentMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnErrorMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationPickerMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationSelectionMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Organizations.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OtpCodeOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Passkey.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreateResponse.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCredentialResponse.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnroll.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocal.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocalMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyLogin.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordlessConnection.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneChallengeOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneEnrollmentOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierEnrollmentMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickAuthenticatorOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickPhoneOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PostPayloadOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/RedeemTicketMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportWebAuthnErrorOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLogin.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPasswordlessSmsOtp.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnSignupPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnAcceptInvitation.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockFailure.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockSuccess.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnConsent.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnCustomizedConsent.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailOTPChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailVerificationResult.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLogin.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginId.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaCountryCodes.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailList.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEnrollResult.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaLoginOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushChallengePush.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushWelcome.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnOrganizationSelection.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordEmail.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordRequest.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordSuccess.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignup.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupId.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectCountryCodeOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaEmailOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaPushDeviceOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectOrganizationOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupId.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupIdMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SocialConnection.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCaptchaOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCodeOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitOTPOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitPasskeyCredentialOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLogin.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLoginPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLogin.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPasswordRequest.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignup.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupPassword.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UseSecurityKeyOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationError.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifyPlatformAuthenticatorOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifySecurityKeyOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WithRememberOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/navigation.json delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/AuthenticatorTransport.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/Base64URLString.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/IdentifierType.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/MfaPollingOptions.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/OnStatusChangeCallback.mdx delete mode 100644 main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/WebAuthnType.mdx diff --git a/main/docs.json b/main/docs.json index 55e8e950e..342bcc931 100644 --- a/main/docs.json +++ b/main/docs.json @@ -1236,464 +1236,375 @@ { "group": "Classes", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BaseContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Client", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Organization", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Prompt", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Screen", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Tenant", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Transaction", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedData", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/User", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AcceptInvitation", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblock", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockFailure", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockSuccess", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Consent", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/CustomizedConsent", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivation", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationAllowed", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationDenied", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeConfirmation", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailOTPChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailVerificationResult", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/InterstitialCaptcha", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Login", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginEmailVerification", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessEmailCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessSmsOtp", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Logout", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutAborted", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutComplete", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaBeginEnrollOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaCountryCodes", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaDetectBrowserCapabilities", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailList", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEnrollResult", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaLoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushList", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushWelcome", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallengeNewCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsList", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnChangeKeyNickname", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnEnrollmentSuccess", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnNotAvailableError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationPicker", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationSelection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollmentLocal", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/RedeemTicket", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordEmail", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaRecoveryCodeChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordRequest", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordSuccess", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Signup", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AculError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UserInputError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SDKUsageError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Auth0ServerError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/FormHandler" + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AcceptInvitation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Consent", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/CustomizedConsent", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationAllowed", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationDenied", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeConfirmation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailOTPChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailVerificationResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/InterstitialCaptcha", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Login", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginEmailVerification", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Logout", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutAborted", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutComplete", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaBeginEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaCountryCodes", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaDetectBrowserCapabilities", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailList", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEnrollResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushList", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushWelcome", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsList", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationPicker", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationSelection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollmentLocal", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/RedeemTicket", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordEmail", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Signup", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError" ] }, { "group": "Interfaces", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CurrentScreenOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FlattenedTheme", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingThemes", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Branding", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AllowCredential", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Passkey", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyLogin", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnroll", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordlessConnection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SocialConnection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Organizations", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnAcceptInvitation", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AcceptInvitationMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockFailure", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockSuccessMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockSuccess", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnConsent", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConsentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnCustomizedConsent", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomizedConsentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationAllowedMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationDeniedMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnDeviceCodeConfirmation", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeConfirmationMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailIdentifierChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailOTPChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OtpCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailOTPChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailVerificationResult", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailVerificationResultMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCaptchaOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/InterstitialCaptchaMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEmailVerificationMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginIdMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessEmailCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessEmailCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessEmailCodeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPasswordlessSmsOtp", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitOTPOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessSmsOtpMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLogin", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLogin", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLogin", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLogin", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Login", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutAbortedMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutCompleteMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConfirmLogoutOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaBeginEnrollOptionsMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaCountryCodes", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectCountryCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaCountryCodesMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaDetectBrowserCapabilitiesMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailList", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaEmailOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailListMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEnrollResult", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollResultMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaLoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEnrollOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaLoginOptionsMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentCodeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentQrMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickPhoneOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickAuthenticatorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WithRememberOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushChallengePushMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushEnrollmentQrMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaPushDeviceOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushListMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushWelcome", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeNewCodeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnChangeKeyNicknameMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnEnrollmentSuccessMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnErrorMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnNotAvailableErrorMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifyPlatformAuthenticatorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitPasskeyCredentialOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifySecurityKeyOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportWebAuthnErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectOrganizationOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationPickerMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithOrganizationNameOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnOrganizationSelection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationSelectionMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocal", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AbortEnrollmentOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollmentLocal", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocalMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneEnrollmentOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/RedeemTicketMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordEmail", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaEmailChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaOtpChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPhoneChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPushChallengePushMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaSmsChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaVoiceChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithPasskeyOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UseSecurityKeyOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPasswordRequest", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordRequest", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordSuccess", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupIdMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnSignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignup", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignup", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FormOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PostPayloadOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCredentialResponse", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CredentialResponse", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreateResponse", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConditionalMediationCapable", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult" + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CurrentScreenOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FlattenedTheme", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Organizations", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreateResponse", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectOrganizationOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions" ] }, { "group": "Types", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/Base64URLString", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/AuthenticatorTransport", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/WebAuthnType", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/MfaPollingOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/OnStatusChangeCallback", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/IdentifierType" - ] - }, - { - "group": "Functions", - "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreen", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreenOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getErrors", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/updatePayloadByIdentifier", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupLink", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBackLink", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginLink", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getResetPasswordLink", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getForgotPasswordLink", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getEditIdentifierLink", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPublicKey", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getShowRememberDevice", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getWebAuthnType", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getScopes", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isSignupEnabled", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isForgotPasswordEnabled", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeyEnabled", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isUsernameRequired", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getUsernamePolicy", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasswordPolicy", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getActiveIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getAllowedIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getRequiredIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getOptionalIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/hasFlexibleIdentifier", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/extractIdentifiersByStatus", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenColors", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenFonts", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenBorders", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenPageBackground", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenWidget", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isBrave", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthAvailable", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isJsAvailable", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthPlatformAvailable", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeySupported", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBrowserCapabilities", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/base64UrlToUint8Array", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/uint8ArrayToBase64Url", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/safeBase64Url", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/decodePublicKey", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isAuthenticatorAssertionResponse", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasskeyCredentials", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPasskeyCredentials", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/registerPasskeyAutofill", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPollingControl", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/internalPoll", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/startPolling", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/stopPolling", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isRunning", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/parseErrorMessage", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createResendControl", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validatePassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validateUsername" + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/AuthenticatorTransport", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaEnrollFactorType", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaLoginFactorType", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/OnStatusChangeCallback", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType" ] } ] diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/README.md b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/README.md deleted file mode 100644 index 6a71459ab..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/README.md +++ /dev/null @@ -1,46 +0,0 @@ -# Auth0 ACUL JS Documentation - -Generated on 11/11/2025, 10:36:08 AM - -## Classes (162) - -- [BaseContext](./classes/BaseContext.mdx) -- [Branding](./classes/Branding.mdx) -- [Client](./classes/Client.mdx) -- [Organization](./classes/Organization.mdx) -- [Prompt](./classes/Prompt.mdx) -- [Screen](./classes/Screen.mdx) -- [Tenant](./classes/Tenant.mdx) -- [Transaction](./classes/Transaction.mdx) -- [UntrustedData](./classes/UntrustedData.mdx) -- [User](./classes/User.mdx) -- ... and 152 more - -## Interfaces (332) - -- [CustomOptions](./interfaces/CustomOptions.mdx) -- [WebAuthnErrorDetails](./interfaces/WebAuthnErrorDetails.mdx) -- [CurrentScreenOptions](./interfaces/CurrentScreenOptions.mdx) -- [FlattenedTheme](./interfaces/FlattenedTheme.mdx) -- [BaseContext](./interfaces/BaseContext.mdx) -- [BaseMembers](./interfaces/BaseMembers.mdx) -- [BrandingContext](./interfaces/BrandingContext.mdx) -- [BrandingSettings](./interfaces/BrandingSettings.mdx) -- [BrandingThemes](./interfaces/BrandingThemes.mdx) -- [BrandingMembers](./interfaces/BrandingMembers.mdx) -- ... and 322 more - -## Functions (56) - -- [getCurrentScreen](./functions/getCurrentScreen.mdx) -- [getCurrentScreenOptions](./functions/getCurrentScreenOptions.mdx) -- [getErrors](./functions/getErrors.mdx) -- [updatePayloadByIdentifier](./functions/updatePayloadByIdentifier.mdx) -- [getSignupLink](./functions/getSignupLink.mdx) -- [getBackLink](./functions/getBackLink.mdx) -- [getLoginLink](./functions/getLoginLink.mdx) -- [getResetPasswordLink](./functions/getResetPasswordLink.mdx) -- [getForgotPasswordLink](./functions/getForgotPasswordLink.mdx) -- [getEditIdentifierLink](./functions/getEditIdentifierLink.mdx) -- ... and 46 more - diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AcceptInvitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AcceptInvitation.mdx new file mode 100644 index 000000000..abbc843ef --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AcceptInvitation.mdx @@ -0,0 +1,273 @@ +--- +title: "AcceptInvitation" +--- + +Defined in: [src/screens/accept-invitation/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L16) + +Class implementing the accept-invitation screen functionality. +This screen is displayed when a user needs to accept an invitation to an organization. + + +<RequestExample> +```ts +export default class AcceptInvitation extends BaseContext implements AcceptInvitationMembers { + static screenIdentifier: string = ScreenIds.ACCEPT_INVITATION; + screen: ScreenOptions; + + /** + * Creates an instance of AcceptInvitation screen manager. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Accepts the invitation to the organization. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation'; + * + * const acceptInvitation = new AcceptInvitation(); + * await acceptInvitation.acceptInvitation(); + * ``` + */ + async acceptInvitation(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [AcceptInvitation.screenIdentifier, 'acceptInvitation'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.DEFAULT }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers) + +## Constructors + +<ParamField body="AcceptInvitation" type="Constructor"> +{/*> **new AcceptInvitation**(): `AcceptInvitation`*/} + +Defined in: [src/screens/accept-invitation/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L23) + +Creates an instance of AcceptInvitation screen manager. + +#### Returns + +`AcceptInvitation` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation">ScreenMembersOnAcceptInvitation</a></span>}> +{/*> **screen**: [`ScreenMembersOnAcceptInvitation`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation)*/} + +Defined in: [src/screens/accept-invitation/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L18) + +#### Implementation of + +[`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.ACCEPT_INVITATION`*/} + +Defined in: [src/screens/accept-invitation/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L17) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='acceptInvitation' type='Promise<void>'> +{/*> **acceptInvitation**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/accept-invitation/index.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L40) + +Accepts the invitation to the organization. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation'; + +const acceptInvitation = new AcceptInvitation(); +await acceptInvitation.acceptInvitation(); +``` + +#### Implementation of + +[`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers).[`acceptInvitation`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.md#acceptinvitation) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.mdx new file mode 100644 index 000000000..edaca5c80 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.mdx @@ -0,0 +1,84 @@ +--- +title: "AculError" +--- + +Defined in: [src/utils/errors.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L10) + +AculError + + +<RequestExample> +```ts +export class AculError extends Error { + public readonly code: string; + public readonly field?: string; + + constructor(message: string, field?: string) { + super(message); + this.name = new.target.name; + this.code = 'ACUL_ERROR'; + this.field = field; + Object.setPrototypeOf(this, new.target.prototype); + } +} +``` +</RequestExample> + +## Param + +The error message. + +## Param + +The optional field associated with the error. + +## Throws + +Throws an error if the message is empty. + +## Extends + +- `Error` + +## Extended by + +- [`UserInputError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError) +- [`SDKUsageError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError) +- [`Auth0ServerError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError) + +## Constructors + +<ParamField body="AculError" type="Constructor"> +{/*> **new AculError**(`message`, `field?`): `AculError`*/} + +Defined in: [src/utils/errors.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L14) + +<Expandable title="Parameters"> +<ParamField body='message' type='string'> +</ParamField> +<ParamField body='field?' type='string'> +</ParamField> +</Expandable> +#### Returns + +`AculError` + +#### Overrides + +`Error.constructor` + +</ParamField> +## Properties + +<ParamField body='code' type='string'> +{/*> `readonly` **code**: `string`*/} + +Defined in: [src/utils/errors.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L11) + +</ParamField> + +<ParamField body='field?' type='string'> +{/*> `readonly` `optional` **field**: `string`*/} + +Defined in: [src/utils/errors.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L12) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError.mdx new file mode 100644 index 000000000..217815fd9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError.mdx @@ -0,0 +1,78 @@ +--- +title: "Auth0ServerError" +--- + +Defined in: [src/utils/errors.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L63) + +Auth0ServerError + + +<RequestExample> +```ts +export class Auth0ServerError extends AculError { + public readonly code = 'AUTH0_SERVER_ERROR'; + + constructor(message: string, field?: string) { + super(message, field); + Object.setPrototypeOf(this, new.target.prototype); + } +} +``` +</RequestExample> + +## Param + +The error message. + +## Param + +The optional field associated with the error. + +## Extends + +- [`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError) + +## Constructors + +<ParamField body="Auth0ServerError" type="Constructor"> +{/*> **new Auth0ServerError**(`message`, `field?`): `Auth0ServerError`*/} + +Defined in: [src/utils/errors.ts:66](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L66) + +<Expandable title="Parameters"> +<ParamField body='message' type='string'> +</ParamField> +<ParamField body='field?' type='string'> +</ParamField> +</Expandable> +#### Returns + +`Auth0ServerError` + +#### Overrides + +[`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError).[`constructor`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.md#constructor) + +</ParamField> +## Properties + +<ParamField body='code' type='"AUTH0_SERVER_ERROR"'> +{/*> `readonly` **code**: `"AUTH0_SERVER_ERROR"` = `'AUTH0_SERVER_ERROR'`*/} + +Defined in: [src/utils/errors.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L64) + +#### Overrides + +[`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError).[`code`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.md#code) + +</ParamField> + +<ParamField body='field?' type='string'> +{/*> `readonly` `optional` **field**: `string`*/} + +Defined in: [src/utils/errors.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L12) + +#### Inherited from + +[`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError).[`field`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.md#field) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Consent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Consent.mdx new file mode 100644 index 000000000..305b32b5b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Consent.mdx @@ -0,0 +1,433 @@ +--- +title: "Consent" +--- + +Defined in: [src/screens/consent/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/consent/index.ts#L13) + +ConsentMembers + + +<RequestExample> +```ts +export default class Consent extends BaseContext implements ConsentMembers { + static screenIdentifier: string = ScreenIds.CONSENT; + + /** + * Holds the specific screen data and properties for the Consent screen, + * processed by `ScreenOverride`. This includes the list of `scopes` being requested + * and the `hideScopes` flag. + * @type {ScreenMembersOnConsent} + * @public + */ + public screen: ScreenMembersOnConsent; + + /** + * Creates an instance of the `Consent` screen manager. + * The constructor initializes the `BaseContext` and sets up the `screen` property + * with an instance of `ScreenOverride` tailored for the consent screen. + * @throws {Error} If the Universal Login Context is not available or if the + * current screen name in the context does not match `Consent.screenIdentifier`. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Submits the user's decision to accept (grant) the requested permissions. + * This method prepares and posts form data to the `/u/consent?state=<transaction_state>` endpoint + * with `action: "accept"`. The transaction state is automatically included in both the + * URL query parameter and the form body. + * + * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs + * to be sent with the request. These parameters will be + * included in the form data submitted to the server. + * @returns {Promise<void>} A promise that resolves once the form submission is initiated. + * Typically, a successful submission leads to a server-side redirect. + * @throws {Error} Throws an error if `FormHandler` encounters an unrecoverable issue + * during submission (e.g., network error). Server-side validation errors + * from Auth0 (like "invalid_request") are not thrown as JavaScript errors + * but are made available in `this.transaction.errors` after the operation. + * @example + * ```typescript + * import Consent from '@auth0/auth0-acul-js/consent'; + * const consentManager = new Consent(); + * const handleAccept = async () => { + * try { + * await consentManager.accept(); + * console.log('Consent accepted successfully.'); + * } catch (err) { + * console.error('Error accepting consent:', err); + * } + * }; + * ``` + */ + async accept(payload?: CustomOptions): Promise<void> { + const formOptions: SDKFormOptions = { + state: this.transaction.state, // For form body + telemetry: [Consent.screenIdentifier, 'accept'] + }; + + const submitPayload = { + ...payload, + action: FormActions.ACCEPT, + }; + + await new FormHandler(formOptions).submitData<typeof submitPayload>(submitPayload); + } + + /** + * Submits the user's decision to deny (reject) the requested permissions. + * This method prepares and posts form data to the `/u/consent?state=<transaction_state>` endpoint + * with `action: "deny"`. The transaction state is automatically included in both the + * URL query parameter and the form body. + * + * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs + * to be sent with the request. These parameters will be + * included in the form data submitted to the server. + * @returns {Promise<void>} A promise that resolves once the form submission is initiated. + * A successful submission usually results in a server-side redirect. + * @throws {Error} Throws an error if `FormHandler` encounters an issue (e.g., network error). + * Server-side validation errors are reflected in `this.transaction.errors`. + * @example + * ```typescript + * import Consent from '@auth0/auth0-acul-js/consent'; + * const consentManager = new Consent(); + * const handleDeny = async () => { + * try { + * await consentManager.deny(); + * console.log('Form denied successfully.'); + * } catch (err) { + * console.error('Failed to deny form:', error); + * } + * }; + */ + async deny(payload?: CustomOptions): Promise<void> { + const formOptions: SDKFormOptions = { + state: this.transaction.state, // For form body + telemetry: [Consent.screenIdentifier, 'deny'] + }; + + const submitPayload = { + ...payload, + action: FormActions.DENY, + }; + + await new FormHandler(formOptions).submitData<typeof submitPayload>(submitPayload); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers) + +## Constructors + +<ParamField body="Consent" type="Constructor"> +{/*> **new Consent**(): `Consent`*/} + +Defined in: [src/screens/consent/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/consent/index.ts#L32) + +Creates an instance of the `Consent` screen manager. +The constructor initializes the `BaseContext` and sets up the `screen` property +with an instance of `ScreenOverride` tailored for the consent screen. + +#### Returns + +`Consent` + +#### Throws + +If the Universal Login Context is not available or if the +current screen name in the context does not match `Consent.screenIdentifier`. + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent">ScreenMembersOnConsent</a></span>}> +{/*> **screen**: [`ScreenMembersOnConsent`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent)*/} + +Defined in: [src/screens/consent/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/consent/index.ts#L23) + +Holds the specific screen data and properties for the Consent screen, +processed by `ScreenOverride`. This includes the list of `scopes` being requested +and the `hideScopes` flag. + +#### Implementation of + +[`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.CONSENT`*/} + +Defined in: [src/screens/consent/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/consent/index.ts#L14) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='accept' type='Promise<void>'> +{/*> **accept**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/consent/index.ts:67](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/consent/index.ts#L67) + +Submits the user's decision to accept (grant) the requested permissions. +This method prepares and posts form data to the `/u/consent?state=<transaction_state>` endpoint +with `action: "accept"`. The transaction state is automatically included in both the +URL query parameter and the form body. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional. An object for any custom key-value pairs + to be sent with the request. These parameters will be + included in the form data submitted to the server. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves once the form submission is initiated. + Typically, a successful submission leads to a server-side redirect. + +#### Throws + +Throws an error if `FormHandler` encounters an unrecoverable issue + during submission (e.g., network error). Server-side validation errors + from Auth0 (like "invalid_request") are not thrown as JavaScript errors + but are made available in `this.transaction.errors` after the operation. + +#### Example + +```typescript +import Consent from '@auth0/auth0-acul-js/consent'; +const consentManager = new Consent(); +const handleAccept = async () => { + try { + await consentManager.accept(); + console.log('Consent accepted successfully.'); + } catch (err) { + console.error('Error accepting consent:', err); + } +}; +``` + +#### Implementation of + +[`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers).[`accept`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.md#accept) + +</ParamField> + +<ParamField body='deny' type='Promise<void>'> +{/*> **deny**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/consent/index.ts:107](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/consent/index.ts#L107) + +Submits the user's decision to deny (reject) the requested permissions. +This method prepares and posts form data to the `/u/consent?state=<transaction_state>` endpoint +with `action: "deny"`. The transaction state is automatically included in both the +URL query parameter and the form body. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional. An object for any custom key-value pairs + to be sent with the request. These parameters will be + included in the form data submitted to the server. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves once the form submission is initiated. + A successful submission usually results in a server-side redirect. + +#### Throws + +Throws an error if `FormHandler` encounters an issue (e.g., network error). + Server-side validation errors are reflected in `this.transaction.errors`. + +#### Example + +```typescript +import Consent from '@auth0/auth0-acul-js/consent'; +const consentManager = new Consent(); +const handleDeny = async () => { + try { + await consentManager.deny(); + console.log('Form denied successfully.'); + } catch (err) { + console.error('Failed to deny form:', error); + } +}; + +``` +#### Implementation of + +[`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers).[`deny`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.md#deny) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/CustomizedConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/CustomizedConsent.mdx new file mode 100644 index 000000000..46acf2d66 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/CustomizedConsent.mdx @@ -0,0 +1,433 @@ +--- +title: "CustomizedConsent" +--- + +Defined in: [src/screens/customized-consent/index.ts:70](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L70) + +CustomizedConsent + + +<RequestExample> +```ts +export default class CustomizedConsent extends BaseContext implements CustomizedConsentMembers { + /** + * The unique identifier for the Customized Consent screen. + * This static property is used by the SDK's `BaseContext` to ensure that the + * class is instantiated in the correct screen context. + * @type {string} + * static + * @readonly + */ + static screenIdentifier: string = ScreenIds.CUSTOMIZED_CONSENT; + + /** + * Holds the specific screen data and properties for the Customized Consent screen, + * processed by `ScreenOverride`. This includes `scopes` and `authorizationDetails`. + * @type {ScreenMembersOnCustomizedConsent} + * @public + */ + public screen: ScreenMembersOnCustomizedConsent; + + /** + * Creates an instance of the `CustomizedConsent` screen manager. + * The constructor initializes the `BaseContext` and sets up the `screen` property + * with an instance of `ScreenOverride` tailored for the customized consent screen. + * @throws {Error} If the Universal Login Context is not available or if the + * current screen name in the context does not match `CustomizedConsent.screenIdentifier`. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Submits the user's decision to accept (grant) the requested permissions and authorization details. + * This method prepares and posts form data to the `/u/customized-consent?state=<transaction_state>` endpoint + * with `action: "accept"`. The transaction state is automatically included in both the + * URL query parameter and the form body. + * + * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs + * to be sent with the request. These parameters will be + * included in the form data submitted to the server. + * @returns {Promise<void>} A promise that resolves once the form submission is initiated. + * Typically, a successful submission leads to a server-side redirect. + * @throws {Error} Throws an error if `FormHandler` encounters an unrecoverable issue + * during submission (e.g., network error). Server-side validation errors + * from Auth0 (like "invalid_request") are not thrown as JavaScript errors + * but are made available in `this.transaction.errors` after the operation. + */ + async accept(payload?: CustomOptions): Promise<void> { + const formOptions: SDKFormOptions = { + state: this.transaction.state, // For form body + telemetry: [CustomizedConsent.screenIdentifier, 'accept'], + }; + const submitPayload = { + ...payload, + action: FormActions.ACCEPT, + }; + await new FormHandler(formOptions).submitData<typeof submitPayload>(submitPayload); + } + + /** + * Submits the user's decision to deny (reject) the requested permissions and authorization details. + * This method prepares and posts form data to the `/u/customized-consent?state=<transaction_state>` endpoint + * with `action: "deny"`. The transaction state is automatically included in both the + * URL query parameter and the form body. + * + * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs + * to be sent with the request. These parameters will be + * included in the form data submitted to the server. + * @returns {Promise<void>} A promise that resolves once the form submission is initiated. + * A successful submission usually results in a server-side redirect. + * @throws {Error} Throws an error if `FormHandler` encounters an issue (e.g., network error). + * Server-side validation errors are reflected in `this.transaction.errors`. + */ + async deny(payload?: CustomOptions): Promise<void> { + const formOptions: SDKFormOptions = { + state: this.transaction.state, // For form body + telemetry: [CustomizedConsent.screenIdentifier, 'deny'], + }; + const submitPayload = { + ...payload, + action: FormActions.DENY, + }; + await new FormHandler(formOptions).submitData<typeof submitPayload>(submitPayload); + } +} +``` +</RequestExample> + +## Example + +```typescript +// How to use the CustomizedConsent screen SDK: +import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent'; + +// Instantiate the manager for the customized consent screen +const consentManager = new CustomizedConsent(); + +// Accessing screen data +const clientName = consentManager.client.name; +const userEmail = consentManager.user.email; +const requestedScopes = consentManager.screen.scopes; +const authorizationDetails = consentManager.screen.authorizationDetails; + +console.log(`${clientName} is requesting consent from ${userEmail}.`); +console.log("Requested Scopes:", requestedScopes); +console.log("Authorization Details:", authorizationDetails); + +// Accessing transaction errors from a previous attempt +const transactionErrors = consentManager.transaction.errors; +if (transactionErrors && transactionErrors.length > 0) { + transactionErrors.forEach(error => { + console.error(`Error: ${error.message}`); + // Display these errors to the user. + }); +} + +// Example of handling consent acceptance +async function onAcceptConsent() { + try { + await consentManager.accept(); + // On success, Auth0 will typically redirect. + } catch (e) { + console.error('Failed to accept consent:', e); + } +} + +// Example of handling consent denial +async function onDenyConsent() { + try { + await consentManager.deny({ denial_reason: "user_declined" }); + // On success, Auth0 will typically redirect. + } catch (e) { + console.error('Failed to deny consent:', e); + } +} +``` + +## Extends + +- `BaseContext` + +## Implements + +- [`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers) + +## Constructors + +<ParamField body="CustomizedConsent" type="Constructor"> +{/*> **new CustomizedConsent**(): `CustomizedConsent`*/} + +Defined in: [src/screens/customized-consent/index.ts:96](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L96) + +Creates an instance of the `CustomizedConsent` screen manager. +The constructor initializes the `BaseContext` and sets up the `screen` property +with an instance of `ScreenOverride` tailored for the customized consent screen. + +#### Returns + +`CustomizedConsent` + +#### Throws + +If the Universal Login Context is not available or if the +current screen name in the context does not match `CustomizedConsent.screenIdentifier`. + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent">ScreenMembersOnCustomizedConsent</a></span>}> +{/*> **screen**: [`ScreenMembersOnCustomizedConsent`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent)*/} + +Defined in: [src/screens/customized-consent/index.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L87) + +Holds the specific screen data and properties for the Customized Consent screen, +processed by `ScreenOverride`. This includes `scopes` and `authorizationDetails`. + +#### Implementation of + +[`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `readonly` `static` **screenIdentifier**: `string` = `ScreenIds.CUSTOMIZED_CONSENT`*/} + +Defined in: [src/screens/customized-consent/index.ts:79](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L79) + +The unique identifier for the Customized Consent screen. +This static property is used by the SDK's `BaseContext` to ensure that the +class is instantiated in the correct screen context. + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='accept' type='Promise<void>'> +{/*> **accept**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/customized-consent/index.ts:118](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L118) + +Submits the user's decision to accept (grant) the requested permissions and authorization details. +This method prepares and posts form data to the `/u/customized-consent?state=<transaction_state>` endpoint +with `action: "accept"`. The transaction state is automatically included in both the +URL query parameter and the form body. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional. An object for any custom key-value pairs + to be sent with the request. These parameters will be + included in the form data submitted to the server. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves once the form submission is initiated. + Typically, a successful submission leads to a server-side redirect. + +#### Throws + +Throws an error if `FormHandler` encounters an unrecoverable issue + during submission (e.g., network error). Server-side validation errors + from Auth0 (like "invalid_request") are not thrown as JavaScript errors + but are made available in `this.transaction.errors` after the operation. + +#### Implementation of + +[`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers).[`accept`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.md#accept) + +</ParamField> + +<ParamField body='deny' type='Promise<void>'> +{/*> **deny**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/customized-consent/index.ts:144](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L144) + +Submits the user's decision to deny (reject) the requested permissions and authorization details. +This method prepares and posts form data to the `/u/customized-consent?state=<transaction_state>` endpoint +with `action: "deny"`. The transaction state is automatically included in both the +URL query parameter and the form body. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional. An object for any custom key-value pairs + to be sent with the request. These parameters will be + included in the form data submitted to the server. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves once the form submission is initiated. + A successful submission usually results in a server-side redirect. + +#### Throws + +Throws an error if `FormHandler` encounters an issue (e.g., network error). + Server-side validation errors are reflected in `this.transaction.errors`. + +#### Implementation of + +[`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers).[`deny`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.md#deny) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivation.mdx new file mode 100644 index 000000000..dc764e4bc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivation.mdx @@ -0,0 +1,300 @@ +--- +title: "DeviceCodeActivation" +--- + +Defined in: [src/screens/device-code-activation/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation/index.ts#L12) + +Class implementing the Device Code Activation screen functionality. +This screen is displayed when the user needs to enter the code on their device to activate it. + + +<RequestExample> +```ts +export default class DeviceCodeActivation extends BaseContext implements DeviceCodeActivationMembers { + static screenIdentifier: string = ScreenIds.DEVICE_CODE_ACTIVATION; + + /** + * Creates an instance of the DeviceCodeActivation screen. + */ + constructor() { + super(); + } + + /** + * Submits the device code entered by the user. + * This action is triggered when the user enters the code displayed on their device and submits the form. + * + * @param {object} payload - An object containing the code entered by the user and any custom payload. + * @param {string} payload.code - The device code entered by the user. + * + * @returns {Promise<void>} A promise that resolves when the code is successfully submitted. + * @example + * ```typescript + * import DeviceCodeActivation from '@auth0/auth0-acul-js/device-code-activation'; + * const deviceCodeActivationManager = new DeviceCodeActivation(); + * async function activateDeviceCode(code) { + * try { + * await deviceCodeActivationManager.continue({ code }); + * console.log('Device code activation successful.'); + * } catch (error) { + * console.error('Error during device code activation:', error); + * } + * } + * ``` + * Rejects with an error if the submission fails. + */ + async continue(payload: ContinueOptions): Promise<void> { + if (!payload || !payload.code) { + return Promise.reject(new Error('The code parameter is required.')); + } + + const formOptions: FormOptions = { + state: this.transaction.state, + telemetry: [DeviceCodeActivation.screenIdentifier, 'continue'], + }; + + await new FormHandler(formOptions).submitData({ + ...payload, + action: FormActions.DEFAULT, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers) + +## Constructors + +<ParamField body="DeviceCodeActivation" type="Constructor"> +{/*> **new DeviceCodeActivation**(): `DeviceCodeActivation`*/} + +Defined in: [src/screens/device-code-activation/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation/index.ts#L18) + +Creates an instance of the DeviceCodeActivation screen. + +#### Returns + +`DeviceCodeActivation` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.DEVICE_CODE_ACTIVATION`*/} + +Defined in: [src/screens/device-code-activation/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation/index.ts#L13) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/device-code-activation/index.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation/index.ts#L45) + +Submits the device code entered by the user. +This action is triggered when the user enters the code displayed on their device and submits the form. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions">DeviceCodeActivationContinueOptions</a></span>}> +[`DeviceCodeActivationContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions) + +An object containing the code entered by the user and any custom payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the code is successfully submitted. + +#### Example + +```typescript +import DeviceCodeActivation from '@auth0/auth0-acul-js/device-code-activation'; +const deviceCodeActivationManager = new DeviceCodeActivation(); +async function activateDeviceCode(code) { + try { + await deviceCodeActivationManager.continue({ code }); + console.log('Device code activation successful.'); + } catch (error) { + console.error('Error during device code activation:', error); + } +} +``` +Rejects with an error if the submission fails. + +#### Implementation of + +[`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationAllowed.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationAllowed.mdx new file mode 100644 index 000000000..d35745a86 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationAllowed.mdx @@ -0,0 +1,217 @@ +--- +title: "DeviceCodeActivationAllowed" +--- + +Defined in: [src/screens/device-code-activation-allowed/index.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation-allowed/index.ts#L10) + +Class implementing the Device Code Activation Allowed screen functionality. +This screen is displayed when the device code activation is allowed. + + +<RequestExample> +```ts +export default class DeviceCodeActivationAllowed extends BaseContext implements DeviceCodeActivationAllowedMembers { + static screenIdentifier: string = ScreenIds.DEVICE_CODE_ACTIVATION_ALLOWED; + + /** + * Creates an instance of DeviceCodeActivationAllowed screen manager. + */ + constructor() { + super(); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers) + +## Constructors + +<ParamField body="DeviceCodeActivationAllowed" type="Constructor"> +{/*> **new DeviceCodeActivationAllowed**(): `DeviceCodeActivationAllowed`*/} + +Defined in: [src/screens/device-code-activation-allowed/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation-allowed/index.ts#L16) + +Creates an instance of DeviceCodeActivationAllowed screen manager. + +#### Returns + +`DeviceCodeActivationAllowed` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.DEVICE_CODE_ACTIVATION_ALLOWED`*/} + +Defined in: [src/screens/device-code-activation-allowed/index.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation-allowed/index.ts#L11) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationDenied.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationDenied.mdx new file mode 100644 index 000000000..d30a4377b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationDenied.mdx @@ -0,0 +1,217 @@ +--- +title: "DeviceCodeActivationDenied" +--- + +Defined in: [src/screens/device-code-activation-denied/index.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation-denied/index.ts#L10) + +Class implementing the Device Code Activation Denied screen functionality. +This screen is displayed when the device code activation is denied. + + +<RequestExample> +```ts +export default class DeviceCodeActivationDenied extends BaseContext implements DeviceCodeActivationDeniedMembers { + static screenIdentifier: string = ScreenIds.DEVICE_CODE_ACTIVATION_DENIED; + + /** + * Creates an instance of DeviceCodeActivationDenied screen manager. + */ + constructor() { + super(); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers) + +## Constructors + +<ParamField body="DeviceCodeActivationDenied" type="Constructor"> +{/*> **new DeviceCodeActivationDenied**(): `DeviceCodeActivationDenied`*/} + +Defined in: [src/screens/device-code-activation-denied/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation-denied/index.ts#L16) + +Creates an instance of DeviceCodeActivationDenied screen manager. + +#### Returns + +`DeviceCodeActivationDenied` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.DEVICE_CODE_ACTIVATION_DENIED`*/} + +Defined in: [src/screens/device-code-activation-denied/index.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation-denied/index.ts#L11) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeConfirmation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeConfirmation.mdx new file mode 100644 index 000000000..1b4e8cd79 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeConfirmation.mdx @@ -0,0 +1,326 @@ +--- +title: "DeviceCodeConfirmation" +--- + +Defined in: [src/screens/device-code-confirmation/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L19) + +Class implementing the Device Code Confirmation screen functionality. +This screen is displayed when the user needs to confirm the device code. + + +<RequestExample> +```ts +export default class DeviceCodeConfirmation extends BaseContext implements DeviceCodeConfirmationMembers { + static screenIdentifier: string = ScreenIds.DEVICE_CODE_CONFIRMATION; + screen: screenOptions; + + /** + * Creates an instance of the DeviceCodeConfirmation screen. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Confirms the device code. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation'; + * + * const deviceCodeConfirmation = new DeviceCodeConfirmation(); + * await deviceCodeConfirmation.confirm(); + * ``` + */ + async confirm(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [DeviceCodeConfirmation.screenIdentifier, FormActions.CONFIRM], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.CONFIRM }); + } + + /** + * Cancels the device code flow. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation'; + * + * const deviceCodeConfirmation = new DeviceCodeConfirmation(); + * await deviceCodeConfirmation.cancel(); + * ``` + */ + async cancel(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [DeviceCodeConfirmation.screenIdentifier, FormActions.CANCEL], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.CANCEL }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers) + +## Constructors + +<ParamField body="DeviceCodeConfirmation" type="Constructor"> +{/*> **new DeviceCodeConfirmation**(): `DeviceCodeConfirmation`*/} + +Defined in: [src/screens/device-code-confirmation/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L26) + +Creates an instance of the DeviceCodeConfirmation screen. + +#### Returns + +`DeviceCodeConfirmation` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation">ScreenMembersOnDeviceCodeConfirmation</a></span>}> +{/*> **screen**: [`ScreenMembersOnDeviceCodeConfirmation`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation)*/} + +Defined in: [src/screens/device-code-confirmation/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L21) + +#### Implementation of + +[`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.DEVICE_CODE_CONFIRMATION`*/} + +Defined in: [src/screens/device-code-confirmation/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L20) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='cancel' type='Promise<void>'> +{/*> **cancel**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/device-code-confirmation/index.ts:62](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L62) + +Cancels the device code flow. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation'; + +const deviceCodeConfirmation = new DeviceCodeConfirmation(); +await deviceCodeConfirmation.cancel(); +``` + +#### Implementation of + +[`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers).[`cancel`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.md#cancel) + +</ParamField> + +<ParamField body='confirm' type='Promise<void>'> +{/*> **confirm**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/device-code-confirmation/index.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L43) + +Confirms the device code. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation'; + +const deviceCodeConfirmation = new DeviceCodeConfirmation(); +await deviceCodeConfirmation.confirm(); +``` + +#### Implementation of + +[`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers).[`confirm`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.md#confirm) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailIdentifierChallenge.mdx new file mode 100644 index 000000000..b117d3c09 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailIdentifierChallenge.mdx @@ -0,0 +1,441 @@ +--- +title: "EmailIdentifierChallenge" +--- + +Defined in: [src/screens/email-identifier-challenge/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L18) + + +<RequestExample> +```ts +export default class EmailIdentifierChallenge extends BaseContext implements EmailIdentifierChallengeMembers { + screen: ScreenOptions; + static screenIdentifier: string = ScreenIds.EMAIL_IDENTIFIER_CHALLENGE; + + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * @example + * import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; + * + * const emailIdentifierChallenge = new EmailIdentifierChallenge(); + * emailIdentifierChallenge.submitEmailChallenge({ + * code: "<string>" + * }); + */ + async submitEmailChallenge(payload: EmailChallengeOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [EmailIdentifierChallenge.screenIdentifier, 'submitEmailChallenge'], + }; + await new FormHandler(options).submitData(payload); + } + + /** + * @example + * import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; + * + * const emailIdentifierChallenge = new EmailIdentifierChallenge(); + * emailIdentifierChallenge.resendCode(); + */ + async resendCode(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [EmailIdentifierChallenge.screenIdentifier, 'resendCode'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND_CODE }); + } + + /** + * @example + * import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; + * + * const emailIdentifierChallenge = new EmailIdentifierChallenge(); + * emailIdentifierChallenge.returnToPrevious(); + */ + async returnToPrevious(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [EmailIdentifierChallenge.screenIdentifier, 'returnToPrevious'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.BACK }); + } + /** + * Gets resend functionality with timeout management for this screen + * @param options - Configuration options for resend functionality + * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) + * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) + * @param options.onTimeout - Callback to execute when timeout countdown reaches zero + * @returns ResendControl object with startResend method + * @utilityFeature + * + * @example + * import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; + * const handleStatusChange = (remainingSeconds, isDisabled) => { + * setDisabled(isDisabled); + * setRemaining(remainingSeconds); + * }; + * + * const handleTimeout = () => { + * console.log('Timeout completed, resend is now available'); + * }; + * + * const { startResend } = emailChallenge.resendManager({ + * timeoutSeconds: 15, + * onStatusChange: handleStatusChange, + * onTimeout: handleTimeout + * }); + * + * // Call startResend when user clicks resend button + * await startResend(); + * + */ + resendManager(options?: StartResendOptions): ResendControl { + return createResendControl( + EmailIdentifierChallenge.screenIdentifier, + () => this.resendCode(), + options, + !!this.screen.data?.resendLimitReached + ); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers) + +## Constructors + +<ParamField body="EmailIdentifierChallenge" type="Constructor"> +{/*> **new EmailIdentifierChallenge**(): `EmailIdentifierChallenge`*/} + +Defined in: [src/screens/email-identifier-challenge/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L22) + +#### Returns + +`EmailIdentifierChallenge` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge">ScreenMembersOnEmailIdentifierChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnEmailIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge)*/} + +Defined in: [src/screens/email-identifier-challenge/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L19) + +#### Implementation of + +[`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.EMAIL_IDENTIFIER_CHALLENGE`*/} + +Defined in: [src/screens/email-identifier-challenge/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L20) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/email-identifier-challenge/index.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L52) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; + +const emailIdentifierChallenge = new EmailIdentifierChallenge(); +emailIdentifierChallenge.resendCode(); +``` + +#### Implementation of + +[`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers).[`resendCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.md#resendcode) + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [src/screens/email-identifier-challenge/index.ts:104](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L104) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +#### Example + +```ts +import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; + const handleStatusChange = (remainingSeconds, isDisabled) => { + setDisabled(isDisabled); + setRemaining(remainingSeconds); + }; + + const handleTimeout = () => { + console.log('Timeout completed, resend is now available'); + }; + + const { startResend } = emailChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout + }); + + // Call startResend when user clicks resend button + await startResend(); +``` + +#### Implementation of + +[`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers).[`resendManager`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.md#resendmanager) + +</ParamField> + +<ParamField body='returnToPrevious' type='Promise<void>'> +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/email-identifier-challenge/index.ts:67](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L67) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; + +const emailIdentifierChallenge = new EmailIdentifierChallenge(); +emailIdentifierChallenge.returnToPrevious(); +``` + +#### Implementation of + +[`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers).[`returnToPrevious`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.md#returntoprevious) + +</ParamField> + +<ParamField body='submitEmailChallenge' type='Promise<void>'> +{/*> **submitEmailChallenge**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/email-identifier-challenge/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L37) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions">EmailChallengeOptions</a></span>}> +[`EmailChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; + +const emailIdentifierChallenge = new EmailIdentifierChallenge(); +emailIdentifierChallenge.submitEmailChallenge({ + code: "<string>" +}); +``` + +#### Implementation of + +[`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers).[`submitEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.md#submitemailchallenge) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailOTPChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailOTPChallenge.mdx new file mode 100644 index 000000000..32913a042 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailOTPChallenge.mdx @@ -0,0 +1,417 @@ +--- +title: "EmailOTPChallenge" +--- + +Defined in: [src/screens/email-otp-challenge/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L14) + +Represents the Email OTP Challenge screen. + + +<RequestExample> +```ts +export default class EmailOTPChallenge extends BaseContext implements EmailOTPChallengeMembers { + static screenIdentifier: string = ScreenIds.EMAIL_OTP_CHALLENGE; + + constructor() { + super(); + } + + /** + * Submits the OTP code entered by the user. + * @param options Optional parameters to include in the submission. + * @example + * ```typescript + * import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge'; + * + * const emailOTPChallenge = new EmailOTPChallenge(); + * emailOTPChallenge.submitCode({ + * code: '123456', + * }); + * ``` + */ + async submitCode(options: OtpCodeOptions): Promise<void> { + const formOptions: FormOptions = { + state: this.transaction.state, + telemetry: [EmailOTPChallenge.screenIdentifier, 'submitCode'], + }; + const payload = { + ...options, + action: FormActions.DEFAULT, + }; + + await new FormHandler(formOptions).submitData(payload); + } + + /** + * Requests a new OTP code to be sent to the user's email. + * @param options Optional parameters to include in the resend request. + * @example + * ```typescript + * import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge'; + * + * const emailOTPChallenge = new EmailOTPChallenge(); + * emailOTPChallenge.resendCode(); + * ``` + */ + async resendCode(options?: CustomOptions): Promise<void> { + const formOptions: FormOptions = { + state: this.transaction.state, + telemetry: [EmailOTPChallenge.screenIdentifier, 'resendCode'], + }; + + const payload = { + ...options, + action: FormActions.RESEND_CODE, + }; + + await new FormHandler(formOptions).submitData(payload); + } + + /** + * Gets resend functionality with timeout management for this screen + * @param options - Configuration options for resend functionality + * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) + * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) + * @param options.onTimeout - Callback to execute when timeout countdown reaches zero + * @returns ResendControl object with startResend method + * @utilityFeature + * + * @example + * ```typescript + * import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge'; + * + * const emailOTPChallenge = new EmailOTPChallenge(); + * const { startResend } = emailOTPChallenge.resendManager({ + * timeoutSeconds: 15, + * onStatusChange: (remainingSeconds, isDisabled) => { + * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + * }, + * onTimeout: () => { + * console.log('Resend is now available'); + * } + * }); + * + * // Call startResend when user clicks resend button + * startResend(); + * ``` + */ + resendManager(options?: StartResendOptions): ResendControl { + return createResendControl( + EmailOTPChallenge.screenIdentifier, + () => this.resendCode(), + options + ); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers) + +## Constructors + +<ParamField body="EmailOTPChallenge" type="Constructor"> +{/*> **new EmailOTPChallenge**(): `EmailOTPChallenge`*/} + +Defined in: [src/screens/email-otp-challenge/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L17) + +#### Returns + +`EmailOTPChallenge` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.EMAIL_OTP_CHALLENGE`*/} + +Defined in: [src/screens/email-otp-challenge/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L15) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/email-otp-challenge/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L58) + +Requests a new OTP code to be sent to the user's email. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional parameters to include in the resend request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge'; + +const emailOTPChallenge = new EmailOTPChallenge(); +emailOTPChallenge.resendCode(); +``` + +#### Implementation of + +[`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers).[`resendCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.md#resendcode) + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [src/screens/email-otp-challenge/index.ts:100](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L100) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +#### Example + +```typescript +import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge'; + +const emailOTPChallenge = new EmailOTPChallenge(); +const { startResend } = emailOTPChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: (remainingSeconds, isDisabled) => { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + }, + onTimeout: () => { + console.log('Resend is now available'); + } +}); + +// Call startResend when user clicks resend button +startResend(); +``` + +#### Implementation of + +[`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers).[`resendManager`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.md#resendmanager) + +</ParamField> + +<ParamField body='submitCode' type='Promise<void>'> +{/*> **submitCode**(`options`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/email-otp-challenge/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L34) + +Submits the OTP code entered by the user. + +<Expandable title="Parameters"> +<ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions">OtpCodeOptions</a></span>}> +[`OtpCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions) + +Optional parameters to include in the submission. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge'; + +const emailOTPChallenge = new EmailOTPChallenge(); +emailOTPChallenge.submitCode({ + code: '123456', +}); +``` + +#### Implementation of + +[`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers).[`submitCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.md#submitcode) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailVerificationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailVerificationResult.mdx new file mode 100644 index 000000000..79f711855 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailVerificationResult.mdx @@ -0,0 +1,262 @@ +--- +title: "EmailVerificationResult" +--- + +Defined in: [src/screens/email-verification-result/index.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-verification-result/index.ts#L38) + +EmailVerificationResult + + +<RequestExample> +```ts +export default class EmailVerificationResult extends BaseContext implements EmailVerificationResultMembers { + /** + * static + * @property {string} screenIdentifier - The unique identifier for the Email Verification Result screen. + * This identifier is used by `BaseContext` to ensure the correct screen class is instantiated. + */ + static screenIdentifier: string = ScreenIds.EMAIL_VERIFICATION_RESULT; + + /** + * @property {ScreenOptions} screen - Holds the specific screen data and properties for the + * This includes the verification status and the login link. + */ + screen: ScreenOptions; + + /** + * Initializes a new instance of the `EmailVerificationResult` class. + * It retrieves the screen-specific context and sets up the `screen` property + * @throws {Error} If the Universal Login Context is not available or if the + * current screen name in the context does not match `EmailVerificationResult.screenIdentifier`. + */ + constructor() { + super(); // Calls BaseContext constructor for global context initialization and validation. + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + // This screen is informational. No specific operations like form submissions are defined. + // Users will typically navigate away using the `loginLink` provided in `this.screen.loginLink`. +} +``` +</RequestExample> + +## Example + +```typescript +import EmailVerificationResult from '@auth0/auth0-acul-js/email-verification-result'; + +const emailVerificationResultScreen = new EmailVerificationResult(); + +// Access screen data +const status = emailVerificationResultScreen.screen.data?.status; +const loginLink = emailVerificationResultScreen.screen.loginLink; + +console.log(`Verification Status: ${status}`); +if (loginLink) { + console.log(`Proceed to login: ${loginLink}`); + // In a UI, you would use this link for a button or anchor tag + // e.g., <a href={loginLink}>Go to Login</a> +} +``` + +## Extends + +- `BaseContext` + +## Implements + +- [`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers) + +## Constructors + +<ParamField body="EmailVerificationResult" type="Constructor"> +{/*> **new EmailVerificationResult**(): `EmailVerificationResult`*/} + +Defined in: [src/screens/email-verification-result/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-verification-result/index.ts#L58) + +Initializes a new instance of the `EmailVerificationResult` class. +It retrieves the screen-specific context and sets up the `screen` property + +#### Returns + +`EmailVerificationResult` + +#### Throws + +If the Universal Login Context is not available or if the +current screen name in the context does not match `EmailVerificationResult.screenIdentifier`. + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult">ScreenMembersOnEmailVerificationResult</a></span>}> +{/*> **screen**: [`ScreenMembersOnEmailVerificationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult)*/} + +Defined in: [src/screens/email-verification-result/index.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-verification-result/index.ts#L50) + +#### Implementation of + +[`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.EMAIL_VERIFICATION_RESULT`*/} + +Defined in: [src/screens/email-verification-result/index.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-verification-result/index.ts#L44) + +static + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/InterstitialCaptcha.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/InterstitialCaptcha.mdx new file mode 100644 index 000000000..5fd00ff04 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/InterstitialCaptcha.mdx @@ -0,0 +1,264 @@ +--- +title: "InterstitialCaptcha" +--- + +Defined in: [src/screens/interstitial-captcha/index.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/interstitial-captcha/index.ts#L8) + + +<RequestExample> +```ts +export default class InterstitialCaptcha extends BaseContext implements InterstitialCaptchaMembers { + static screenIdentifier: string = ScreenIds.INTERSTITIAL_CAPTCHA; + + constructor() { + super(); + } + /** + * @remarks + * This methods handles InterstitialCaptcha related configuration. + * + * @example + * import InterstitialCaptcha from "@auth0/auth0-acul-js/interstitial-captcha"; + * + * const interstitialCaptcha = new InterstitialCaptcha(); + * interstitialCaptcha.submitCaptcha({ + * captcha: "captchaValue", + * }); + */ + async submitCaptcha(payload: SubmitCaptchaOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [InterstitialCaptcha.screenIdentifier, 'submitCaptcha'], + }; + await new FormHandler(options).submitData<SubmitCaptchaOptions>(payload); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers) + +## Constructors + +<ParamField body="InterstitialCaptcha" type="Constructor"> +{/*> **new InterstitialCaptcha**(): `InterstitialCaptcha`*/} + +Defined in: [src/screens/interstitial-captcha/index.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/interstitial-captcha/index.ts#L11) + +#### Returns + +`InterstitialCaptcha` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.INTERSTITIAL_CAPTCHA`*/} + +Defined in: [src/screens/interstitial-captcha/index.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/interstitial-captcha/index.ts#L9) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='submitCaptcha' type='Promise<void>'> +{/*> **submitCaptcha**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/interstitial-captcha/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/interstitial-captcha/index.ts#L26) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions">SubmitCaptchaOptions</a></span>}> +[`SubmitCaptchaOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Remarks + +This methods handles InterstitialCaptcha related configuration. + +#### Example + +```ts +import InterstitialCaptcha from "@auth0/auth0-acul-js/interstitial-captcha"; + +const interstitialCaptcha = new InterstitialCaptcha(); +interstitialCaptcha.submitCaptcha({ + captcha: "captchaValue", +}); +``` + +#### Implementation of + +[`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers).[`submitCaptcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.md#submitcaptcha) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Login.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Login.mdx new file mode 100644 index 000000000..0dcee4130 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Login.mdx @@ -0,0 +1,427 @@ +--- +title: "Login" +--- + +Defined in: [src/screens/login/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L26) + +Login screen implementation class + + +<RequestExample> +```ts +export default class Login extends BaseContext implements LoginMembers { + static screenIdentifier: string = ScreenIds.LOGIN; + screen: ScreenOptions; + transaction: TransactionOptions; + + /** + * Creates an instance of Login screen manager + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + const transactionContext = this.getContext('transaction') as TransactionContext; + this.screen = new ScreenOverride(screenContext); + this.transaction = new TransactionOverride(transactionContext); + } + + /** + * Performs login with username/password + * @param payload The login options containing username and password + * @example + * ```typescript + * import Login from "@auth0/auth0-acul-js/login"; + * const loginManager = new Login(); + * loginManager.login({ + * username: "testUser", + * password: "testPassword" + * }); + * ``` + */ + async login(payload: LoginOptions): Promise<void> { + const options: FormOptions = { state: this.transaction.state, telemetry: [Login.screenIdentifier, 'login'] }; + await new FormHandler(options).submitData<LoginOptions>(payload); + } + + /** + * Performs login with social provider + * @param payload The social login options containing connection name + * @example + * ```typescript + * import Login from "@auth0/auth0-acul-js/login"; + * const loginManager = new Login(); + * loginManager.federatedLogin({ + * connection: "google-oauth2" + * }); + * ``` + */ + async federatedLogin(payload: FederatedLoginOptions): Promise<void> { + const options: FormOptions = { state: this.transaction.state, telemetry: [Login.screenIdentifier, 'federatedLogin'] }; + await new FormHandler(options).submitData<FederatedLoginOptions>(payload); + } + + /** + * Picks country code for phone number input + * @param payload Optional custom options + * @example + * ```typescript + * import Login from "@auth0/auth0-acul-js/login"; + * const loginManager = new Login(); + * loginManager.pickCountryCode(); + * ``` + */ + async pickCountryCode(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [Login.screenIdentifier, 'pickCountryCode'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_COUNTRY_CODE, + }); + } + + /** + * Gets the active identifier types for the login screen + * @returns An array of active identifier types or null if none are active + * @example + * ```typescript + * import Login from "@auth0/auth0-acul-js/login"; + * const loginManager = new Login(); + * loginManager.getLoginIdentifiers(); + * ``` + * @utilityFeature + */ + getLoginIdentifiers(): IdentifierType[] | null { + return _getLoginIdentifiers(this.transaction.allowedIdentifiers); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers) + +## Constructors + +<ParamField body="Login" type="Constructor"> +{/*> **new Login**(): `Login`*/} + +Defined in: [src/screens/login/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L34) + +Creates an instance of Login screen manager + +#### Returns + +`Login` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin">ScreenMembersOnLogin</a></span>}> +{/*> **screen**: [`ScreenMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin)*/} + +Defined in: [src/screens/login/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L28) + +#### Implementation of + +[`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin">TransactionMembersOnLogin</a></span>}> +{/*> **transaction**: [`TransactionMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin)*/} + +Defined in: [src/screens/login/index.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L29) + +#### Implementation of + +[`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.md#transaction) + +#### Overrides + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGIN`*/} + +Defined in: [src/screens/login/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L27) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='federatedLogin' type='Promise<void>'> +{/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login/index.ts:72](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L72) + +Performs login with social provider + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions">FederatedLoginPayloadOptions</a></span>}> +[`FederatedLoginPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions) + +The social login options containing connection name +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import Login from "@auth0/auth0-acul-js/login"; +const loginManager = new Login(); +loginManager.federatedLogin({ + connection: "google-oauth2" +}); +``` + +#### Implementation of + +[`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers).[`federatedLogin`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.md#federatedlogin) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='getLoginIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType">ScreenIdentifierType</a>[]</span>}> +{/*> **getLoginIdentifiers**(): [`ScreenIdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType)[] \| `null`*/} + +Defined in: [src/screens/login/index.ts:110](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L110) + +**`Utility Feature`** + +Gets the active identifier types for the login screen + +#### Returns + +[`ScreenIdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType)[] \| `null` + +An array of active identifier types or null if none are active + +#### Example + +```typescript +import Login from "@auth0/auth0-acul-js/login"; +const loginManager = new Login(); +loginManager.getLoginIdentifiers(); +``` + +#### Implementation of + +[`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers).[`getLoginIdentifiers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.md#getloginidentifiers) + +</ParamField> + +<ParamField body='login' type='Promise<void>'> +{/*> **login**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login/index.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L55) + +Performs login with username/password + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions">LoginPayloadOptions</a></span>}> +[`LoginPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions) + +The login options containing username and password +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import Login from "@auth0/auth0-acul-js/login"; +const loginManager = new Login(); +loginManager.login({ + username: "testUser", + password: "testPassword" +}); +``` + +#### Implementation of + +[`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers).[`login`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.md#login) + +</ParamField> + +<ParamField body='pickCountryCode' type='Promise<void>'> +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login/index.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L87) + +Picks country code for phone number input + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import Login from "@auth0/auth0-acul-js/login"; +const loginManager = new Login(); +loginManager.pickCountryCode(); +``` + +#### Implementation of + +[`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers).[`pickCountryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.md#pickcountrycode) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginEmailVerification.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginEmailVerification.mdx new file mode 100644 index 000000000..53f0e384c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginEmailVerification.mdx @@ -0,0 +1,581 @@ +--- +title: "LoginEmailVerification" +--- + +Defined in: [src/screens/login-email-verification/index.ts:77](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L77) + +LoginEmailVerification +classdesc Manages interactions for the "login-email-verification" screen. +This screen prompts the user to enter a one-time code sent to their email address +to verify their identity during the login process. + +It provides methods to submit the entered code (`continueWithCode`) or +to request a new code if the original one was not received or has expired (`resendCode`). + +Inherits from `BaseContext` to access shared authentication flow data like +transaction state, client information, and internationalization texts. + + +<RequestExample> +```ts +export default class LoginEmailVerification extends BaseContext implements LoginEmailVerificationMembers { + /** + * The unique identifier for the Login Email Verification screen. + * This static property is used by the SDK's `BaseContext` to ensure that the + * class is instantiated in the correct screen context. + * @type {string} + * static + * @readonly + */ + static screenIdentifier: string = ScreenIds.LOGIN_EMAIL_VERIFICATION; + + /** + * Creates an instance of the `LoginEmailVerification` screen manager. + * The constructor initializes the `BaseContext`, which involves parsing the + */ + constructor() { + super(); + } + + /** + * Submits the email verification code entered by the user to Auth0. + * This method prepares and posts the form data, including the verification code + * and the required `action: "default"`, to the `/u/login-email-verification` endpoint. + * + * @param {ContinueWithCodeOptions} payload - An object containing the `code` (string) + * entered by the user. May also contain + * other custom parameters if needed. + * @returns {Promise<void>} A promise that resolves once the form submission is initiated. + * Typically, a successful submission leads to a server-side redirect. + * If the code is incorrect or an error occurs, the page will + * re-render, and `this.transaction.errors` will be populated. + * @throws {Error} If the `payload.code` is missing or not a string. It can also + * throw if `FormHandler` encounters an issue during submission (e.g. network error). + * Auth0 validation errors (e.g. "invalid-code") are not thrown as JS errors + * but are made available in `this.transaction.errors` post-operation. + * + * @example + * ```typescript + * const manager = new LoginEmailVerification(); + * // Assuming 'userInputCode' is a string obtained from a form input + * manager.continueWithCode({ code: userInputCode }) + * .catch(err => { + * // Handle unexpected submission errors + * displayGlobalError("Could not submit your code. Please try again."); + * }); + * // After the operation, check manager.transaction.errors for validation messages. + * ``` + */ + async continueWithCode(payload: ContinueWithCodeOptions): Promise<void> { + if (!payload || typeof payload.code !== 'string') { + throw new Error('The `code` property in the payload is required and must be a string.'); + } + + const formOptions: InternalFormOptions = { + state: this.transaction.state, + telemetry: [LoginEmailVerification.screenIdentifier, 'continueWithCode'] + }; + + // Prepare the data to be submitted. + // The `action: "default"` signals the server to process the code. + const submitPayload = { + ...payload, // Includes the 'code' and any other custom options passed in. + action: FormActions.DEFAULT, + }; + + // Use FormHandler to submit the data. + await new FormHandler(formOptions).submitData<typeof submitPayload>(submitPayload); + } + + /** + * Requests Auth0 to send a new verification code to the user's email address. + * This is typically used when the user didn't receive the original code, or it has expired. + * This method posts form data with `action: "resend-code"` to the + * `/u/login-email-verification` endpoint. + * + * @param {ResendCodeOptions} [payload] - Optional. An object for any custom parameters + * to be sent with the resend request. + * @returns {Promise<void>} A promise that resolves once the resend request is initiated. + * A successful request usually means a new email is dispatched. + * The page might re-render, and `this.transaction.errors` could + * be updated if, for example, rate limits (`too-many-emails`) are hit. + * @throws {Error} If `FormHandler` encounters an issue (e.g. network error). + * Server-side validation errors (e.g. rate limits) are not thrown + * as JS errors but are made available in `this.transaction.errors`. + * + * @example + * ```typescript + * const manager = new LoginEmailVerification(); + * manager.resendCode() + * .then(() => { + * // Inform the user that a new code has been sent. + * showNotification("A new verification code is on its way!"); + * }) + * .catch(err => { + * // Handle unexpected submission errors + * displayGlobalError("Could not request a new code. Please try again later."); + * }); + * // After the operation, check manager.transaction.errors for specific issues. + * ``` + */ + async resendCode(payload?: ResendCodeOptions): Promise<void> { + const formOptions: InternalFormOptions = { + state: this.transaction.state, + telemetry: [LoginEmailVerification.screenIdentifier, 'resendCode'] + }; + + // Prepare the data for resending the code. + // The `action: "resend-code"` signals the server to dispatch a new code. + const submitPayload = { + ...payload, // Includes any custom options passed in. + action: FormActions.RESEND_CODE, + }; + + // Use FormHandler to submit the data. + await new FormHandler(formOptions).submitData<typeof submitPayload>(submitPayload); + } + + /** + * Gets resend functionality with timeout management for this screen + * @param options - Configuration options for resend functionality + * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) + * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) + * @param options.onTimeout - Callback to execute when timeout countdown reaches zero + * @returns ResendControl object with startResend method + * @utilityFeature + * + * @example + * ```typescript + * import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification'; + * + * const loginEmailVerification = new LoginEmailVerification(); + * const { startResend } = loginEmailVerification.resendManager({ + * timeoutSeconds: 15, + * onStatusChange: (remainingSeconds, isDisabled) => { + * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + * }, + * onTimeout: () => { + * console.log('Resend is now available'); + * } + * }); + * + * // Call startResend when user clicks resend button + * startResend(); + * ``` + */ + resendManager(options?: StartResendOptions): ResendControl { + return createResendControl( + LoginEmailVerification.screenIdentifier, + () => this.resendCode(), + options + ); + } +} +``` +</RequestExample> + +## Example + +```typescript +// How to use the LoginEmailVerification screen SDK: +import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification'; + +// Instantiate the manager for the login email verification screen +const loginEmailVerificationManager = new LoginEmailVerification(); + +// Accessing screen-specific texts (e.g., for titles, labels, button texts) +const screenTexts = loginEmailVerificationManager.screen.texts; +const pageTitle = screenTexts?.title || 'Verify Your Email'; +const codePlaceholder = screenTexts?.codePlaceholder || 'Enter code here'; + +// Accessing transaction errors from a previous attempt +const transactionErrors = loginEmailVerificationManager.transaction.errors; +if (transactionErrors && transactionErrors.length > 0) { + transactionErrors.forEach(error => { + console.error(`Error Code: ${error.code}, Message: ${error.message}`); + // Display these errors to the user appropriately. + }); +} + +// Example of handling code submission from a form +async function onCodeSubmit(enteredCode: string) { + try { + await loginEmailVerificationManager.continueWithCode({ code: enteredCode }); + // On successful verification, Auth0 will typically redirect the user. + // If there's a validation error (e.g., invalid code), the page will + // re-render, and `loginEmailVerificationManager.transaction.errors` will be updated. + } catch (e) { + // This catch block is for unexpected errors during submission (e.g., network issues). + console.error('An unexpected error occurred while submitting the code:', e); + } +} + +// Example of handling a resend code request +async function onResendCodeClick() { + try { + await loginEmailVerificationManager.resendCode(); + // Inform the user that a new code has been sent. + // The page might re-render; check `loginEmailVerificationManager.transaction.errors` + // for issues like "too-many-emails". + } catch (e) { + console.error('An unexpected error occurred while resending the code:', e); + } +} +``` + +## Extends + +- `BaseContext` + +## Implements + +- [`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers) + +## Constructors + +<ParamField body="LoginEmailVerification" type="Constructor"> +{/*> **new LoginEmailVerification**(): `LoginEmailVerification`*/} + +Defined in: [src/screens/login-email-verification/index.ts:92](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L92) + +Creates an instance of the `LoginEmailVerification` screen manager. +The constructor initializes the `BaseContext`, which involves parsing the + +#### Returns + +`LoginEmailVerification` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `readonly` `static` **screenIdentifier**: `string` = `ScreenIds.LOGIN_EMAIL_VERIFICATION`*/} + +Defined in: [src/screens/login-email-verification/index.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L86) + +The unique identifier for the Login Email Verification screen. +This static property is used by the SDK's `BaseContext` to ensure that the +class is instantiated in the correct screen context. + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continueWithCode' type='Promise<void>'> +{/*> **continueWithCode**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login-email-verification/index.ts:125](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L125) + +Submits the email verification code entered by the user to Auth0. +This method prepares and posts the form data, including the verification code +and the required `action: "default"`, to the `/u/login-email-verification` endpoint. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload">ContinueWithCodeOptionPayload</a></span>}> +[`ContinueWithCodeOptionPayload`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload) + +An object containing the `code` (string) + entered by the user. May also contain + other custom parameters if needed. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves once the form submission is initiated. + Typically, a successful submission leads to a server-side redirect. + If the code is incorrect or an error occurs, the page will + re-render, and `this.transaction.errors` will be populated. + +#### Throws + +If the `payload.code` is missing or not a string. It can also + throw if `FormHandler` encounters an issue during submission (e.g. network error). + Auth0 validation errors (e.g. "invalid-code") are not thrown as JS errors + but are made available in `this.transaction.errors` post-operation. + +#### Example + +```typescript +const manager = new LoginEmailVerification(); +// Assuming 'userInputCode' is a string obtained from a form input +manager.continueWithCode({ code: userInputCode }) + .catch(err => { + // Handle unexpected submission errors + displayGlobalError("Could not submit your code. Please try again."); + }); +// After the operation, check manager.transaction.errors for validation messages. +``` + +#### Implementation of + +[`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers).[`continueWithCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.md#continuewithcode) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login-email-verification/index.ts:177](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L177) + +Requests Auth0 to send a new verification code to the user's email address. +This is typically used when the user didn't receive the original code, or it has expired. +This method posts form data with `action: "resend-code"` to the +`/u/login-email-verification` endpoint. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload">ResendCodeOptionsPayload</a></span>}> +[`ResendCodeOptionsPayload`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload) + +Optional. An object for any custom parameters + to be sent with the resend request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves once the resend request is initiated. + A successful request usually means a new email is dispatched. + The page might re-render, and `this.transaction.errors` could + be updated if, for example, rate limits (`too-many-emails`) are hit. + +#### Throws + +If `FormHandler` encounters an issue (e.g. network error). + Server-side validation errors (e.g. rate limits) are not thrown + as JS errors but are made available in `this.transaction.errors`. + +#### Example + +```typescript +const manager = new LoginEmailVerification(); +manager.resendCode() + .then(() => { + // Inform the user that a new code has been sent. + showNotification("A new verification code is on its way!"); + }) + .catch(err => { + // Handle unexpected submission errors + displayGlobalError("Could not request a new code. Please try again later."); + }); +// After the operation, check manager.transaction.errors for specific issues. +``` + +#### Implementation of + +[`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers).[`resendCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.md#resendcode) + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [src/screens/login-email-verification/index.ts:222](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L222) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +#### Example + +```typescript +import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification'; + +const loginEmailVerification = new LoginEmailVerification(); +const { startResend } = loginEmailVerification.resendManager({ + timeoutSeconds: 15, + onStatusChange: (remainingSeconds, isDisabled) => { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + }, + onTimeout: () => { + console.log('Resend is now available'); + } +}); + +// Call startResend when user clicks resend button +startResend(); +``` + +#### Implementation of + +[`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers).[`resendManager`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.md#resendmanager) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginId.mdx new file mode 100644 index 000000000..a2ae27a51 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginId.mdx @@ -0,0 +1,698 @@ +--- +title: "LoginId" +--- + +Defined in: [src/screens/login-id/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L26) + + +<RequestExample> +```ts +export default class LoginId extends BaseContext implements LoginIdMembers { + static screenIdentifier: string = ScreenIds.LOGIN_ID; + #passkeyController?: AbortController; + #isConditionalUIRegistered = false; + screen: ScreenOptions; + transaction: TransactionOptions; + + /** + * Creates an instance of LoginIdManager. + */ + constructor() { + super(); + + const screenContext = this.getContext('screen') as ScreenContext; + const transactionContext = this.getContext('transaction') as TransactionContext; + + // Add the properties specific to the prompt. + this.screen = new ScreenOverride(screenContext); + this.transaction = new TransactionOverride(transactionContext); + } + + /** + * @example + * + * import LoginId from "@auth0/auth0-acul-js/login-id"; + * + * const loginIdManager = new LoginId(); + * + * loginIdManager.login({ + * username: <usernameFieldValue> + * }); + */ + async login(payload: LoginOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [LoginId.screenIdentifier, 'login'], + }; + + const browserCapabilities = await getBrowserCapabilities(); + await new FormHandler(options).submitData<LoginOptions>({ + ...payload, + ...browserCapabilities + }); + } + + /** + * @example + * import LoginId from "@auth0/auth0-acul-js/login-id"; + * const loginIdManager = new LoginId(); + * + * // Check if alternateConnections is available and has at least one item + * if (!loginIdManager.transaction.alternateConnections) { + * console.error('No alternate connections available.'); + * } + * + * // Select the first available connection (users can select any available connection) + * const selectedConnection = alternateConnections[0]; + * + * // Log the chosen connection for debugging or informational purposes + * console.log(`Selected connection: ${selectedConnection.name}`); + * + * // Proceed with federated login using the selected connection + * loginIdManager.federatedLogin({ + * connection: selectedConnection.name, + * }); + */ + async federatedLogin(payload: FederatedLoginOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [LoginId.screenIdentifier, 'federatedLogin'], + }; + + await new FormHandler(options).submitData<FederatedLoginOptions>(payload); + } + + /** + * @example + * import LoginId from "@auth0/auth0-acul-js/login-id"; + * const loginIdManager = new LoginId(); + * + * // It internally maps users available passkey config provided from auth0 server + * loginIdManager.passkeyLogin(); + */ + async passkeyLogin(payload?: CustomOptions): Promise<void> { + this.#passkeyController?.abort(); + this.#passkeyController = undefined; + + const publicKey = this.screen.publicKey; + if (!publicKey) throw new Error(Errors.PASSKEY_DATA_UNAVAILABLE); + + try { + const passkey = await getPasskeyCredentials(publicKey); + const options: FormOptions = { + state: this.transaction.state, + telemetry: [LoginId.screenIdentifier, 'passkeyLogin'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + passkey: JSON.stringify(passkey), + }); + } catch (err) { + if (err instanceof DOMException && err.name === 'NotAllowedError') { + // User cancelled or timed out the prompt + if (this.#isConditionalUIRegistered) { + try { + await this.registerPasskeyAutofill(); + } catch (e) { + console.warn('Conditional UI restart failed', e); + } + } + return; + } + throw err; // rethrow only unexpected errors + } + } + + /** + * @example + * import LoginId from "@auth0/auth0-acul-js/login-id"; + * const loginIdManager = new LoginId(); + * + * loginIdManager.pickCountryCode(); + */ + async pickCountryCode(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [LoginId.screenIdentifier, 'pickCountryCode'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_COUNTRY_CODE, + }); + } + + /** + * Gets the active identifier types for the login screen + * @returns An array of active identifier types or null if none are active + * @example + * ```typescript + * import LoginId from "@auth0/auth0-acul-js/login"; + * const loginIdManager = new LoginId(); + * loginIdManager.getLoginIdentifiers(); + * ``` + * @utilityFeature + */ + getLoginIdentifiers(): IdentifierType[] | null{ + return _getLoginIdentifiers(this.transaction.allowedIdentifiers); + } + + /** + * Registers the browser's Conditional UI for passkeys (autocomplete experience). + * + * This method initializes a passive WebAuthn credential request using + * `navigator.credentials.get()` with `mediation: "conditional"`. When supported, + * this allows the browser to display stored passkeys directly within the username + * field’s autocomplete dropdown. + * + * Call this **once** when the login screen is initialized (for example, on page load). + * After registration, focusing the username input will automatically display + * matching passkeys as suggestions. Selecting a passkey completes authentication + * without requiring additional user interaction. + * + * --- + * ### Input configuration + * If an `inputId` is provided, the SDK will: + * - Validate that the element exists and is an `<input>`. + * - Overwrite its `autocomplete` attribute with `"webauthn username"`. + * + * This ensures full compatibility with the Conditional Mediation API. + * + * If you do **not** provide an `inputId`, you are responsible for configuring + * the input element manually with the correct attributes: + * + * ```html + * <input id="username" autocomplete="webauthn username" /> + * ``` + * + * --- + * ### Gotchas + * - The `autocomplete` attribute **must exactly** contain `"webauthn username"`. + * Including unrelated tokens such as `"email"` or `"text"` will prevent browsers + * from showing the passkey dropdown. + * - Overwriting the attribute is intentional and required for consistent behavior + * across browsers. Do not rely on merging or extending existing autocomplete values. + * - If Conditional Mediation is not supported by the browser, the SDK will safely no-op. + * + * --- + * @param inputId - Optional ID of the username `<input>` element (without `#`). Example: `"username"`. + * If omitted, the developer must manually ensure the correct `autocomplete` attributes. + * + * @example + * ```ts + * import LoginId from '@auth0/auth0-acul-js/login-id'; + * + * // Example: initializing passkey autocomplete inside an async setup block. + * async function initializeLogin() { + * const loginId = new LoginId(); + * // Make sure associated HTML input exists: + * // <input id="username" autocomplete="webauthn username" /> + * // Conditional UI registration. + * await loginId.registerPasskeyAutofill('username'); + * } + * + * initializeLogin().catch(console.error); + * ``` + * + * @remarks + * This method delegates to the internal `registerPasskeyAutofill()` utility, + * returning a background `AbortController` to manage request lifetime. It should + * only be invoked once per page lifecycle. + * + * @category Passkeys + * @utilityFeature + */ + async registerPasskeyAutofill(inputId?: string): Promise<void> { + const publicKey = this.screen.publicKey; + if (!publicKey) throw new Error(Errors.PASSKEY_DATA_UNAVAILABLE); + + this.#passkeyController = await registerPasskeyAutofill({ + publicKey, + inputId, + onResolve: async (cred) => { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [LoginId.screenIdentifier, 'passkeyAutocomplete'], + }; + await new FormHandler(options).submitData({ + passkey: JSON.stringify(cred), + }); + }, + onReject: (err) => { + console.warn('Passkey autocomplete registration failed', err); + throw new SDKUsageError(Errors.PASSKEY_AUTOCOMPLETE_REGISTRATION_FAILED); + }, + }) ?? undefined; + + this.#isConditionalUIRegistered = true; + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers) + +## Constructors + +<ParamField body="LoginId" type="Constructor"> +{/*> **new LoginId**(): `LoginId`*/} + +Defined in: [src/screens/login-id/index.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L36) + +Creates an instance of LoginIdManager. + +#### Returns + +`LoginId` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId">ScreenMembersOnLoginId</a></span>}> +{/*> **screen**: [`ScreenMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId)*/} + +Defined in: [src/screens/login-id/index.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L30) + +#### Implementation of + +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId">TransactionMembersOnLoginId</a></span>}> +{/*> **transaction**: [`TransactionMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId)*/} + +Defined in: [src/screens/login-id/index.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L31) + +#### Implementation of + +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.md#transaction) + +#### Overrides + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGIN_ID`*/} + +Defined in: [src/screens/login-id/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L27) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +### Other + +<ParamField body='federatedLogin' type='Promise<void>'> +{/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login-id/index.ts:92](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L92) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions">FederatedLoginOptions</a></span>}> +[`FederatedLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions) +</ParamField> +</Expandable> + +##### Returns + +`Promise`\<`void`\> + +##### Example + +```ts +import LoginId from "@auth0/auth0-acul-js/login-id"; +const loginIdManager = new LoginId(); + +// Check if alternateConnections is available and has at least one item +if (!loginIdManager.transaction.alternateConnections) { + console.error('No alternate connections available.'); +} + +// Select the first available connection (users can select any available connection) +const selectedConnection = alternateConnections[0]; + +// Log the chosen connection for debugging or informational purposes +console.log(`Selected connection: ${selectedConnection.name}`); + +// Proceed with federated login using the selected connection +loginIdManager.federatedLogin({ + connection: selectedConnection.name, +}); +``` + +##### Implementation of + +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers).[`federatedLogin`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.md#federatedlogin) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +##### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +##### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='getLoginIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType">ScreenIdentifierType</a>[]</span>}> +{/*> **getLoginIdentifiers**(): [`ScreenIdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType)[] \| `null`*/} + +Defined in: [src/screens/login-id/index.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L173) + +**`Utility Feature`** + +Gets the active identifier types for the login screen + +##### Returns + +[`ScreenIdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType)[] \| `null` + +An array of active identifier types or null if none are active + +##### Example + +```typescript +import LoginId from "@auth0/auth0-acul-js/login"; +const loginIdManager = new LoginId(); +loginIdManager.getLoginIdentifiers(); +``` + +##### Implementation of + +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers).[`getLoginIdentifiers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.md#getloginidentifiers) + +</ParamField> + +<ParamField body='login' type='Promise<void>'> +{/*> **login**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login-id/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L58) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions">LoginOptions</a></span>}> +[`LoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions) +</ParamField> +</Expandable> + +##### Returns + +`Promise`\<`void`\> + +##### Example + +```ts +import LoginId from "@auth0/auth0-acul-js/login-id"; + +const loginIdManager = new LoginId(); + +loginIdManager.login({ + username: <usernameFieldValue> +}); +``` + +##### Implementation of + +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers).[`login`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.md#login) + +</ParamField> + +<ParamField body='passkeyLogin' type='Promise<void>'> +{/*> **passkeyLogin**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login-id/index.ts:109](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L109) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +##### Returns + +`Promise`\<`void`\> + +##### Example + +```ts +import LoginId from "@auth0/auth0-acul-js/login-id"; +const loginIdManager = new LoginId(); + +// It internally maps users available passkey config provided from auth0 server +loginIdManager.passkeyLogin(); +``` + +##### Implementation of + +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers).[`passkeyLogin`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.md#passkeylogin) + +</ParamField> + +<ParamField body='pickCountryCode' type='Promise<void>'> +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login-id/index.ts:150](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L150) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +##### Returns + +`Promise`\<`void`\> + +##### Example + +```ts +import LoginId from "@auth0/auth0-acul-js/login-id"; +const loginIdManager = new LoginId(); + +loginIdManager.pickCountryCode(); +``` + +##### Implementation of + +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers).[`pickCountryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.md#pickcountrycode) + +### Passkeys + +</ParamField> +<ParamField body='registerPasskeyAutofill' type='Promise<void>'> +{/*> **registerPasskeyAutofill**(`inputId?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login-id/index.ts:242](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L242) + +**`Utility Feature`** + +Registers the browser's Conditional UI for passkeys (autocomplete experience). + +This method initializes a passive WebAuthn credential request using +`navigator.credentials.get()` with `mediation: "conditional"`. When supported, +this allows the browser to display stored passkeys directly within the username +field’s autocomplete dropdown. + +Call this **once** when the login screen is initialized (for example, on page load). +After registration, focusing the username input will automatically display +matching passkeys as suggestions. Selecting a passkey completes authentication +without requiring additional user interaction. + +--- +### Input configuration +If an `inputId` is provided, the SDK will: +- Validate that the element exists and is an `<input>`. +- Overwrite its `autocomplete` attribute with `"webauthn username"`. + +This ensures full compatibility with the Conditional Mediation API. + +If you do **not** provide an `inputId`, you are responsible for configuring +the input element manually with the correct attributes: + +```html +<input id="username" autocomplete="webauthn username" /> +``` + +--- +### Gotchas +- The `autocomplete` attribute **must exactly** contain `"webauthn username"`. + Including unrelated tokens such as `"email"` or `"text"` will prevent browsers + from showing the passkey dropdown. +- Overwriting the attribute is intentional and required for consistent behavior + across browsers. Do not rely on merging or extending existing autocomplete values. +- If Conditional Mediation is not supported by the browser, the SDK will safely no-op. + +--- + +<Expandable title="Parameters"> +<ParamField body='inputId?' type='string'> +`string` + +Optional ID of the username `<input>` element (without `#`). Example: `"username"`. +If omitted, the developer must manually ensure the correct `autocomplete` attributes. +</ParamField> +</Expandable> + +##### Returns + +`Promise`\<`void`\> + +##### Example + +```ts +import LoginId from '@auth0/auth0-acul-js/login-id'; + +// Example: initializing passkey autocomplete inside an async setup block. +async function initializeLogin() { + const loginId = new LoginId(); + // Make sure associated HTML input exists: + // <input id="username" autocomplete="webauthn username" /> + // Conditional UI registration. + await loginId.registerPasskeyAutofill('username'); +} + +initializeLogin().catch(console.error); +``` + +##### Remarks + +This method delegates to the internal `registerPasskeyAutofill()` utility, +returning a background `AbortController` to manage request lifetime. It should +only be invoked once per page lifecycle. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPassword.mdx new file mode 100644 index 000000000..32433d2c5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPassword.mdx @@ -0,0 +1,348 @@ +--- +title: "LoginPassword" +--- + +Defined in: [src/screens/login-password/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-password/index.ts#L20) + + +<RequestExample> +```ts +export default class LoginPassword extends BaseContext implements LoginPasswordMembers { + static screenIdentifier: string = ScreenIds.LOGIN_PASSWORD; + screen: ScreenOptions; + transaction: TransactionOptions; + + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + const transactionContext = this.getContext('transaction') as TransactionContext; + + this.screen = new ScreenOverride(screenContext); + this.transaction = new TransactionOverride(transactionContext); + } + /** + * @remarks + * This methods handles login-password related configuration. + * + * @example + * import LoginPassword from "@auth0/auth0-acul-js/login-password"; + * + * const loginPasswordManager = new LoginPassword(); + * loginPasswordManager.login({ + * username: "testUser", + * password: "******" + * }); + */ + async login(payload: LoginPasswordOptions): Promise<void> { + const options: FormOptions = { state: this.transaction.state, telemetry: [LoginPassword.screenIdentifier, 'login'] }; + const browserCapabilities = await getBrowserCapabilities(); + await new FormHandler(options).submitData<LoginPasswordOptions>({ + ...payload, + ...browserCapabilities, + }); + } + + /** + * @example + * import LoginPassword from "@auth0/auth0-acul-js/login-id"; + * const loginIdManager = new LoginPassword(); + * + * // Check if alternateConnections is available and has at least one item + * if (!loginIdManager.transaction.alternateConnections) { + * console.error('No alternate connections available.'); + * } + * + * // Select the first available connection (users can select any available connection) + * const selectedConnection = alternateConnections[0]; + * + * // Log the chosen connection for debugging or informational purposes + * console.log(`Selected connection: ${selectedConnection.name}`); + * + * // Proceed with federated login using the selected connection + * loginIdManager.federatedLogin({ + * connection: selectedConnection.name, + * }); + */ + async federatedLogin(payload: FederatedLoginOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [LoginPassword.screenIdentifier, 'federatedLogin'], + }; + + await new FormHandler(options).submitData<FederatedLoginOptions>(payload); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers) + +## Constructors + +<ParamField body="LoginPassword" type="Constructor"> +{/*> **new LoginPassword**(): `LoginPassword`*/} + +Defined in: [src/screens/login-password/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-password/index.ts#L25) + +#### Returns + +`LoginPassword` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword">ScreenMembersOnLoginPassword</a></span>}> +{/*> **screen**: [`ScreenMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword)*/} + +Defined in: [src/screens/login-password/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-password/index.ts#L22) + +#### Implementation of + +[`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword">TransactionMembersOnLoginPassword</a></span>}> +{/*> **transaction**: [`TransactionMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword)*/} + +Defined in: [src/screens/login-password/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-password/index.ts#L23) + +#### Implementation of + +[`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.md#transaction) + +#### Overrides + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGIN_PASSWORD`*/} + +Defined in: [src/screens/login-password/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-password/index.ts#L21) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='federatedLogin' type='Promise<void>'> +{/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login-password/index.ts:76](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-password/index.ts#L76) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions">FederatedLoginPasswordOptions</a></span>}> +[`FederatedLoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import LoginPassword from "@auth0/auth0-acul-js/login-id"; +const loginIdManager = new LoginPassword(); + +// Check if alternateConnections is available and has at least one item +if (!loginIdManager.transaction.alternateConnections) { + console.error('No alternate connections available.'); +} + +// Select the first available connection (users can select any available connection) +const selectedConnection = alternateConnections[0]; + +// Log the chosen connection for debugging or informational purposes +console.log(`Selected connection: ${selectedConnection.name}`); + +// Proceed with federated login using the selected connection +loginIdManager.federatedLogin({ + connection: selectedConnection.name, +}); +``` + +#### Implementation of + +[`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers).[`federatedLogin`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.md#federatedlogin) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='login' type='Promise<void>'> +{/*> **login**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login-password/index.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-password/index.ts#L46) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions">LoginPasswordOptions</a></span>}> +[`LoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Remarks + +This methods handles login-password related configuration. + +#### Example + +```ts +import LoginPassword from "@auth0/auth0-acul-js/login-password"; + +const loginPasswordManager = new LoginPassword(); +loginPasswordManager.login({ + username: "testUser", + password: "******" +}); +``` + +#### Implementation of + +[`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers).[`login`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.md#login) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx new file mode 100644 index 000000000..716798ac2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx @@ -0,0 +1,402 @@ +--- +title: "LoginPasswordlessEmailCode" +--- + +Defined in: [src/screens/login-passwordless-email-code/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L21) + + +<RequestExample> +```ts +export default class LoginPasswordlessEmailCode extends BaseContext implements LoginPasswordlessEmailCodeMembers { + static screenIdentifier: string = ScreenIds.LOGIN_PASSWORDLESS_EMAIL_CODE; + screen: ScreenOptions; + transaction: TransactionOptions; + + constructor() { + super(); + + const screenContext = this.getContext('screen') as ScreenContext; + const transactionContext = this.getContext('transaction') as TransactionContext; + + this.screen = new ScreenOverride(screenContext); + this.transaction = new TransactionOverride(transactionContext); + } + + /** + * @example + * //Creates an instance of LoginPasswordlessEmailCode and calls the method with sample data. + * import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code'; + * + * //Method to continue the login process using email and code. + * const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode(); + * loginPasswordlessEmailCode.submitCode({ + * email: "test@domain.com"; + * code: "<string>"; + * }); + */ + async submitCode(payload: SubmitCodeOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [LoginPasswordlessEmailCode.screenIdentifier, 'submitCode'], + }; + + await new FormHandler(options).submitData<SubmitCodeOptions>(payload); + } + + /** + * @example + * import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code'; + * + * const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode(); + * loginPasswordlessEmailCode.resendCode(); + */ + async resendCode(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [LoginPasswordlessEmailCode.screenIdentifier, 'resendCode'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND }); + } + + /** + * Creates a resend control manager for handling email code resend operations. + * + * @param options Configuration options for the resend control + * @returns A ResendControl object with resend functionality and state management + * @utilityFeature + * + * @example + * ```typescript + * import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code'; + * + * const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode(); + * const { startResend } = loginPasswordlessEmailCode.resendManager({ + * timeoutSeconds: 60, + * onStatusChange: (remainingSeconds, isDisabled) => { + * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + * }, + * onTimeout: () => { + * console.log('Resend is now available'); + * } + * }); + * + * // Call startResend when user clicks resend button + * startResend(); + * ``` + */ + resendManager(options?: StartResendOptions): ResendControl { + return createResendControl( + LoginPasswordlessEmailCode.screenIdentifier, + () => this.resendCode(), + options + ); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers) + +## Constructors + +<ParamField body="LoginPasswordlessEmailCode" type="Constructor"> +{/*> **new LoginPasswordlessEmailCode**(): `LoginPasswordlessEmailCode`*/} + +Defined in: [src/screens/login-passwordless-email-code/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L26) + +#### Returns + +`LoginPasswordlessEmailCode` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode">ScreenMembersOnLoginPasswordlessEmailCode</a></span>}> +{/*> **screen**: [`ScreenMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode)*/} + +Defined in: [src/screens/login-passwordless-email-code/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L23) + +#### Implementation of + +[`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode">TransactionMembersOnLoginPasswordlessEmailCode</a></span>}> +{/*> **transaction**: [`TransactionMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode)*/} + +Defined in: [src/screens/login-passwordless-email-code/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L24) + +#### Implementation of + +[`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.md#transaction) + +#### Overrides + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGIN_PASSWORDLESS_EMAIL_CODE`*/} + +Defined in: [src/screens/login-passwordless-email-code/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L22) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login-passwordless-email-code/index.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L64) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code'; + +const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode(); +loginPasswordlessEmailCode.resendCode(); +``` + +#### Implementation of + +[`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers).[`resendCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.md#resendcode) + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [src/screens/login-passwordless-email-code/index.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L99) + +**`Utility Feature`** + +Creates a resend control manager for handling email code resend operations. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for the resend control +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +A ResendControl object with resend functionality and state management + +#### Example + +```typescript +import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code'; + +const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode(); +const { startResend } = loginPasswordlessEmailCode.resendManager({ + timeoutSeconds: 60, + onStatusChange: (remainingSeconds, isDisabled) => { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + }, + onTimeout: () => { + console.log('Resend is now available'); + } +}); + +// Call startResend when user clicks resend button +startResend(); +``` + +#### Implementation of + +[`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers).[`resendManager`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.md#resendmanager) + +</ParamField> + +<ParamField body='submitCode' type='Promise<void>'> +{/*> **submitCode**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login-passwordless-email-code/index.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L48) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions">SubmitCodeOptions</a></span>}> +[`SubmitCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +//Creates an instance of LoginPasswordlessEmailCode and calls the method with sample data. +import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code'; + +//Method to continue the login process using email and code. +const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode(); +loginPasswordlessEmailCode.submitCode({ + email: "test@domain.com"; + code: "<string>"; +}); +``` + +#### Implementation of + +[`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers).[`submitCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.md#submitcode) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessSmsOtp.mdx new file mode 100644 index 000000000..1ed3e38d3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessSmsOtp.mdx @@ -0,0 +1,399 @@ +--- +title: "LoginPasswordlessSmsOtp" +--- + +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L21) + + +<RequestExample> +```ts +export default class LoginPasswordlessSmsOtp extends BaseContext implements LoginPasswordlessSmsOtpMembers { + static screenIdentifier: string = ScreenIds.LOGIN_PASSWORDLESS_SMS_OTP; + screen: ScreenOptions; + transaction: TransactionOptions; + + constructor() { + super(); + + const screenContext = this.getContext('screen') as ScreenContext; + const transactionContext = this.getContext('transaction') as TransactionContext; + + this.screen = new ScreenOverride(screenContext); + this.transaction = new TransactionOverride(transactionContext); + } + + /** + * @example + * import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; + * const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); + * + * loginPasswordlessSmsOtp.submitOTP({ + * username: "test@domain.com"; + * code: "<string>"; + * }); + */ + async submitOTP(payload: SubmitOTPOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [LoginPasswordlessSmsOtp.screenIdentifier, 'submitOTP'], + }; + await new FormHandler(options).submitData<SubmitOTPOptions>({ ...payload, action: FormActions.DEFAULT }); + } + + /** + * @example + * import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; + * + * const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); + * loginPasswordlessSmsOtp.resendOTP(); + */ + async resendOTP(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [LoginPasswordlessSmsOtp.screenIdentifier, 'resendOTP'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND }); + } + + /** + * Gets resend functionality with timeout management for this screen + * @param options - Configuration options for resend functionality + * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) + * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) + * @param options.onTimeout - Callback to execute when timeout countdown reaches zero + * @returns ResendControl object with startResend method + * @utilityFeature + * + * @example + * ```typescript + * import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; + * + * const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); + * const { startResend } = loginPasswordlessSmsOtp.resendManager({ + * timeoutSeconds: 15, + * onStatusChange: (remainingSeconds, isDisabled) => { + * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + * }, + * onTimeout: () => { + * console.log('Resend is now available'); + * } + * }); + * + * // Call startResend when user clicks resend button + * startResend(); + * ``` + */ + resendManager(options?: StartResendOptions): ResendControl { + return createResendControl( + LoginPasswordlessSmsOtp.screenIdentifier, + () => this.resendOTP(), + options + ); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers) + +## Constructors + +<ParamField body="LoginPasswordlessSmsOtp" type="Constructor"> +{/*> **new LoginPasswordlessSmsOtp**(): `LoginPasswordlessSmsOtp`*/} + +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L26) + +#### Returns + +`LoginPasswordlessSmsOtp` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp">ScreenMembersOnLoginPasswordlessSmsOtp</a></span>}> +{/*> **screen**: [`ScreenMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp)*/} + +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L23) + +#### Implementation of + +[`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp">TransactionMembersOnLoginPasswordlessSmsOtp</a></span>}> +{/*> **transaction**: [`TransactionMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp)*/} + +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L24) + +#### Implementation of + +[`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.md#transaction) + +#### Overrides + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGIN_PASSWORDLESS_SMS_OTP`*/} + +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L22) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:98](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L98) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +#### Example + +```typescript +import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; + +const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); +const { startResend } = loginPasswordlessSmsOtp.resendManager({ + timeoutSeconds: 15, + onStatusChange: (remainingSeconds, isDisabled) => { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + }, + onTimeout: () => { + console.log('Resend is now available'); + } +}); + +// Call startResend when user clicks resend button +startResend(); +``` + +#### Implementation of + +[`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers).[`resendManager`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.md#resendmanager) + +</ParamField> + +<ParamField body='resendOTP' type='Promise<void>'> +{/*> **resendOTP**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L61) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; + +const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); +loginPasswordlessSmsOtp.resendOTP(); +``` + +#### Implementation of + +[`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers).[`resendOTP`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.md#resendotp) + +</ParamField> + +<ParamField body='submitOTP' type='Promise<void>'> +{/*> **submitOTP**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L46) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions">SubmitOTPOptions</a></span>}> +[`SubmitOTPOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; +const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); + +loginPasswordlessSmsOtp.submitOTP({ + username: "test@domain.com"; + code: "<string>"; +}); +``` + +#### Implementation of + +[`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers).[`submitOTP`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.md#submitotp) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Logout.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Logout.mdx new file mode 100644 index 000000000..746b6b6bb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Logout.mdx @@ -0,0 +1,276 @@ +--- +title: "Logout" +--- + +Defined in: [src/screens/logout/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout/index.ts#L15) + +Class implementing the logout screen functionality. +This screen allows users to confirm or deny the logout action. + + +<RequestExample> +```ts +export default class Logout extends BaseContext implements LogoutMembers { + static screenIdentifier: string = ScreenIds.LOGOUT; + + /** + * Creates an instance of the Logout screen manager. + */ + constructor() { + super(); + } + + /** + * Confirms the logout action (accept or deny). + * @param payload The options containing the action to perform. + * @example + * ```typescript + * import Logout from '@auth0/auth0-acul-js/logout'; + * + * const logout = new Logout(); + * + * await logout.confirmLogout({ action: 'accept' }); + * ``` + */ + async confirmLogout(payload: ConfirmLogoutOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [Logout.screenIdentifier, 'confirmLogout'], + }; + + await new FormHandler(options).submitData<ConfirmLogoutOptions>({ + ...payload, + action: payload.action, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers) + +## Constructors + +<ParamField body="Logout" type="Constructor"> +{/*> **new Logout**(): `Logout`*/} + +Defined in: [src/screens/logout/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout/index.ts#L21) + +Creates an instance of the Logout screen manager. + +#### Returns + +`Logout` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGOUT`*/} + +Defined in: [src/screens/logout/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout/index.ts#L16) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='confirmLogout' type='Promise<void>'> +{/*> **confirmLogout**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/logout/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout/index.ts#L37) + +Confirms the logout action (accept or deny). + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions">ConfirmLogoutOptions</a></span>}> +[`ConfirmLogoutOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions) + +The options containing the action to perform. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import Logout from '@auth0/auth0-acul-js/logout'; + +const logout = new Logout(); + +await logout.confirmLogout({ action: 'accept' }); +``` + +#### Implementation of + +[`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers).[`confirmLogout`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.md#confirmlogout) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutAborted.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutAborted.mdx new file mode 100644 index 000000000..26940ccac --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutAborted.mdx @@ -0,0 +1,217 @@ +--- +title: "LogoutAborted" +--- + +Defined in: [src/screens/logout-aborted/index.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout-aborted/index.ts#L10) + +Class implementing the logout-aborted screen functionality +This screen is displayed when a user aborts the logout process. + + +<RequestExample> +```ts +export default class LogoutAborted extends BaseContext implements LogoutAbortedMembers { + static screenIdentifier: string = ScreenIds.LOGOUT_ABORTED; + + /** + * Creates an instance of LogoutAborted screen manager + */ + constructor() { + super(); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers) + +## Constructors + +<ParamField body="LogoutAborted" type="Constructor"> +{/*> **new LogoutAborted**(): `LogoutAborted`*/} + +Defined in: [src/screens/logout-aborted/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout-aborted/index.ts#L16) + +Creates an instance of LogoutAborted screen manager + +#### Returns + +`LogoutAborted` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGOUT_ABORTED`*/} + +Defined in: [src/screens/logout-aborted/index.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout-aborted/index.ts#L11) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutComplete.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutComplete.mdx new file mode 100644 index 000000000..374df1bdc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutComplete.mdx @@ -0,0 +1,217 @@ +--- +title: "LogoutComplete" +--- + +Defined in: [src/screens/logout-complete/index.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout-complete/index.ts#L10) + +Class implementing the logout-complete screen functionality +This screen is displayed when a user aborts the logout process. + + +<RequestExample> +```ts +export default class LogoutComplete extends BaseContext implements LogoutCompleteMembers { + static screenIdentifier: string = ScreenIds.LOGOUT_COMPLETE; + + /** + * Creates an instance of LogoutComplete screen manager + */ + constructor() { + super(); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers) + +## Constructors + +<ParamField body="LogoutComplete" type="Constructor"> +{/*> **new LogoutComplete**(): `LogoutComplete`*/} + +Defined in: [src/screens/logout-complete/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout-complete/index.ts#L16) + +Creates an instance of LogoutComplete screen manager + +#### Returns + +`LogoutComplete` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGOUT_COMPLETE`*/} + +Defined in: [src/screens/logout-complete/index.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout-complete/index.ts#L11) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaBeginEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaBeginEnrollOptions.mdx new file mode 100644 index 000000000..bf01fb0c4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaBeginEnrollOptions.mdx @@ -0,0 +1,269 @@ +--- +title: "MfaBeginEnrollOptions" +--- + +Defined in: [src/screens/mfa-begin-enroll-options/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-begin-enroll-options/index.ts#L12) + +MFA Begin Enroll Options screen implementation class +Handles the selection and enrollment of MFA factors + + +<RequestExample> +```ts +export default class MfaBeginEnrollOptions extends BaseContext implements MfaBeginEnrollOptionsMembers { + static screenIdentifier: string = ScreenIds.MFA_BEGIN_ENROLL_OPTIONS; + /** + * Creates an instance of MFA Begin Enroll Options screen manager + */ + constructor() { + super(); + } + + /** + * Continues the enrollment process with the selected factor + * @param payload The enrollment options including the selected factor + * @example + * ```typescript + * const mfaBeginEnrollOptions = new MfaBeginEnrollOptions(); + * await mfaBeginEnrollOptions.enroll({ + * action: 'push-notification' + * }); + * ``` + */ + async enroll(payload: MfaEnrollOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaBeginEnrollOptions.screenIdentifier, 'enroll'], + }; + await new FormHandler(options).submitData<MfaEnrollOptions>(payload); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers) + +## Constructors + +<ParamField body="MfaBeginEnrollOptions" type="Constructor"> +{/*> **new MfaBeginEnrollOptions**(): `MfaBeginEnrollOptions`*/} + +Defined in: [src/screens/mfa-begin-enroll-options/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-begin-enroll-options/index.ts#L17) + +Creates an instance of MFA Begin Enroll Options screen manager + +#### Returns + +`MfaBeginEnrollOptions` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_BEGIN_ENROLL_OPTIONS`*/} + +Defined in: [src/screens/mfa-begin-enroll-options/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-begin-enroll-options/index.ts#L13) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='enroll' type='Promise<void>'> +{/*> **enroll**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-begin-enroll-options/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-begin-enroll-options/index.ts#L32) + +Continues the enrollment process with the selected factor + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions">MfaEnrollOptions</a></span>}> +[`MfaEnrollOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions) + +The enrollment options including the selected factor +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +const mfaBeginEnrollOptions = new MfaBeginEnrollOptions(); +await mfaBeginEnrollOptions.enroll({ + action: 'push-notification' +}); +``` + +#### Implementation of + +[`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers).[`enroll`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.md#enroll) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaCountryCodes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaCountryCodes.mdx new file mode 100644 index 000000000..1511830dd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaCountryCodes.mdx @@ -0,0 +1,352 @@ +--- +title: "MfaCountryCodes" +--- + +Defined in: [src/screens/mfa-country-codes/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L20) + +Class implementing the mfa-country-codes screen functionality +This screen allows users to select a country code for MFA phone number verification + + +<RequestExample> +```ts +export default class MfaCountryCodes extends BaseContext implements MfaCountryCodesMembers { + static screenIdentifier: string = ScreenIds.MFA_COUNTRY_CODES; + screen: ScreenOptions; + + /** + * Creates an instance of MfaCountryCodes screen manager + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Selects a country code from the available options + * @param payload The options containing the country code selection action + * @example + * ```typescript + * import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes'; + * + * const mfaCountryCodes = new MfaCountryCodes(); + * + * // Get the available country codes and phone prefixes + * const { screen } = mfaCountryCodes; + * const { phone_prefixes } = screen.data + * const {country_code, phone_prefix} = phone_prefixes[0] + * + * await mfaCountryCodes.selectCountryCode({ + * country_code: 'US', + * phone_prefix: '+1', + * }); + * ``` + */ + async selectCountryCode(payload: SelectCountryCodeOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaCountryCodes.screenIdentifier, 'selectCountryCode'], + }; + const { country_code, phone_prefix } = payload; + const action = `selection-action::${country_code}${phone_prefix}`; + await new FormHandler(options).submitData<SelectCountryCodeOptions>({ + ...payload, + action, + }); + } + + /** + * Navigates back to the previous screen + * @param payload Optional custom options to include with the request + * @example + * ```typescript + * import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes'; + * + * const mfaCountryCodes = new MfaCountryCodes(); + * await mfaCountryCodes.goBack(); + * ``` + */ + async goBack(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaCountryCodes.screenIdentifier, 'goBack'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.BACK, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers) + +## Constructors + +<ParamField body="MfaCountryCodes" type="Constructor"> +{/*> **new MfaCountryCodes**(): `MfaCountryCodes`*/} + +Defined in: [src/screens/mfa-country-codes/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L27) + +Creates an instance of MfaCountryCodes screen manager + +#### Returns + +`MfaCountryCodes` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes">ScreenMembersOnMfaCountryCodes</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaCountryCodes`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes)*/} + +Defined in: [src/screens/mfa-country-codes/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L22) + +#### Implementation of + +[`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_COUNTRY_CODES`*/} + +Defined in: [src/screens/mfa-country-codes/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L21) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='goBack' type='Promise<void>'> +{/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-country-codes/index.ts:77](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L77) + +Navigates back to the previous screen + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes'; + +const mfaCountryCodes = new MfaCountryCodes(); +await mfaCountryCodes.goBack(); +``` + +#### Implementation of + +[`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers).[`goBack`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.md#goback) + +</ParamField> + +<ParamField body='selectCountryCode' type='Promise<void>'> +{/*> **selectCountryCode**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-country-codes/index.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L53) + +Selects a country code from the available options + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions">SelectCountryCodeOptions</a></span>}> +[`SelectCountryCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions) + +The options containing the country code selection action +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes'; + +const mfaCountryCodes = new MfaCountryCodes(); + +// Get the available country codes and phone prefixes +const { screen } = mfaCountryCodes; +const { phone_prefixes } = screen.data +const {country_code, phone_prefix} = phone_prefixes[0] + +await mfaCountryCodes.selectCountryCode({ + country_code: 'US', + phone_prefix: '+1', +}); +``` + +#### Implementation of + +[`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers).[`selectCountryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.md#selectcountrycode) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaDetectBrowserCapabilities.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaDetectBrowserCapabilities.mdx new file mode 100644 index 000000000..906ceeb81 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaDetectBrowserCapabilities.mdx @@ -0,0 +1,271 @@ +--- +title: "MfaDetectBrowserCapabilities" +--- + +Defined in: [src/screens/mfa-detect-browser-capabilities/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-detect-browser-capabilities/index.ts#L14) + +Class implementing the mfa-detect-browser-capabilities screen functionality +This screen detects browser capabilities for MFA authentication methods + + +<RequestExample> +```ts +export default class MfaDetectBrowserCapabilities extends BaseContext implements MfaDetectBrowserCapabilitiesMembers { + static screenIdentifier: string = ScreenIds.MFA_DETECT_BROWSER_CAPABILITIES; + + /** + * Creates an instance of MfaDetectBrowserCapabilities screen manager + */ + constructor() { + super(); + } + + /** + * Picks an authenticator based on browser capabilities + * @param payload The options containing browser capability flags + * @example + * ```typescript + * const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); + * await mfaDetectBrowserCapabilities.detectCapabilities(); + * ``` + */ + async detectCapabilities(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaDetectBrowserCapabilities.screenIdentifier, 'detectCapabilities'], + }; + const browserCapabilities = await getBrowserCapabilities() + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + ...browserCapabilities, + action: 'pick-authenticator', + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers) + +## Constructors + +<ParamField body="MfaDetectBrowserCapabilities" type="Constructor"> +{/*> **new MfaDetectBrowserCapabilities**(): `MfaDetectBrowserCapabilities`*/} + +Defined in: [src/screens/mfa-detect-browser-capabilities/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-detect-browser-capabilities/index.ts#L20) + +Creates an instance of MfaDetectBrowserCapabilities screen manager + +#### Returns + +`MfaDetectBrowserCapabilities` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_DETECT_BROWSER_CAPABILITIES`*/} + +Defined in: [src/screens/mfa-detect-browser-capabilities/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-detect-browser-capabilities/index.ts#L15) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='detectCapabilities' type='Promise<void>'> +{/*> **detectCapabilities**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-detect-browser-capabilities/index.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-detect-browser-capabilities/index.ts#L33) + +Picks an authenticator based on browser capabilities + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +The options containing browser capability flags +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); +await mfaDetectBrowserCapabilities.detectCapabilities(); +``` + +#### Implementation of + +[`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers).[`detectCapabilities`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.md#detectcapabilities) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailChallenge.mdx new file mode 100644 index 000000000..c83d47710 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailChallenge.mdx @@ -0,0 +1,538 @@ +--- +title: "MfaEmailChallenge" +--- + +Defined in: [src/screens/mfa-email-challenge/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L27) + +Class implementing the mfa-email-challenge screen functionality +This screen is shown when a user needs to verify their email during MFA + + +<RequestExample> +```ts +export default class MfaEmailChallenge extends BaseContext implements MfaEmailChallengeMembers { + static screenIdentifier: string = ScreenIds.MFA_EMAIL_CHALLENGE; + screen: ScreenOptions; + untrustedData: UntrustedDataOptions; + + /** + * Creates an instance of MfaEmailChallenge screen manager + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + const untrustedDataContext = this.getContext('untrusted_data') as UntrustedDataContext; + this.screen = new ScreenOverride(screenContext); + this.untrustedData = new UntrustedDataOverride(untrustedDataContext); + } + + /** + * Continues with the email challenge using the provided code + * @param payload The options containing the code and rememberDevice flag + * @example + * ```typescript + * import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + * + * const mfaEmailChallenge = new MfaEmailChallenge(); + * await mfaEmailChallenge.continue({ + * code: '123456', + * rememberDevice: true + * }); + * ``` + */ + async continue(payload: ContinueOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaEmailChallenge.screenIdentifier, 'continue'], + }; + const { rememberDevice = false, ...restPayload } = payload || {}; + const submitPayload: Record<string, string | number | boolean> = { ...restPayload, action: FormActions.DEFAULT }; + if (rememberDevice) { + submitPayload.rememberBrowser = true; + } + await new FormHandler(options).submitData(submitPayload); + } + + /** + * Resends the email code + * @param payload Optional custom options to include with the request + * @example + * ```typescript + * import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + * + * const mfaEmailChallenge = new MfaEmailChallenge(); + * await mfaEmailChallenge.resendCode(); + * ``` + */ + async resendCode(payload?: ResendCodeOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaEmailChallenge.screenIdentifier, 'resendCode'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.RESEND_CODE, + }); + } + + /** + * Allows the user to try another MFA method + * @param payload Optional custom options to include with the request + * @example + * ```typescript + * import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + * + * const mfaEmailChallenge = new MfaEmailChallenge(); + * await mfaEmailChallenge.tryAnotherMethod(); + * ``` + */ + async tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaEmailChallenge.screenIdentifier, 'tryAnotherMethod'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } + + /** + * Submits the action to pick a different Email configuration, if available. + * @param {CustomOptions} [payload] - Optional payload. + * @returns {Promise<void>} + * @example + * ```typescript + * import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + * + * const mfaEmailChallenge = new MfaEmailChallenge(); + * await mfaEmailChallenge.pickEmail(); + * ``` + */ + async pickEmail(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaEmailChallenge.screenIdentifier, 'pickEmail'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.PICK_EMAIL }); + } + + /** + * Gets resend functionality with timeout management for this screen + * @param options - Configuration options for resend functionality + * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) + * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) + * @param options.onTimeout - Callback to execute when timeout countdown reaches zero + * @returns ResendControl object with startResend method + * @utilityFeature + * + * @example + * ```typescript + * import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + * + * const mfaEmailChallenge = new MfaEmailChallenge(); + * const { startResend } = mfaEmailChallenge.resendManager({ + * timeoutSeconds: 15, + * onStatusChange: (remainingSeconds, isDisabled) => { + * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + * }, + * onTimeout: () => { + * console.log('Resend is now available'); + * } + * }); + * + * // Call startResend when user clicks resend button + * startResend(); + * ``` + */ + resendManager(options?: StartResendOptions): ResendControl { + return createResendControl( + MfaEmailChallenge.screenIdentifier, + () => this.resendCode(), + options + ); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers) + +## Constructors + +<ParamField body="MfaEmailChallenge" type="Constructor"> +{/*> **new MfaEmailChallenge**(): `MfaEmailChallenge`*/} + +Defined in: [src/screens/mfa-email-challenge/index.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L35) + +Creates an instance of MfaEmailChallenge screen manager + +#### Returns + +`MfaEmailChallenge` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge">ScreenMembersOnMfaEmailChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge)*/} + +Defined in: [src/screens/mfa-email-challenge/index.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L29) + +#### Implementation of + +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge">UntrustedDataMembersOnMfaEmailChallenge</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge)*/} + +Defined in: [src/screens/mfa-email-challenge/index.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L30) + +#### Implementation of + +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.md#untrusteddata) + +#### Overrides + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_EMAIL_CHALLENGE`*/} + +Defined in: [src/screens/mfa-email-challenge/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L28) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-email-challenge/index.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L57) + +Continues with the email challenge using the provided code + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions">ContinuePayloadOptions</a></span>}> +[`ContinuePayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions) + +The options containing the code and rememberDevice flag +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + +const mfaEmailChallenge = new MfaEmailChallenge(); +await mfaEmailChallenge.continue({ + code: '123456', + rememberDevice: true +}); +``` + +#### Implementation of + +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='pickEmail' type='Promise<void>'> +{/*> **pickEmail**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-email-challenge/index.ts:126](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L126) + +Submits the action to pick a different Email configuration, if available. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + +const mfaEmailChallenge = new MfaEmailChallenge(); +await mfaEmailChallenge.pickEmail(); +``` + +#### Implementation of + +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers).[`pickEmail`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.md#pickemail) + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-email-challenge/index.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L81) + +Resends the email code + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions">ResendCodePayloadOptions</a></span>}> +[`ResendCodePayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + +const mfaEmailChallenge = new MfaEmailChallenge(); +await mfaEmailChallenge.resendCode(); +``` + +#### Implementation of + +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers).[`resendCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.md#resendcode) + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [src/screens/mfa-email-challenge/index.ts:162](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L162) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +#### Example + +```typescript +import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + +const mfaEmailChallenge = new MfaEmailChallenge(); +const { startResend } = mfaEmailChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: (remainingSeconds, isDisabled) => { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + }, + onTimeout: () => { + console.log('Resend is now available'); + } +}); + +// Call startResend when user clicks resend button +startResend(); +``` + +#### Implementation of + +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers).[`resendManager`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.md#resendmanager) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-email-challenge/index.ts:103](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L103) + +Allows the user to try another MFA method + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions">TryAnotherMethodPayloadOptions</a></span>}> +[`TryAnotherMethodPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + +const mfaEmailChallenge = new MfaEmailChallenge(); +await mfaEmailChallenge.tryAnotherMethod(); +``` + +#### Implementation of + +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailList.mdx new file mode 100644 index 000000000..1b48de92f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailList.mdx @@ -0,0 +1,347 @@ +--- +title: "MfaEmailList" +--- + +Defined in: [src/screens/mfa-email-list/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L20) + +Class implementing the mfa-email-list screen functionality +This screen allows users to select an enrolled email address for MFA + + +<RequestExample> +```ts +export default class MfaEmailList extends BaseContext implements MfaEmailListMembers { + static screenIdentifier: string = ScreenIds.MFA_EMAIL_LIST; + /** + * The screen object for the mfa-email-list screen + */ + public screen: ScreenOptions; + + /** + * Creates an instance of MfaEmailList screen manager + */ + + constructor() { + super(); // Calls BaseContext constructor for global context initialization and validation. + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Selects an enrolled email address from the list + * @param payload The options containing the selection action + * @example + * ```typescript + * import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list'; + * + * const mfaEmailList = new MfaEmailList(); + * await mfaEmailList.selectMfaEmail({ + * index: 0 // for demonstration we are selecting the first index + * }); + * ``` + */ + async selectMfaEmail(payload: SelectMfaEmailOptions): Promise<void> { + const index = payload?.index; + if (index === undefined || index < 0 || index >= (this.user?.enrolledEmails?.length ?? 0)) { + throw new Error('Index out of bounds.'); + } + + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaEmailList.screenIdentifier, 'selectMfaEmail'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: `selection-action::${index}`, + }); + } + + /** + * Navigates back to the previous screen + * @param payload Optional custom options to include with the request + * @example + * ```typescript + * import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list'; + * + * const mfaEmailList = new MfaEmailList(); + * await mfaEmailList.goBack(); + * ``` + */ + async goBack(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaEmailList.screenIdentifier, 'goBack'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.BACK, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers) + +## Constructors + +<ParamField body="MfaEmailList" type="Constructor"> +{/*> **new MfaEmailList**(): `MfaEmailList`*/} + +Defined in: [src/screens/mfa-email-list/index.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L31) + +Creates an instance of MfaEmailList screen manager + +#### Returns + +`MfaEmailList` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList">ScreenMembersOnMfaEmailList</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaEmailList`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList)*/} + +Defined in: [src/screens/mfa-email-list/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L25) + +The screen object for the mfa-email-list screen + +#### Implementation of + +[`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_EMAIL_LIST`*/} + +Defined in: [src/screens/mfa-email-list/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L21) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='goBack' type='Promise<void>'> +{/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-email-list/index.ts:77](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L77) + +Navigates back to the previous screen + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list'; + +const mfaEmailList = new MfaEmailList(); +await mfaEmailList.goBack(); +``` + +#### Implementation of + +[`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers).[`goBack`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.md#goback) + +</ParamField> + +<ParamField body='selectMfaEmail' type='Promise<void>'> +{/*> **selectMfaEmail**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-email-list/index.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L50) + +Selects an enrolled email address from the list + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions">SelectMfaEmailOptions</a></span>}> +[`SelectMfaEmailOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions) + +The options containing the selection action +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list'; + +const mfaEmailList = new MfaEmailList(); +await mfaEmailList.selectMfaEmail({ + index: 0 // for demonstration we are selecting the first index +}); +``` + +#### Implementation of + +[`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers).[`selectMfaEmail`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.md#selectmfaemail) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEnrollResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEnrollResult.mdx new file mode 100644 index 000000000..7bf662512 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEnrollResult.mdx @@ -0,0 +1,271 @@ +--- +title: "MfaEnrollResult" +--- + +Defined in: [src/screens/mfa-enroll-result/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-enroll-result/index.ts#L34) + +MfaEnrollResult + + +<RequestExample> +```ts +export default class MfaEnrollResult extends BaseContext implements MfaEnrollResultMembers { + /** + * static + * @property {string} screenIdentifier - The unique identifier for the MFA Enroll Result screen. + */ + static screenIdentifier: string = ScreenIds.MFA_ENROLL_RESULT; + + /** + * @property {ScreenOptions} screen - Holds the specific screen data and properties for the + * MFA Enroll Result screen, including the enrollment `status`. + * @public + */ + public screen: ScreenOptions; + + /** + * Creates an instance of MfaEnrollResult screen manager. + * It initializes the `BaseContext` and sets up the `screen` property + * with an instance of `ScreenOverride` tailored for this screen. + * @throws {Error} If the Universal Login Context is not available or if the + * current screen name in the context does not match `MfaEnrollResult.screenIdentifier`. + */ + constructor() { + super(); // Calls BaseContext constructor for global context initialization and validation. + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + // This screen is typically informational. + // If there's a "Continue" button, it would likely be a default action. + // For example, if a `continue()` method was needed: + /* + async continue(payload?: CustomOptions): Promise<void> { + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaEnrollResult.screenIdentifier, 'continue'], + route: '/u/mfa-enroll-result', // Assuming this is the endpoint + }; + await new FormHandler(formOptions).submitData({ ...payload, action: FormActions.DEFAULT }); + } + */ +} +``` +</RequestExample> + +## Example + +```typescript +import MfaEnrollResult from '@auth0/auth0-acul-js/mfa-enroll-result'; + +const mfaEnrollResultScreen = new MfaEnrollResult(); + +// Access screen data +const enrollmentStatus = mfaEnrollResultScreen.screen.data?.status; +const pageTitle = mfaEnrollResultScreen.screen.texts?.title; + +console.log(`MFA Enrollment Status: ${enrollmentStatus}`); +console.log(`Page Title: ${pageTitle}`); +``` + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers) + +## Constructors + +<ParamField body="MfaEnrollResult" type="Constructor"> +{/*> **new MfaEnrollResult**(): `MfaEnrollResult`*/} + +Defined in: [src/screens/mfa-enroll-result/index.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-enroll-result/index.ts#L55) + +Creates an instance of MfaEnrollResult screen manager. +It initializes the `BaseContext` and sets up the `screen` property +with an instance of `ScreenOverride` tailored for this screen. + +#### Returns + +`MfaEnrollResult` + +#### Throws + +If the Universal Login Context is not available or if the +current screen name in the context does not match `MfaEnrollResult.screenIdentifier`. + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult">ScreenMembersOnMfaEnrollResult</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaEnrollResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult)*/} + +Defined in: [src/screens/mfa-enroll-result/index.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-enroll-result/index.ts#L46) + +#### Implementation of + +[`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_ENROLL_RESULT`*/} + +Defined in: [src/screens/mfa-enroll-result/index.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-enroll-result/index.ts#L39) + +static + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaLoginOptions.mdx new file mode 100644 index 000000000..df1d7c802 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaLoginOptions.mdx @@ -0,0 +1,323 @@ +--- +title: "MfaLoginOptions" +--- + +Defined in: [src/screens/mfa-login-options/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L16) + +Class implementing the mfa-login-options screen functionality +This screen allows users to select which MFA factor they want to use for login + + +<RequestExample> +```ts +export default class MfaLoginOptions extends BaseContext implements MfaLoginOptionsMembers { + static screenIdentifier: string = ScreenIds.MFA_LOGIN_OPTIONS; + + /** + * The screen object for the mfa-login-options screen + */ + public screen: ScreenMembersOnMfaLoginOptions; + /** + * Creates an instance of MfaLoginOptions screen manager + */ + constructor() { + super(); // Calls BaseContext constructor for global context initialization and validation. + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Continues the login process with the selected MFA factor + * @param payload The options containing the selected factor + * @example + * ```typescript + * const mfaLoginOptions = new MfaLoginOptions(); + * await mfaLoginOptions.enroll({ + * action: 'push-notification' + * }); + * ``` + */ + async enroll(payload: LoginEnrollOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaLoginOptions.screenIdentifier, 'enroll'], + }; + await new FormHandler(options).submitData<LoginEnrollOptions>(payload); + } + + /** + * @example + * import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options'; + * + * const mfaLoginOptions = new MfaLoginOptions(); + * mfaLoginOptions.returnToPrevious(); + */ + async returnToPrevious(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaLoginOptions.screenIdentifier, 'returnToPrevious'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.BACK }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers) + +## Constructors + +<ParamField body="MfaLoginOptions" type="Constructor"> +{/*> **new MfaLoginOptions**(): `MfaLoginOptions`*/} + +Defined in: [src/screens/mfa-login-options/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L26) + +Creates an instance of MfaLoginOptions screen manager + +#### Returns + +`MfaLoginOptions` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions">ScreenMembersOnMfaLoginOptions</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions)*/} + +Defined in: [src/screens/mfa-login-options/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L22) + +The screen object for the mfa-login-options screen + +#### Implementation of + +[`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_LOGIN_OPTIONS`*/} + +Defined in: [src/screens/mfa-login-options/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L17) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='enroll' type='Promise<void>'> +{/*> **enroll**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-login-options/index.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L43) + +Continues the login process with the selected MFA factor + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions">LoginEnrollOptions</a></span>}> +[`LoginEnrollOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions) + +The options containing the selected factor +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +const mfaLoginOptions = new MfaLoginOptions(); +await mfaLoginOptions.enroll({ + action: 'push-notification' +}); +``` + +#### Implementation of + +[`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers).[`enroll`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.md#enroll) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='returnToPrevious' type='Promise<void>'> +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-login-options/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L58) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options'; + +const mfaLoginOptions = new MfaLoginOptions(); +mfaLoginOptions.returnToPrevious(); +``` + +#### Implementation of + +[`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers).[`returnToPrevious`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.md#returntoprevious) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpChallenge.mdx new file mode 100644 index 000000000..ba7e36590 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpChallenge.mdx @@ -0,0 +1,344 @@ +--- +title: "MfaOtpChallenge" +--- + +Defined in: [src/screens/mfa-otp-challenge/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L24) + +Class implementing the mfa-otp-challenge screen functionality +This screen is shown when a user needs to enter an OTP code during MFA + + +<RequestExample> +```ts +export default class MfaOtpChallenge extends BaseContext implements MfaOtpChallengeMembers { + static screenIdentifier: string = ScreenIds.MFA_OTP_CHALLENGE; + screen: ScreenOptions; + untrustedData: UntrustedDataOptions; + + /** + * Creates an instance of MfaOtpChallenge screen manager + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + const untrustedDataContext = this.getContext('untrusted_data') as UntrustedDataContext; + this.screen = new ScreenOverride(screenContext); + this.untrustedData = new UntrustedDataOverride(untrustedDataContext); + } + + /** + * Continues with the OTP challenge using the provided code + * @param payload The options containing the code and rememberDevice flag + * @example + * ```typescript + * import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge'; + * + * const mfaOtpChallenge = new MfaOtpChallenge(); + * await mfaOtpChallenge.continue({ + * code: '123456', + * rememberDevice: true + * }); + * ``` + */ + async continue(payload: ContinueOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaOtpChallenge.screenIdentifier, 'continue'], + }; + + const { rememberDevice, ...restPayload } = payload || {}; + const submitPayload: Record<string, string | number | boolean> = { ...restPayload, action: FormActions.DEFAULT }; + + if (rememberDevice) { + submitPayload.rememberBrowser = true; + } + + await new FormHandler(options).submitData(submitPayload); + } + + /** + * Allows the user to try another MFA method + * @param payload Optional custom options to include with the request + * @example + * ```typescript + * import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge'; + * + * const mfaOtpChallenge = new MfaOtpChallenge(); + * await mfaOtpChallenge.tryAnotherMethod(); + * ``` + */ + async tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaOtpChallenge.screenIdentifier, 'tryAnotherMethod'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.PICK_AUTHENTICATOR }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers) + +## Constructors + +<ParamField body="MfaOtpChallenge" type="Constructor"> +{/*> **new MfaOtpChallenge**(): `MfaOtpChallenge`*/} + +Defined in: [src/screens/mfa-otp-challenge/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L32) + +Creates an instance of MfaOtpChallenge screen manager + +#### Returns + +`MfaOtpChallenge` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge">ScreenMembersOnMfaOtpChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge)*/} + +Defined in: [src/screens/mfa-otp-challenge/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L26) + +#### Implementation of + +[`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge">UntrustedDataMembersOnMfaOtpChallenge</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge)*/} + +Defined in: [src/screens/mfa-otp-challenge/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L27) + +#### Implementation of + +[`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.md#untrusteddata) + +#### Overrides + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_OTP_CHALLENGE`*/} + +Defined in: [src/screens/mfa-otp-challenge/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L25) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-otp-challenge/index.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L54) + +Continues with the OTP challenge using the provided code + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions">ContinueOTPOptions</a></span>}> +[`ContinueOTPOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions) + +The options containing the code and rememberDevice flag +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge'; + +const mfaOtpChallenge = new MfaOtpChallenge(); +await mfaOtpChallenge.continue({ + code: '123456', + rememberDevice: true +}); +``` + +#### Implementation of + +[`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-otp-challenge/index.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L81) + +Allows the user to try another MFA method + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions">TryAnotherMethodMfaOtpChallengeOptions</a></span>}> +[`TryAnotherMethodMfaOtpChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge'; + +const mfaOtpChallenge = new MfaOtpChallenge(); +await mfaOtpChallenge.tryAnotherMethod(); +``` + +#### Implementation of + +[`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentCode.mdx new file mode 100644 index 000000000..8cf991fc2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentCode.mdx @@ -0,0 +1,350 @@ +--- +title: "MfaOtpEnrollmentCode" +--- + +Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L21) + +Class implementing the mfa-otp-enrollment-code screen functionality. +This screen is displayed when the user needs to enter the OTP code received during MFA enrollment. + + +<RequestExample> +```ts +export default class MfaOtpEnrollmentCode extends BaseContext implements MfaOtpEnrollmentCodeMembers { + /** + * Screen identifier for validation and telemetry + */ + static screenIdentifier: string = ScreenIds.MFA_OTP_ENROLLMENT_CODE; + /** + * The screen properties for the mfa-otp-enrollment-code screen. + */ + screen: ScreenOptions; + + /** + * Creates an instance of MfaOtpEnrollmentCode. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Continues the MFA OTP enrollment process by submitting the OTP code. + * + * @param {ContinueOptions} payload - The options containing the OTP code. + * @returns {Promise<void>} + * @example + * ```typescript + * import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; + * + * const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); + * await mfaOtpEnrollmentCode.continue({ + * code: '123456', + * }); + * ``` + */ + async continue(payload: ContinueOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaOtpEnrollmentCode.screenIdentifier, 'continue'], + }; + await new FormHandler(options).submitData<ContinueOptions>({ + ...payload, + action: FormActions.DEFAULT, + }); + } + + /** + * Allows the user to try another MFA method. + * + * @param {TryAnotherMethodOptions} [payload] - Optional payload. + * @returns {Promise<void>} + * @example + * ```typescript + * import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; + * + * const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); + * await mfaOtpEnrollmentCode.tryAnotherMethod(); + * ``` + */ + async tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaOtpEnrollmentCode.screenIdentifier, 'tryAnotherMethod'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers) + +## Constructors + +<ParamField body="MfaOtpEnrollmentCode" type="Constructor"> +{/*> **new MfaOtpEnrollmentCode**(): `MfaOtpEnrollmentCode`*/} + +Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L34) + +Creates an instance of MfaOtpEnrollmentCode. + +#### Returns + +`MfaOtpEnrollmentCode` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode">ScreenMembersOnMfaOtpEnrollmentCode</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaOtpEnrollmentCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode)*/} + +Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L29) + +The screen properties for the mfa-otp-enrollment-code screen. + +#### Implementation of + +[`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_OTP_ENROLLMENT_CODE`*/} + +Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L25) + +Screen identifier for validation and telemetry + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L55) + +Continues the MFA OTP enrollment process by submitting the OTP code. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions">MfaOtpContinueOptions</a></span>}> +[`MfaOtpContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions) + +The options containing the OTP code. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; + +const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); +await mfaOtpEnrollmentCode.continue({ + code: '123456', +}); +``` + +#### Implementation of + +[`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:79](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L79) + +Allows the user to try another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions">MfaOtpTryAnotherMethodOptions</a></span>}> +[`MfaOtpTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; + +const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); +await mfaOtpEnrollmentCode.tryAnotherMethod(); +``` + +#### Implementation of + +[`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentQr.mdx new file mode 100644 index 000000000..dad4a4695 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentQr.mdx @@ -0,0 +1,399 @@ +--- +title: "MfaOtpEnrollmentQr" +--- + +Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L19) + +Class implementing the mfa-otp-enrollment-qr screen functionality + + +<RequestExample> +```ts +export default class MfaOtpEnrollmentQr extends BaseContext implements MfaOtpEnrollmentQrMembers { + /** + * Screen identifier for validation and telemetry + */ + static screenIdentifier: string = ScreenIds.MFA_OTP_ENROLLMENT_QR; + screen: ScreenOptions; + + /** + * Creates an instance of MfaOtpEnrollmentQr screen manager + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Navigates to the authenticator selection screen. + * @param {object} payload - An object containing any custom options. + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. + * + * + * @example + * ```typescript + * import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; + * + * const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); + * await mfaOtpEnrollmentQr.toggleView(); + * ``` + */ + async toggleView(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaOtpEnrollmentQr.screenIdentifier, 'toggleView'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.TOGGLE_VIEW, + }); + } + + /** + * Continues with the default action. + * + * @param {ContinueOptions} payload - Payload including the OTP code and optional custom options. + * @returns {Promise<void>} + * @example + * ```typescript + * import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; + * + * const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); + * await mfaOtpEnrollmentQr.continue({ code: '123456' }); + * ``` + */ + async continue(payload: ContinueOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaOtpEnrollmentQr.screenIdentifier, 'continue'], + }; + await new FormHandler(options).submitData({ + ...payload, + action: FormActions.DEFAULT, + }); + } + + /** + * Navigates to the authenticator selection screen. + * @param payload Optional custom options to include with the request + * @example + * ```typescript + * import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; + * + * const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); + * await mfaOtpEnrollmentQr.tryAnotherMethod(); + * ``` + */ + async tryAnotherMethod(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaOtpEnrollmentQr.screenIdentifier, 'tryAnotherMethod'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers) + +## Constructors + +<ParamField body="MfaOtpEnrollmentQr" type="Constructor"> +{/*> **new MfaOtpEnrollmentQr**(): `MfaOtpEnrollmentQr`*/} + +Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L29) + +Creates an instance of MfaOtpEnrollmentQr screen manager + +#### Returns + +`MfaOtpEnrollmentQr` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr">ScreenMembersOnMfaOtpEnrollmentQr</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaOtpEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr)*/} + +Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L24) + +#### Implementation of + +[`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_OTP_ENROLLMENT_QR`*/} + +Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L23) + +Screen identifier for validation and telemetry + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:73](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L73) + +Continues with the default action. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions">MfaOtpEnrollmentQrContinueOptions</a></span>}> +[`MfaOtpEnrollmentQrContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions) + +Payload including the OTP code and optional custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; + +const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); +await mfaOtpEnrollmentQr.continue({ code: '123456' }); +``` + +#### Implementation of + +[`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='toggleView' type='Promise<void>'> +{/*> **toggleView**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L49) + +Navigates to the authenticator selection screen. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +An object containing any custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted. + +#### Example + +```typescript +import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; + +const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); +await mfaOtpEnrollmentQr.toggleView(); +``` + +#### Implementation of + +[`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers).[`toggleView`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.md#toggleview) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:95](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L95) + +Navigates to the authenticator selection screen. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; + +const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); +await mfaOtpEnrollmentQr.tryAnotherMethod(); +``` + +#### Implementation of + +[`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneChallenge.mdx new file mode 100644 index 000000000..d67b07615 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneChallenge.mdx @@ -0,0 +1,430 @@ +--- +title: "MfaPhoneChallenge" +--- + +Defined in: [src/screens/mfa-phone-challenge/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L28) + +MfaPhoneChallenge + + +<RequestExample> +```ts +export default class MfaPhoneChallenge extends BaseContext implements MfaPhoneChallengeMembers { + /** + * The unique identifier for this screen. + */ + static screenIdentifier: string = ScreenIds.MFA_PHONE_CHALLENGE; // Use the exact screen name from context + + /** + * Holds the specific screen data for the MFA Phone Challenge. + */ + screen: ScreenOptions; + + /** + * Initializes a new instance of the `MfaPhoneChallenge` class. + * It sets up the screen-specific data by creating an instance of `ScreenOverride`. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Submits the user's choice of receiving the MFA code via SMS or voice call. + * It uses the phone number provided in the screen context. + * + * @param {ContinueOptions} payload - Options containing the delivery type ('sms' or 'voice'). + * @returns {Promise<void>} A promise that resolves upon successful submission. + * @throws {Error} Throws an error if the phone number is not available in the screen context or if the submission fails. + * @example + * ```typescript + * const mfaPhoneChallenge = new MfaPhoneChallenge(); + * // Request code via SMS + * await mfaPhoneChallenge.continue({ type: 'sms' }); + * // Request code via Voice Call + * await mfaPhoneChallenge.continue({ type: 'voice' }); + * ``` + */ + async continue(payload: ContinueOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaPhoneChallenge.screenIdentifier, 'continue'], + }; + + await new FormHandler(options).submitData<ContinueOptions & { action: string }>({ + ...payload, // Includes type: 'sms' | 'voice' + action: FormActions.DEFAULT, // Use the default action for submission + }); + } + + /** + * Initiates the process for the user to select a different phone number (if applicable). + * This typically triggers a navigation to a phone selection screen. + * + * @param {PickPhoneOptions} [payload] - Optional custom options for the request. + * @returns {Promise<void>} A promise that resolves upon successful submission. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * const mfaPhoneChallenge = new MfaPhoneChallenge(); + * await mfaPhoneChallenge.pickPhone(); + * ``` + */ + async pickPhone(payload?: PickPhoneOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaPhoneChallenge.screenIdentifier, 'pickPhone'], + }; + + await new FormHandler(options).submitData<PickPhoneOptions & { action: string }>({ + ...payload, + action: 'pick-phone', // Specific action for picking phone + }); + } + + /** + * Allows the user to choose a different MFA method (e.g., OTP, Recovery Code). + * This typically triggers navigation to the authenticator selection screen. + * + * @param {PickAuthenticatorOptions} [payload] - Optional custom options for the request. + * @returns {Promise<void>} A promise that resolves upon successful submission. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * const mfaPhoneChallenge = new MfaPhoneChallenge(); + * await mfaPhoneChallenge.tryAnotherMethod(); + * ``` + */ + async tryAnotherMethod(payload?: PickAuthenticatorOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaPhoneChallenge.screenIdentifier, 'tryAnotherMethod'], + }; + + await new FormHandler(options).submitData<PickAuthenticatorOptions & { action: string }>({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, // Standard action for picking authenticator + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers) + +## Constructors + +<ParamField body="MfaPhoneChallenge" type="Constructor"> +{/*> **new MfaPhoneChallenge**(): `MfaPhoneChallenge`*/} + +Defined in: [src/screens/mfa-phone-challenge/index.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L43) + +Initializes a new instance of the `MfaPhoneChallenge` class. +It sets up the screen-specific data by creating an instance of `ScreenOverride`. + +#### Returns + +`MfaPhoneChallenge` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge">ScreenMembersOnMfaPhoneChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge)*/} + +Defined in: [src/screens/mfa-phone-challenge/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L37) + +Holds the specific screen data for the MFA Phone Challenge. + +#### Implementation of + +[`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PHONE_CHALLENGE`*/} + +Defined in: [src/screens/mfa-phone-challenge/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L32) + +The unique identifier for this screen. + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-phone-challenge/index.ts:65](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L65) + +Submits the user's choice of receiving the MFA code via SMS or voice call. +It uses the phone number provided in the screen context. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions">MfaPhoneChallengeContinueOptions</a></span>}> +[`MfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions) + +Options containing the delivery type ('sms' or 'voice'). +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves upon successful submission. + +#### Throws + +Throws an error if the phone number is not available in the screen context or if the submission fails. + +#### Example + +```typescript +const mfaPhoneChallenge = new MfaPhoneChallenge(); +// Request code via SMS +await mfaPhoneChallenge.continue({ type: 'sms' }); +// Request code via Voice Call +await mfaPhoneChallenge.continue({ type: 'voice' }); +``` + +#### Implementation of + +[`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='pickPhone' type='Promise<void>'> +{/*> **pickPhone**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-phone-challenge/index.ts:90](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L90) + +Initiates the process for the user to select a different phone number (if applicable). +This typically triggers a navigation to a phone selection screen. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions">MfaPhoneChallengePickPhoneOptions</a></span>}> +[`MfaPhoneChallengePickPhoneOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions) + +Optional custom options for the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves upon successful submission. + +#### Throws + +Throws an error if the submission fails. + +#### Example + +```typescript +const mfaPhoneChallenge = new MfaPhoneChallenge(); +await mfaPhoneChallenge.pickPhone(); +``` + +#### Implementation of + +[`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers).[`pickPhone`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.md#pickphone) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-phone-challenge/index.ts:115](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L115) + +Allows the user to choose a different MFA method (e.g., OTP, Recovery Code). +This typically triggers navigation to the authenticator selection screen. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions">MfaPhoneChallengePickAuthenticatorOptions</a></span>}> +[`MfaPhoneChallengePickAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions) + +Optional custom options for the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves upon successful submission. + +#### Throws + +Throws an error if the submission fails. + +#### Example + +```typescript +const mfaPhoneChallenge = new MfaPhoneChallenge(); +await mfaPhoneChallenge.tryAnotherMethod(); +``` + +#### Implementation of + +[`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneEnrollment.mdx new file mode 100644 index 000000000..cfa94dd4a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneEnrollment.mdx @@ -0,0 +1,426 @@ +--- +title: "MfaPhoneEnrollment" +--- + +Defined in: [src/screens/mfa-phone-enrollment/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L12) + +Class implementing the mfa-phone-enrollment screen functionality. +This screen allows users to enroll using a phone number for MFA. + + +<RequestExample> +```ts +export default class MfaPhoneEnrollment extends BaseContext implements MfaPhoneEnrollmentMembers { + static screenIdentifier: string = ScreenIds.MFA_PHONE_ENROLLMENT; + + /** + * Creates an instance of the MfaPhoneEnrollment screen. + */ + constructor() { + super(); + } + + /** + * Navigates to the country code selection screen. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; + * const mfaPhoneEnrollmentManager = new MfaPhoneEnrollment(); + * async function handlePickCountryCode() { + * try { + * await mfaPhoneEnrollmentManager.pickCountryCode(); + * console.log('Country code selection successful.'); + * } catch (error) { + * console.error('Error selecting country code:', error); + * } + * } + */ + async pickCountryCode(payload?: CustomOptions): Promise<void> { + const options = { + state: this.transaction.state, + telemetry: [MfaPhoneEnrollment.screenIdentifier, 'pickCountryCode'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: 'pick-country-code', + }); + } + + /** + * Continues the enrollment process with the provided phone number and type (SMS or voice). + * @param payload The phone number and type (SMS or voice). + * @example + * ```typescript + * import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; + * const mfaPhoneEnrollmentManager = new MfaPhoneEnrollment(); + * async function handleContinueEnrollment() { + * try { + * await mfaPhoneEnrollmentManager.continueEnrollment({ + * phone: '+1234567890', + * type: 'sms', // or 'voice' + * }); + * console.log('Phone enrollment continued successfully.'); + * } catch (error) { + * console.error('Error continuing phone enrollment:', error); + * } + * } + * ``` + */ + async continueEnrollment(payload: ContinueOptions): Promise<void> { + const options = { + state: this.transaction.state, + telemetry: [MfaPhoneEnrollment.screenIdentifier, 'continueEnrollment'], + }; + await new FormHandler(options).submitData({ + ...payload, + action: 'default', + }); + } + + /** + * Allows the user to try another MFA method. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; + * const mfaPhoneEnrollmentManager = new MfaPhoneEnrollment(); + * async function handleTryAnotherMethod() { + * try { + * await mfaPhoneEnrollmentManager.tryAnotherMethod(); + * console.log('Switched to another authentication method.'); + * } catch (error) { + * console.error('Error switching authenticator method:', error); + * } + * } + * ``` + */ + async tryAnotherMethod(payload?: CustomOptions): Promise<void> { + const options = { + state: this.transaction.state, + telemetry: [MfaPhoneEnrollment.screenIdentifier, 'tryAnotherMethod'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: 'pick-authenticator', + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers) + +## Constructors + +<ParamField body="MfaPhoneEnrollment" type="Constructor"> +{/*> **new MfaPhoneEnrollment**(): `MfaPhoneEnrollment`*/} + +Defined in: [src/screens/mfa-phone-enrollment/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L18) + +Creates an instance of the MfaPhoneEnrollment screen. + +#### Returns + +`MfaPhoneEnrollment` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PHONE_ENROLLMENT`*/} + +Defined in: [src/screens/mfa-phone-enrollment/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L13) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continueEnrollment' type='Promise<void>'> +{/*> **continueEnrollment**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-phone-enrollment/index.ts:69](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L69) + +Continues the enrollment process with the provided phone number and type (SMS or voice). + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions">MfaPhoneEnrollmentContinueOptions</a></span>}> +[`MfaPhoneEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions) + +The phone number and type (SMS or voice). +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; +const mfaPhoneEnrollmentManager = new MfaPhoneEnrollment(); +async function handleContinueEnrollment() { + try { + await mfaPhoneEnrollmentManager.continueEnrollment({ + phone: '+1234567890', + type: 'sms', // or 'voice' + }); + console.log('Phone enrollment continued successfully.'); + } catch (error) { + console.error('Error continuing phone enrollment:', error); + } +} +``` + +#### Implementation of + +[`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers).[`continueEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.md#continueenrollment) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='pickCountryCode' type='Promise<void>'> +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-phone-enrollment/index.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L38) + +Navigates to the country code selection screen. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; +const mfaPhoneEnrollmentManager = new MfaPhoneEnrollment(); +async function handlePickCountryCode() { + try { + await mfaPhoneEnrollmentManager.pickCountryCode(); + console.log('Country code selection successful.'); + } catch (error) { + console.error('Error selecting country code:', error); + } +} + +``` +#### Implementation of + +[`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers).[`pickCountryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.md#pickcountrycode) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-phone-enrollment/index.ts:97](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L97) + +Allows the user to try another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; +const mfaPhoneEnrollmentManager = new MfaPhoneEnrollment(); +async function handleTryAnotherMethod() { + try { + await mfaPhoneEnrollmentManager.tryAnotherMethod(); + console.log('Switched to another authentication method.'); + } catch (error) { + console.error('Error switching authenticator method:', error); + } +} +``` + +#### Implementation of + +[`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushChallengePush.mdx new file mode 100644 index 000000000..60e8ad913 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushChallengePush.mdx @@ -0,0 +1,400 @@ +--- +title: "MfaPushChallengePush" +--- + +Defined in: [src/screens/mfa-push-challenge-push/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L28) + +Class implementing the mfa-push-challenge-push screen functionality +This screen is shown when a user needs to confirm a push notification during MFA + + +<RequestExample> +```ts +export default class MfaPushChallengePush +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers) + +## Constructors + +<ParamField body="MfaPushChallengePush" type="Constructor"> +{/*> **new MfaPushChallengePush**(): `MfaPushChallengePush`*/} + +Defined in: [src/screens/mfa-push-challenge-push/index.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L39) + +Creates an instance of MfaPushChallengePush screen manager + +#### Returns + +`MfaPushChallengePush` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush">ScreenMembersOnMfaPushChallengePush</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush)*/} + +Defined in: [src/screens/mfa-push-challenge-push/index.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L33) + +#### Implementation of + +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush">UntrustedDataMembersOnMfaPushChallengePush</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush)*/} + +Defined in: [src/screens/mfa-push-challenge-push/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L34) + +#### Implementation of + +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.md#untrusteddata) + +#### Overrides + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PUSH_CHALLENGE_PUSH`*/} + +Defined in: [src/screens/mfa-push-challenge-push/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L32) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-push-challenge-push/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L58) + +Continues with the push notification challenge + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions">WithRememberOptions</a></span>}> +[`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +const mfaPushChallengePush = new MfaPushChallengePush(); +await mfaPushChallengePush.continue(); +``` + +#### Implementation of + +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.md#continue) + +</ParamField> + +<ParamField body='enterCodeManually' type='Promise<void>'> +{/*> **enterCodeManually**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-push-challenge-push/index.ts:110](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L110) + +Switches to entering the verification code manually + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +const mfaPushChallengePush = new MfaPushChallengePush(); +await mfaPushChallengePush.enterCodeManually(); +``` + +#### Implementation of + +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers).[`enterCodeManually`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.md#entercodemanually) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='pollingManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> +{/*> **pollingManager**(`options`): [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl)*/} + +Defined in: [src/screens/mfa-push-challenge-push/index.ts:183](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L183) + +**`Utility Feature`** + +Starts and manages polling for an MFA push challenge. + +Creates a polling session that repeatedly checks the MFA push challenge endpoint +at the specified interval until the challenge is approved or an error occurs. +When the approval condition is met, the provided +[onCompleted](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions.md#oncompleted) callback is invoked and +polling stops automatically. + +Use the returned [MfaPushPollingControl](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) to start, stop, or check the +status of the polling process at any time. + +<Expandable title="Parameters"> +<ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions">MfaPollingOptions</a></span>}> +[`MfaPollingOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions) + +[Configuration options](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions) for the polling process: +- `intervalMs` — Optional polling interval in milliseconds (defaults to SDK’s internal value, typically 5000 ms). +- `onCompleted` — Optional callback fired when the MFA push is successfully approved. +- `onError` — Optional callback fired when a polling error occurs, receiving an [Error](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error). +</ParamField> +</Expandable> + +#### Returns + +[`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) + +A [MfaPushPollingControl](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) instance exposing: +- `startPolling()` — Starts or resumes polling. +- `stopPolling()` — Cancels polling immediately. +- `isRunning()` — Indicates whether polling is currently active. + +#### Example + +```ts +// Start polling every 5 seconds until the push challenge is approved +const control = mfaPushChallengePush.pollingManager({ + intervalMs: 5000, + onCompleted: () => mfaPushChallengePush.continue(), + onError: (error) => console.error('Polling error:', error), +}); + +// Later, cancel polling if needed +control.stopPolling(); +``` + +#### Remarks + +- HTTP 429 (rate limit) responses are handled internally: polling automatically + waits until the rate limit resets before retrying. +- Safe to call `startPolling()` multiple times; it has no effect if already running. + +#### Implementation of + +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers).[`pollingManager`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.md#pollingmanager) + +</ParamField> + +<ParamField body='resendPushNotification' type='Promise<void>'> +{/*> **resendPushNotification**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-push-challenge-push/index.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L85) + +Resends the push notification + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions">WithRememberOptions</a></span>}> +[`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +const mfaPushChallengePush = new MfaPushChallengePush(); +await mfaPushChallengePush.resendPushNotification(); +``` + +#### Implementation of + +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers).[`resendPushNotification`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.md#resendpushnotification) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-push-challenge-push/index.ts:130](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L130) + +Allows trying another authentication method + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +const mfaPushChallengePush = new MfaPushChallengePush(); +await mfaPushChallengePush.tryAnotherMethod(); +``` + +#### Implementation of + +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushEnrollmentQr.mdx new file mode 100644 index 000000000..a4e040a01 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushEnrollmentQr.mdx @@ -0,0 +1,380 @@ +--- +title: "MfaPushEnrollmentQr" +--- + +Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L20) + +Class implementing the mfa-push-enrollment-qr screen functionality + + +<RequestExample> +```ts +export default class MfaPushEnrollmentQr extends BaseContext implements MfaPushEnrollmentQrMembers { + static screenIdentifier: string = ScreenIds.MFA_PUSH_ENROLLMENT_QR; + screen: ScreenOptions; + + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Navigates to the authenticator selection screen. + * @param payload Optional custom options to include with the request + * @example + * ```typescript + * import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr'; + * + * const mfaPushEnrollmentQr = new MfaPushEnrollmentQr(); + * await mfaPushEnrollmentQr.pickAuthenticator(); + * ``` + */ + async pickAuthenticator(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaPushEnrollmentQr.screenIdentifier, 'pickAuthenticator'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } + +/** + * Starts and manages polling for an MFA push challenge. + * + * Creates a polling session that repeatedly checks the MFA push challenge endpoint + * at the specified interval until the challenge is approved or an error occurs. + * When the approval condition is met, the provided + * {@link MfaPollingOptions.onCompleted | onCompleted} callback is invoked and + * polling stops automatically. + * + * Use the returned {@link MfaPushPollingControl} to start, stop, or check the + * status of the polling process at any time. + * + * @param options - {@link MfaPollingOptions | Configuration options} for the polling process: + * - `intervalMs` — Optional polling interval in milliseconds (defaults to SDK’s internal value, typically 5000 ms). + * - `onCompleted` — Optional callback fired when the MFA push is successfully approved. + * - `onError` — Optional callback fired when a polling error occurs, receiving an {@link ULError}. + * + * @returns A {@link MfaPushPollingControl} instance exposing: + * - `startPolling()` — Starts or resumes polling. + * - `stopPolling()` — Cancels polling immediately. + * - `isRunning()` — Indicates whether polling is currently active. + * + * @utilityFeature + * + * @example + * ```ts + * // Start polling every 5 seconds until the push challenge is approved + * const control = mfaPushChallengePush.pollingManager({ + * intervalMs: 5000, + * onCompleted: () => mfaPushChallengePush.continue(), + * onError: (error) => console.error('Polling error:', error), + * }); + * + * // Later, cancel polling if needed + * control.stopPolling(); + * ``` + * + * @remarks + * - HTTP 429 (rate limit) responses are handled internally: polling automatically + * waits until the rate limit resets before retrying. + * - Safe to call `startPolling()` multiple times; it has no effect if already running. + */ + pollingManager(options: MfaPollingOptions): MfaPushPollingControl { + return createPollingControl(options); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers) + +## Constructors + +<ParamField body="MfaPushEnrollmentQr" type="Constructor"> +{/*> **new MfaPushEnrollmentQr**(): `MfaPushEnrollmentQr`*/} + +Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L24) + +#### Returns + +`MfaPushEnrollmentQr` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr">ScreenMembersOnMfaPushEnrollmentQr</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaPushEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr)*/} + +Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L22) + +#### Implementation of + +[`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PUSH_ENROLLMENT_QR`*/} + +Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L21) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='pickAuthenticator' type='Promise<void>'> +{/*> **pickAuthenticator**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L41) + +Navigates to the authenticator selection screen. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr'; + +const mfaPushEnrollmentQr = new MfaPushEnrollmentQr(); +await mfaPushEnrollmentQr.pickAuthenticator(); +``` + +#### Implementation of + +[`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers).[`pickAuthenticator`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.md#pickauthenticator) + +</ParamField> + +<ParamField body='pollingManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> +{/*> **pollingManager**(`options`): [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl)*/} + +Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:94](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L94) + +**`Utility Feature`** + +Starts and manages polling for an MFA push challenge. + +Creates a polling session that repeatedly checks the MFA push challenge endpoint +at the specified interval until the challenge is approved or an error occurs. +When the approval condition is met, the provided +[onCompleted](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions.md#oncompleted) callback is invoked and +polling stops automatically. + +Use the returned [MfaPushPollingControl](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) to start, stop, or check the +status of the polling process at any time. + +<Expandable title="Parameters"> +<ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions">MfaPollingOptions</a></span>}> +[`MfaPollingOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions) + +[Configuration options](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions) for the polling process: +- `intervalMs` — Optional polling interval in milliseconds (defaults to SDK’s internal value, typically 5000 ms). +- `onCompleted` — Optional callback fired when the MFA push is successfully approved. +- `onError` — Optional callback fired when a polling error occurs, receiving an [ULError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error). +</ParamField> +</Expandable> + +#### Returns + +[`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) + +A [MfaPushPollingControl](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) instance exposing: +- `startPolling()` — Starts or resumes polling. +- `stopPolling()` — Cancels polling immediately. +- `isRunning()` — Indicates whether polling is currently active. + +#### Example + +```ts +// Start polling every 5 seconds until the push challenge is approved +const control = mfaPushChallengePush.pollingManager({ + intervalMs: 5000, + onCompleted: () => mfaPushChallengePush.continue(), + onError: (error) => console.error('Polling error:', error), +}); + +// Later, cancel polling if needed +control.stopPolling(); +``` + +#### Remarks + +- HTTP 429 (rate limit) responses are handled internally: polling automatically + waits until the rate limit resets before retrying. +- Safe to call `startPolling()` multiple times; it has no effect if already running. + +#### Implementation of + +[`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers).[`pollingManager`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.md#pollingmanager) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushList.mdx new file mode 100644 index 000000000..eeaf7a2e0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushList.mdx @@ -0,0 +1,328 @@ +--- +title: "MfaPushList" +--- + +Defined in: [src/screens/mfa-push-list/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts#L12) + +Class implementing the mfa-push-list screen functionality + + +<RequestExample> +```ts +export default class MfaPushList extends BaseContext implements MfaPushListMembers { + static screenIdentifier: string = ScreenIds.MFA_PUSH_LIST; + + constructor() { + super(); + } + + /** + * Selects a registered device from the list to initiate MFA push. + * + * @param payload The options containing the device index. + * @example + * ```typescript + * import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; + * + * const mfaPushList = new MfaPushList(); + * await mfaPushList.selectMfaPushDevice({ deviceIndex: 0 }); + * ``` + */ + async selectMfaPushDevice(payload: SelectMfaPushDeviceOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaPushList.screenIdentifier, 'selectMfaPushDevice'], + }; + + const { deviceIndex, ...restPayload } = payload; + + await new FormHandler(options).submitData<Omit<SelectMfaPushDeviceOptions, 'deviceIndex'>>({ + ...restPayload, + action: `selection-action::${deviceIndex}`, + }); + } + + /** + * Navigates back to the previous screen. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; + * + * const mfaPushList = new MfaPushList(); + * await mfaPushList.goBack(); + * ``` + */ + async goBack(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaPushList.screenIdentifier, 'goBack'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.BACK, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers) + +## Constructors + +<ParamField body="MfaPushList" type="Constructor"> +{/*> **new MfaPushList**(): `MfaPushList`*/} + +Defined in: [src/screens/mfa-push-list/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts#L15) + +#### Returns + +`MfaPushList` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PUSH_LIST`*/} + +Defined in: [src/screens/mfa-push-list/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts#L13) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='goBack' type='Promise<void>'> +{/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-push-list/index.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts#L56) + +Navigates back to the previous screen. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; + +const mfaPushList = new MfaPushList(); +await mfaPushList.goBack(); +``` + +#### Implementation of + +[`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers).[`goBack`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.md#goback) + +</ParamField> + +<ParamField body='selectMfaPushDevice' type='Promise<void>'> +{/*> **selectMfaPushDevice**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-push-list/index.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts#L31) + +Selects a registered device from the list to initiate MFA push. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions">SelectMfaPushDeviceOptions</a></span>}> +[`SelectMfaPushDeviceOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions) + +The options containing the device index. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; + +const mfaPushList = new MfaPushList(); +await mfaPushList.selectMfaPushDevice({ deviceIndex: 0 }); +``` + +#### Implementation of + +[`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers).[`selectMfaPushDevice`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.md#selectmfapushdevice) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushWelcome.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushWelcome.mdx new file mode 100644 index 000000000..ee162ef27 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushWelcome.mdx @@ -0,0 +1,329 @@ +--- +title: "MfaPushWelcome" +--- + +Defined in: [src/screens/mfa-push-welcome/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L14) + + +<RequestExample> +```ts +export default class MfaPushWelcome extends BaseContext implements MfaPushWelcomeMembers { + static screenIdentifier: string = ScreenIds.MFA_PUSH_WELCOME; + screen: ScreenOptions; + + /** + * Initializes the MfaPushWelcome screen with data from the Universal Login Context. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = screenContext as ScreenOptions; + } + + /** + * Navigates to the enrollment screen. + * @param {CustomOptions} [payload] - Optional custom options to include with the request. + * @example + * ```typescript + * import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome'; + * + * const mfaPushWelcome = new MfaPushWelcome(); + * await mfaPushWelcome.enroll(); + * ``` + */ + async enroll(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaPushWelcome.screenIdentifier, 'enroll'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.ENROLL, + }); + } + + /** + * Navigates to the authenticator selection screen. + * @param {CustomOptions} [payload] - Optional custom options to include with the request. + * @example + * ```typescript + * import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome'; + * + * const mfaPushWelcome = new MfaPushWelcome(); + * await mfaPushWelcome.pickAuthenticator(); + * ``` + */ + async pickAuthenticator(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaPushWelcome.screenIdentifier, 'pickAuthenticator'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers) + +## Constructors + +<ParamField body="MfaPushWelcome" type="Constructor"> +{/*> **new MfaPushWelcome**(): `MfaPushWelcome`*/} + +Defined in: [src/screens/mfa-push-welcome/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L21) + +Initializes the MfaPushWelcome screen with data from the Universal Login Context. + +#### Returns + +`MfaPushWelcome` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome">ScreenMembersOnMfaPushWelcome</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaPushWelcome`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome)*/} + +Defined in: [src/screens/mfa-push-welcome/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L16) + +#### Implementation of + +[`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PUSH_WELCOME`*/} + +Defined in: [src/screens/mfa-push-welcome/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L15) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='enroll' type='Promise<void>'> +{/*> **enroll**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-push-welcome/index.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L38) + +Navigates to the enrollment screen. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome'; + +const mfaPushWelcome = new MfaPushWelcome(); +await mfaPushWelcome.enroll(); +``` + +#### Implementation of + +[`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers).[`enroll`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.md#enroll) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='pickAuthenticator' type='Promise<void>'> +{/*> **pickAuthenticator**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-push-welcome/index.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L60) + +Navigates to the authenticator selection screen. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome'; + +const mfaPushWelcome = new MfaPushWelcome(); +await mfaPushWelcome.pickAuthenticator(); +``` + +#### Implementation of + +[`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers).[`pickAuthenticator`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.md#pickauthenticator) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallenge.mdx new file mode 100644 index 000000000..ca3cd4b74 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallenge.mdx @@ -0,0 +1,358 @@ +--- +title: "MfaRecoveryCodeChallenge" +--- + +Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L14) + +Class implementing the MFA Recovery Code Challenge screen functionality. + + +<RequestExample> +```ts +export default class MfaRecoveryCodeChallenge extends BaseContext implements MfaRecoveryCodeChallengeMembers { + static screenIdentifier: string = ScreenIds.MFA_RECOVERY_CODE_CHALLENGE; + + /** + * Creates an instance of the MfaRecoveryCodeChallenge screen. + */ + constructor() { + super(); + } + + /** + * Continues with the provided recovery code. + * @param payload - The payload containing the recovery code and optional custom options. + * @returns {Promise<void>} + * @example + * ```typescript + * import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge'; + * const mfaRecoveryCodeChallengeManager = new MfaRecoveryCodeChallenge(); + * const handleContinueEnrollment = async () => { + * try { + * await mfaRecoveryCodeChallengeManager.continue('YOUR_RECOVERY_CODE'); + * } catch (error) { + * console.error('Error continuing with recovery code:', error); + * } + * } + * ``` + */ + async continue(payload: ContinueOptions): Promise<void> { + if (!payload || !payload?.code) { + return Promise.reject(new Error('The recovery code is required.')); + } + + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaRecoveryCodeChallenge.screenIdentifier, 'continue'], + }; + + await new FormHandler(options).submitData<ContinueOptions>({ + ...payload, + action: FormActions.DEFAULT, + }); + } + + /** + * Navigates to the screen where the user can pick another MFA method. + * @param payload Optional payload. + * @returns {Promise<void>} + * @example + * ```typescript + * import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge'; + * const mfaRecoveryCodeChallengeManager = new MfaRecoveryCodeChallenge(); + * const switchAuthenticator = async () => { + * try { + * await mfaRecoveryCodeChallengeManager.tryAnotherMethod(); + * console.log('Switched to another authentication method.'); + * } catch (error) { + * console.error('Error switching authenticator:', error); + * } + * }; + * ``` + */ + async tryAnotherMethod(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaRecoveryCodeChallenge.screenIdentifier, 'tryAnotherMethod'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers) + +## Constructors + +<ParamField body="MfaRecoveryCodeChallenge" type="Constructor"> +{/*> **new MfaRecoveryCodeChallenge**(): `MfaRecoveryCodeChallenge`*/} + +Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L20) + +Creates an instance of the MfaRecoveryCodeChallenge screen. + +#### Returns + +`MfaRecoveryCodeChallenge` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_RECOVERY_CODE_CHALLENGE`*/} + +Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L15) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L41) + +Continues with the provided recovery code. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions">MfaRecoveryCodeChallengeContinueOptions</a></span>}> +[`MfaRecoveryCodeChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions) + +The payload containing the recovery code and optional custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge'; +const mfaRecoveryCodeChallengeManager = new MfaRecoveryCodeChallenge(); +const handleContinueEnrollment = async () => { + try { + await mfaRecoveryCodeChallengeManager.continue('YOUR_RECOVERY_CODE'); + } catch (error) { + console.error('Error continuing with recovery code:', error); + } +} +``` + +#### Implementation of + +[`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:75](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L75) + +Navigates to the screen where the user can pick another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge'; +const mfaRecoveryCodeChallengeManager = new MfaRecoveryCodeChallenge(); +const switchAuthenticator = async () => { + try { + await mfaRecoveryCodeChallengeManager.tryAnotherMethod(); + console.log('Switched to another authentication method.'); + } catch (error) { + console.error('Error switching authenticator:', error); + } +}; +``` + +#### Implementation of + +[`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode.mdx new file mode 100644 index 000000000..334a910b9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode.mdx @@ -0,0 +1,337 @@ +--- +title: "MfaRecoveryCodeChallengeNewCode" +--- + +Defined in: [src/screens/mfa-recovery-code-challenge-new-code/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts#L22) + +MfaRecoveryCodeChallengeNewCode + + +<RequestExample> +```ts +export default class MfaRecoveryCodeChallengeNewCode extends BaseContext implements MfaRecoveryCodeChallengeNewCodeMembers { + /** + * The unique identifier for this screen, used internally and for telemetry. + * @type {string} + */ + static screenIdentifier: string = ScreenIds.MFA_RECOVERY_CODE_CHALLENGE_NEW_CODE + + /** + * Holds the specific screen data and properties, processed by ScreenOverride. + * @type {ScreenMembersOnMfaRecoveryCodeChallengeNewCode} + */ + screen: ScreenMembersOnMfaRecoveryCodeChallengeNewCode; + + /** + * Initializes a new instance of the `MfaRecoveryCodeChallengeNewCode` class. + * It retrieves the necessary context (screen, transaction, etc.) and sets up screen-specific properties. + * @throws {Error} If the Universal Login Context is not available or if the screen name doesn't match. + */ + constructor() { + super(); // Calls BaseContext constructor + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Confirms that the user has saved the new recovery code and continues the authentication flow. + * This method sends a POST request to the `/u/mfa-recovery-code-challenge-new-code` endpoint + * with the required `state`, `action`, and `saved` parameters. + * + * @param {ContinueOptions} [payload] - Optional custom data to include with the request form body. + * @returns {Promise<void>} A promise that resolves when the confirmation is successfully submitted. + * On success, the browser will typically be redirected to the next step. + * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state, + * or if the server responds with a 400 error like 'no-confirmation'). + * @example + * ```typescript + * const screenManager = new MfaRecoveryCodeChallengeNewCode(); + * // Assuming a checkbox 'confirmSaved' is checked by the user + * if (confirmSaved) { + * try { + * await screenManager.continue({ customData: 'optionalValue' }); + * } catch (err) { + * // Handle errors, potentially check screenManager.transaction.errors + * console.error("Confirmation failed:", err); + * } + * } else { + * // Prompt user to confirm saving the code + * } + * ``` + */ + async continue(payload?: ContinueOptions): Promise<void> { + // Prepare options for the FormHandler, including state and telemetry + const formHandlerOptions: FormOptions = { + state: this.transaction.state, + telemetry: [MfaRecoveryCodeChallengeNewCode.screenIdentifier, 'continue'] + }; + + // Construct the data payload for the form submission + // 'saved' is set to 'on' as calling this method implies user confirmation. + // Include any custom payload properties. + const submitPayload = { + ...payload, // Spread custom options first + action: FormActions.DEFAULT, + saved: 'on', // Indicate confirmation + }; + + // Use FormHandler to submit the data via a POST request + await new FormHandler(formHandlerOptions).submitData<typeof submitPayload>(submitPayload); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers) + +## Constructors + +<ParamField body="MfaRecoveryCodeChallengeNewCode" type="Constructor"> +{/*> **new MfaRecoveryCodeChallengeNewCode**(): `MfaRecoveryCodeChallengeNewCode`*/} + +Defined in: [src/screens/mfa-recovery-code-challenge-new-code/index.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts#L40) + +Initializes a new instance of the `MfaRecoveryCodeChallengeNewCode` class. +It retrieves the necessary context (screen, transaction, etc.) and sets up screen-specific properties. + +#### Returns + +`MfaRecoveryCodeChallengeNewCode` + +#### Throws + +If the Universal Login Context is not available or if the screen name doesn't match. + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode">ScreenMembersOnMfaRecoveryCodeChallengeNewCode</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode)*/} + +Defined in: [src/screens/mfa-recovery-code-challenge-new-code/index.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts#L33) + +Holds the specific screen data and properties, processed by ScreenOverride. + +#### Implementation of + +[`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_RECOVERY_CODE_CHALLENGE_NEW_CODE`*/} + +Defined in: [src/screens/mfa-recovery-code-challenge-new-code/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts#L27) + +The unique identifier for this screen, used internally and for telemetry. + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-recovery-code-challenge-new-code/index.ts:72](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts#L72) + +Confirms that the user has saved the new recovery code and continues the authentication flow. +This method sends a POST request to the `/u/mfa-recovery-code-challenge-new-code` endpoint +with the required `state`, `action`, and `saved` parameters. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions">MfaRecoveryCodeChallengeNewCodeContinueOptions</a></span>}> +[`MfaRecoveryCodeChallengeNewCodeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions) + +Optional custom data to include with the request form body. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the confirmation is successfully submitted. + On success, the browser will typically be redirected to the next step. + +#### Throws + +Throws an error if the form submission fails (e.g., network issue, invalid state, + or if the server responds with a 400 error like 'no-confirmation'). + +#### Example + +```typescript +const screenManager = new MfaRecoveryCodeChallengeNewCode(); +// Assuming a checkbox 'confirmSaved' is checked by the user +if (confirmSaved) { + try { + await screenManager.continue({ customData: 'optionalValue' }); + } catch (err) { + // Handle errors, potentially check screenManager.transaction.errors + console.error("Confirmation failed:", err); + } +} else { + // Prompt user to confirm saving the code +} +``` + +#### Implementation of + +[`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment.mdx new file mode 100644 index 000000000..b69b44bb2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment.mdx @@ -0,0 +1,304 @@ +--- +title: "MfaRecoveryCodeEnrollment" +--- + +Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L18) + +Class implementing the Mfa Recovery Code Enrollment screen functionality. +This screen is displayed when the user needs to enroll with a recovery code for MFA. + + +<RequestExample> +```ts +export default class MfaRecoveryCodeEnrollment extends BaseContext implements MfaRecoveryCodeEnrollmentMembers { + static screenIdentifier: string = ScreenIds.MFA_RECOVERY_CODE_ENROLLMENT; + screen: ScreenMembersOnMfaRecoveryCodeEnrollment; + + /** + * Creates an instance of the MfaRecoveryCodeEnrollment screen. + */ + constructor() { + super(); + const screenContext: ScreenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Declares that the user saved the recovery code. + * This action is triggered when the user declares that they have saved the recovery code. + * It redirects to the next screen in the authentication flow. + * + * @param {object} payload - An object containing any custom options. + * + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. + * @example + * ```typescript + * import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment'; + * const mfaRecoveryCodeEnrollmentManager = new MfaRecoveryCodeEnrollment(); + * const continueEnrollment = async (payload) => { + * try { + * await mfaRecoveryCodeEnrollmentManager.continue(payload); + * console.log('Enrollment continued successfully.'); + * } catch (error) { + * console.error('Error continuing enrollment:', error); + * } + * }; + * ``` + * Rejects with an error if the submission fails. + */ + async continue(payload: MfaRecoveryCodeEnrollmentContinueOptions): Promise<void> { + const formOptions = { + state: this.transaction.state, + telemetry: [MfaRecoveryCodeEnrollment.screenIdentifier, FormActions.CONTINUE], + }; + + const { isCodeCopied, ...rest } = payload; + + const options: Omit<MfaRecoveryCodeEnrollmentContinueOptions, 'isCodeCopied'> = { + ...rest, + ...(isCodeCopied === true ? { saved: 'on' as unknown as boolean } : {}), + }; + + await new FormHandler(formOptions).submitData<Omit<MfaRecoveryCodeEnrollmentContinueOptions, 'isCodeCopied'> & { saved?: 'string' }>(options); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers) + +## Constructors + +<ParamField body="MfaRecoveryCodeEnrollment" type="Constructor"> +{/*> **new MfaRecoveryCodeEnrollment**(): `MfaRecoveryCodeEnrollment`*/} + +Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L25) + +Creates an instance of the MfaRecoveryCodeEnrollment screen. + +#### Returns + +`MfaRecoveryCodeEnrollment` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment">ScreenMembersOnMfaRecoveryCodeEnrollment</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaRecoveryCodeEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment)*/} + +Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L20) + +#### Implementation of + +[`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_RECOVERY_CODE_ENROLLMENT`*/} + +Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L19) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L54) + +Declares that the user saved the recovery code. +This action is triggered when the user declares that they have saved the recovery code. +It redirects to the next screen in the authentication flow. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions">MfaRecoveryCodeEnrollmentContinueOptions</a></span>}> +[`MfaRecoveryCodeEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions) + +An object containing any custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted. + +#### Example + +```typescript +import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment'; +const mfaRecoveryCodeEnrollmentManager = new MfaRecoveryCodeEnrollment(); +const continueEnrollment = async (payload) => { + try { + await mfaRecoveryCodeEnrollmentManager.continue(payload); + console.log('Enrollment continued successfully.'); + } catch (error) { + console.error('Error continuing enrollment:', error); + } +}; +``` +Rejects with an error if the submission fails. + +#### Implementation of + +[`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsChallenge.mdx new file mode 100644 index 000000000..baa8057f9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsChallenge.mdx @@ -0,0 +1,591 @@ +--- +title: "MfaSmsChallenge" +--- + +Defined in: [src/screens/mfa-sms-challenge/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L25) + +This class provides methods to handle the mfa-sms-challenge screen. + + +<RequestExample> +```ts +export default class MfaSmsChallenge extends BaseContext implements MfaSmsChallengeMembers { + static screenIdentifier: string = ScreenIds.MFA_SMS_CHALLENGE; + screen: ScreenOptions; + untrustedData: UntrustedDataOptions; + + /** + * Creates an instance of MfaSmsChallenge screen manager + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + const untrustedDataContext = this.getContext('untrusted_data') as UntrustedDataContext; + this.screen = new ScreenOverride(screenContext); + this.untrustedData = new UntrustedDataOverride(untrustedDataContext); + } + + /** + * Submits the MFA SMS challenge with the provided code and rememberDevice option. + * @param {MfaSmsChallengeOptions} payload - The payload containing the code and rememberDevice option. + * @returns {Promise<void>} + * @example + * ```typescript + * import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; + * + * const mfaSmsChallenge = new MfaSmsChallenge(); + * await mfaSmsChallenge.continueMfaSmsChallenge({ + * code: '123456', + * rememberDevice: true, + * }); + * ``` + */ + async continueMfaSmsChallenge(payload: MfaSmsChallengeOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaSmsChallenge.screenIdentifier, 'continueMfaSmsChallenge'], + }; + + const { rememberDevice, ...restPayload } = payload; + const submitPayload: Record<string, string | number | boolean> = { ...restPayload, action: FormActions.DEFAULT }; + + if (rememberDevice) { + submitPayload.rememberBrowser = true; + } + + await new FormHandler(options).submitData(submitPayload); + } + + /** + * Submits the action to pick a different SMS configuration, if available. + * @param {CustomOptions} [payload] - Optional payload. + * @returns {Promise<void>} + * @example + * ```typescript + * import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; + * + * const mfaSmsChallenge = new MfaSmsChallenge(); + * await mfaSmsChallenge.pickSms(); + * ``` + */ + async pickSms(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaSmsChallenge.screenIdentifier, 'pickSms'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.PICK_SMS }); + } + + /** + * Submits the action to resend the SMS code. + * @param {CustomOptions} [payload] - Optional payload. + * @returns {Promise<void>} + * @example + * ```typescript + * import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; + * + * const mfaSmsChallenge = new MfaSmsChallenge(); + * await mfaSmsChallenge.resendCode(); + * ``` + */ + async resendCode(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaSmsChallenge.screenIdentifier, 'resendCode'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND_CODE }); + } + + /** + * Submits the action to try another MFA method. + * @param {CustomOptions} [payload] - Optional payload. + * @returns {Promise<void>} + * @example + * ```typescript + * import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; + * + * const mfaSmsChallenge = new MfaSmsChallenge(); + * await mfaSmsChallenge.tryAnotherMethod(); + * ``` + */ + async tryAnotherMethod(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaSmsChallenge.screenIdentifier, 'tryAnotherMethod'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.PICK_AUTHENTICATOR }); + } + + /** + * Submits the action to switch to voice call verification. + * @param {CustomOptions} [payload] - Optional payload. + * @returns {Promise<void>} + * @example + * ```typescript + * import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; + * + * const mfaSmsChallenge = new MfaSmsChallenge(); + * await mfaSmsChallenge.getACall(); + * ``` + */ + async getACall(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaSmsChallenge.screenIdentifier, 'getACall'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.SWITCH_TO_VOICE }); + } + + /** + * Gets resend functionality with timeout management for this screen + * @param options - Configuration options for resend functionality + * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) + * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) + * @param options.onTimeout - Callback to execute when timeout countdown reaches zero + * @returns ResendControl object with startResend method + * @utilityFeature + * + * @example + * ```typescript + * import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; + * + * const mfaSmsChallenge = new MfaSmsChallenge(); + * const { startResend } = mfaSmsChallenge.resendManager({ + * timeoutSeconds: 15, + * onStatusChange: (remainingSeconds, isDisabled) => { + * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + * }, + * onTimeout: () => { + * console.log('Resend is now available'); + * } + * }); + * + * // Call startResend when user clicks resend button + * startResend(); + * ``` + */ + resendManager(options?: StartResendOptions): ResendControl { + return createResendControl( + MfaSmsChallenge.screenIdentifier, + () => this.resendCode(), + options + ); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers) + +## Constructors + +<ParamField body="MfaSmsChallenge" type="Constructor"> +{/*> **new MfaSmsChallenge**(): `MfaSmsChallenge`*/} + +Defined in: [src/screens/mfa-sms-challenge/index.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L33) + +Creates an instance of MfaSmsChallenge screen manager + +#### Returns + +`MfaSmsChallenge` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge">ScreenMembersOnMfaSmsChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge)*/} + +Defined in: [src/screens/mfa-sms-challenge/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L27) + +#### Implementation of + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge">UntrustedDataMembersOnMfaSmsChallenge</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge)*/} + +Defined in: [src/screens/mfa-sms-challenge/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L28) + +#### Implementation of + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.md#untrusteddata) + +#### Overrides + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_SMS_CHALLENGE`*/} + +Defined in: [src/screens/mfa-sms-challenge/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L26) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continueMfaSmsChallenge' type='Promise<void>'> +{/*> **continueMfaSmsChallenge**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-sms-challenge/index.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L56) + +Submits the MFA SMS challenge with the provided code and rememberDevice option. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions">MfaSmsChallengeOptions</a></span>}> +[`MfaSmsChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions) + +The payload containing the code and rememberDevice option. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; + +const mfaSmsChallenge = new MfaSmsChallenge(); +await mfaSmsChallenge.continueMfaSmsChallenge({ + code: '123456', + rememberDevice: true, +}); +``` + +#### Implementation of + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers).[`continueMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.md#continuemfasmschallenge) + +</ParamField> + +<ParamField body='getACall' type='Promise<void>'> +{/*> **getACall**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-sms-challenge/index.ts:144](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L144) + +Submits the action to switch to voice call verification. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; + +const mfaSmsChallenge = new MfaSmsChallenge(); +await mfaSmsChallenge.getACall(); +``` + +#### Implementation of + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers).[`getACall`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.md#getacall) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='pickSms' type='Promise<void>'> +{/*> **pickSms**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-sms-challenge/index.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L84) + +Submits the action to pick a different SMS configuration, if available. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; + +const mfaSmsChallenge = new MfaSmsChallenge(); +await mfaSmsChallenge.pickSms(); +``` + +#### Implementation of + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers).[`pickSms`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.md#picksms) + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-sms-challenge/index.ts:104](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L104) + +Submits the action to resend the SMS code. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; + +const mfaSmsChallenge = new MfaSmsChallenge(); +await mfaSmsChallenge.resendCode(); +``` + +#### Implementation of + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers).[`resendCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.md#resendcode) + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [src/screens/mfa-sms-challenge/index.ts:180](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L180) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +#### Example + +```typescript +import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; + +const mfaSmsChallenge = new MfaSmsChallenge(); +const { startResend } = mfaSmsChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: (remainingSeconds, isDisabled) => { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + }, + onTimeout: () => { + console.log('Resend is now available'); + } +}); + +// Call startResend when user clicks resend button +startResend(); +``` + +#### Implementation of + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers).[`resendManager`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.md#resendmanager) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-sms-challenge/index.ts:124](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L124) + +Submits the action to try another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; + +const mfaSmsChallenge = new MfaSmsChallenge(); +await mfaSmsChallenge.tryAnotherMethod(); +``` + +#### Implementation of + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsEnrollment.mdx new file mode 100644 index 000000000..25d70d30a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsEnrollment.mdx @@ -0,0 +1,404 @@ +--- +title: "MfaSmsEnrollment" +--- + +Defined in: [src/screens/mfa-sms-enrollment/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L16) + +Represents the MFA SMS Enrollment screen. + + +<RequestExample> +```ts +export default class MfaSmsEnrollment extends BaseContext implements MfaSmsEnrollmentMembers { + static screenIdentifier: string = ScreenIds.MFA_SMS_ENROLLMENT; + screen: ScreenMembersOnMfaSmsEnrollment; + + /** + * Initializes a new instance of the MfaSmsEnrollment class. + */ + constructor() { + super(); + this.screen = this.getContext('screen') as ScreenMembersOnMfaSmsEnrollment; + } + + /** + * Handles the action to pick a country code for SMS enrollment. + * @param payload Optional custom options to include in the request. + * @returns A promise that resolves when the action is complete. + * @example + * ```typescript + * import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; + * + * const mfaSmsEnrollment = new MfaSmsEnrollment(); + * await mfaSmsEnrollment.pickCountryCode(); + * ``` + */ + async pickCountryCode(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaSmsEnrollment.screenIdentifier, 'pickCountryCode'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_COUNTRY_CODE, + }); + } + + /** + * Continues the SMS enrollment process with the provided phone number. + * @param payload The phone number to use for enrollment. + * @returns A promise that resolves when the enrollment process is complete. + * @throws {Error} If the phone number is missing. + * @example + * ```typescript + * import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; + * + * const mfaSmsEnrollment = new MfaSmsEnrollment(); + * await mfaSmsEnrollment.continueEnrollment({ phone: '1234567890' }); + * ``` + */ + async continueEnrollment(payload: MfaSmsEnrollmentOptions): Promise<void> { + if (!payload.phone) { + throw new Error('Phone number is required to continue enrollment.'); + } + + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaSmsEnrollment.screenIdentifier, 'continueEnrollment'], + }; + await new FormHandler(options).submitData<MfaSmsEnrollmentOptions>({ + ...payload, + action: FormActions.DEFAULT, + }); + } + + /** + * Handles the action to try another method for MFA. + * @param payload Optional custom options to include in the request. + * @returns A promise that resolves when the action is complete. + * @example + * ```typescript + * import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; + * + * const mfaSmsEnrollment = new MfaSmsEnrollment(); + * await mfaSmsEnrollment.tryAnotherMethod(); + * ``` + */ + async tryAnotherMethod(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaSmsEnrollment.screenIdentifier, 'tryAnotherMethod'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers) + +## Constructors + +<ParamField body="MfaSmsEnrollment" type="Constructor"> +{/*> **new MfaSmsEnrollment**(): `MfaSmsEnrollment`*/} + +Defined in: [src/screens/mfa-sms-enrollment/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L23) + +Initializes a new instance of the MfaSmsEnrollment class. + +#### Returns + +`MfaSmsEnrollment` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment">ScreenMembersOnMfaSmsEnrollment</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaSmsEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment)*/} + +Defined in: [src/screens/mfa-sms-enrollment/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L18) + +#### Implementation of + +[`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_SMS_ENROLLMENT`*/} + +Defined in: [src/screens/mfa-sms-enrollment/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L17) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continueEnrollment' type='Promise<void>'> +{/*> **continueEnrollment**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-sms-enrollment/index.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L64) + +Continues the SMS enrollment process with the provided phone number. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions">MfaSmsEnrollmentOptions</a></span>}> +[`MfaSmsEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions) + +The phone number to use for enrollment. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the enrollment process is complete. + +#### Throws + +If the phone number is missing. + +#### Example + +```typescript +import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; + +const mfaSmsEnrollment = new MfaSmsEnrollment(); +await mfaSmsEnrollment.continueEnrollment({ phone: '1234567890' }); +``` + +#### Implementation of + +[`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers).[`continueEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.md#continueenrollment) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='pickCountryCode' type='Promise<void>'> +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-sms-enrollment/index.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L40) + +Handles the action to pick a country code for SMS enrollment. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include in the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is complete. + +#### Example + +```typescript +import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; + +const mfaSmsEnrollment = new MfaSmsEnrollment(); +await mfaSmsEnrollment.pickCountryCode(); +``` + +#### Implementation of + +[`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers).[`pickCountryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.md#pickcountrycode) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-sms-enrollment/index.ts:91](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L91) + +Handles the action to try another method for MFA. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include in the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is complete. + +#### Example + +```typescript +import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; + +const mfaSmsEnrollment = new MfaSmsEnrollment(); +await mfaSmsEnrollment.tryAnotherMethod(); +``` + +#### Implementation of + +[`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsList.mdx new file mode 100644 index 000000000..20773d283 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsList.mdx @@ -0,0 +1,353 @@ +--- +title: "MfaSmsList" +--- + +Defined in: [src/screens/mfa-sms-list/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts#L14) + +MfaSmsList +Class for handling the mfa-sms-list screen. + + +<RequestExample> +```ts +export default class MfaSmsList extends BaseContext implements MfaSmsListMembers { + static screenIdentifier: string = ScreenIds.MFA_SMS_LIST; + constructor() { + super(); + } + + /** + * Selects a phone number from the list of enrolled phone numbers. + * @param {MfaSmsListOptions} [payload] - Optional payload for the action. + * @returns {Promise<void>} + * @throws {Error} If the index is out of bounds. + * @example + * ```typescript + * import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list'; + * const mfaSmsList = new MfaSmsList(); + * const selectPhoneNumber = async () => { + * const getEnrolledPhoneNumbers = mfaSmsList.user.enrolledPhoneNumbers; + * const selectedNumber = getEnrolledPhoneNumbers[0]; + * await mfaSmsList.selectPhoneNumber({index: selectedNumber}); + * } + * ``` + */ + public async selectPhoneNumber(payload?: MfaSmsListOptions): Promise<void> { + const index = payload?.index; + if (index === undefined || index < 0 || index >= (this.user?.enrolledPhoneNumbers?.length ?? 0)) { + throw new Error('Index out of bounds.'); + } + + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaSmsList.screenIdentifier, 'selectPhoneNumber'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: `selection-action::${index}`, + }); + } + + /** + * Navigates back to the previous screen. + * @param {MfaSmsListOptions} [payload] - Optional payload for the action. + * @returns {Promise<void>} + * @example + * ```typescript + * import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list'; + * const mfaSmsList = new MfaSmsList(); + * const handleBackAction = async () => { + * try { + * await mfaSmsList.backAction(); + * } catch (error) { + * console.error('Failed to go back:', error); + * } + * }; + * ``` + */ + public async backAction(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaSmsList.screenIdentifier, 'backAction'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.BACK, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers) + +## Constructors + +<ParamField body="MfaSmsList" type="Constructor"> +{/*> **new MfaSmsList**(): `MfaSmsList`*/} + +Defined in: [src/screens/mfa-sms-list/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts#L16) + +#### Returns + +`MfaSmsList` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_SMS_LIST`*/} + +Defined in: [src/screens/mfa-sms-list/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts#L15) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='backAction' type='Promise<void>'> +{/*> **backAction**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-sms-list/index.ts:70](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts#L70) + +Navigates back to the previous screen. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload for the action. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list'; +const mfaSmsList = new MfaSmsList(); +const handleBackAction = async () => { + try { + await mfaSmsList.backAction(); + } catch (error) { + console.error('Failed to go back:', error); + } +}; +``` + +#### Implementation of + +[`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers).[`backAction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.md#backaction) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='selectPhoneNumber' type='Promise<void>'> +{/*> **selectPhoneNumber**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-sms-list/index.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts#L36) + +Selects a phone number from the list of enrolled phone numbers. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions">MfaSmsListOptions</a></span>}> +[`MfaSmsListOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions) + +Optional payload for the action. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +If the index is out of bounds. + +#### Example + +```typescript +import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list'; +const mfaSmsList = new MfaSmsList(); +const selectPhoneNumber = async () => { + const getEnrolledPhoneNumbers = mfaSmsList.user.enrolledPhoneNumbers; + const selectedNumber = getEnrolledPhoneNumbers[0]; + await mfaSmsList.selectPhoneNumber({index: selectedNumber}); +} +``` + +#### Implementation of + +[`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers).[`selectPhoneNumber`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.md#selectphonenumber) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceChallenge.mdx new file mode 100644 index 000000000..fa28b0bde --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceChallenge.mdx @@ -0,0 +1,619 @@ +--- +title: "MfaVoiceChallenge" +--- + +Defined in: [src/screens/mfa-voice-challenge/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L27) + +MFA Voice Challenge screen implementation. + +This screen is displayed when a user needs to verify their identity using a voice call +as part of a multi-factor authentication flow. + + +<RequestExample> +```ts +export default class MfaVoiceChallenge extends BaseContext implements MfaVoiceChallengeMembers { + /** + * Screen identifier for validation and telemetry + */ + static screenIdentifier: string = ScreenIds.MFA_VOICE_CHALLENGE; + + /** + * Screen-specific properties and data. + */ + screen: ScreenOptions; + untrustedData: UntrustedDataOptions; + /** + * Creates an instance of MfaVoiceChallenge. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + const untrustedDataContext = this.getContext('untrusted_data') as UntrustedDataContext; + this.screen = new ScreenOverride(screenContext); + this.untrustedData = new UntrustedDataOverride(untrustedDataContext); + } + + /** + * Submits the voice verification code to validate the MFA challenge. + * + * @param payload - Object containing the verification code and optional parameters + * @returns Promise that resolves when the code is successfully validated + * + * @example + * ```typescript + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * mfaVoiceChallenge.continue({ + * code: '123456', + * rememberDevice: true + * }); + * ``` + */ + async continue(payload: MfaVoiceChallengeContinueOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaVoiceChallenge.screenIdentifier, 'default'], + }; + + const { rememberDevice, ...restPayload } = payload || {}; + const submitPayload: Record<string, string | number | boolean> = { ...restPayload, action: FormActions.DEFAULT }; + + if (rememberDevice) { + submitPayload.rememberBrowser = true; + } + await new FormHandler(options).submitData(submitPayload); + } + + /** + * Navigates to the screen for selecting a different phone number. + * + * @param payload - Optional custom parameters + * @returns Promise that resolves when navigation is complete + * + * @example + * ```typescript + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * mfaVoiceChallenge.pickPhone(); + * ``` + */ + async pickPhone(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaVoiceChallenge.screenIdentifier, 'pickPhone'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_PHONE, + }); + } + + /** + * Switches to SMS verification method instead of voice call. + * + * @param payload - Optional custom parameters + * @returns Promise that resolves when switching is complete + * + * @example + * ```typescript + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * mfaVoiceChallenge.switchToSms(); + * ``` + */ + async switchToSms(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaVoiceChallenge.screenIdentifier, 'switchToSms'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.SWITCH_TO_SMS, + }); + } + + /** + * Requests a new voice call with a verification code. + * + * @param payload - Optional custom parameters + * @returns Promise that resolves when the new code is sent + * + * @example + * ```typescript + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * mfaVoiceChallenge.resendCode(); + * ``` + */ + async resendCode(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaVoiceChallenge.screenIdentifier, 'resendCode'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.RESEND_CODE, + }); + } + + /** + * Navigates to the screen for selecting an alternative MFA method. + * + * @param payload - Optional custom parameters + * @returns Promise that resolves when navigation is complete + * + * @example + * ```typescript + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * mfaVoiceChallenge.tryAnotherMethod(); + * ``` + */ + async tryAnotherMethod(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaVoiceChallenge.screenIdentifier, 'pickAuthenticator'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } + + /** + * Gets resend functionality with timeout management for this screen + * @param options - Configuration options for resend functionality + * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) + * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) + * @param options.onTimeout - Callback to execute when timeout countdown reaches zero + * @returns ResendControl object with startResend method + * @utilityFeature + * + * @example + * ```typescript + * import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; + * + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * const { startResend } = mfaVoiceChallenge.resendManager({ + * timeoutSeconds: 15, + * onStatusChange: (remainingSeconds, isDisabled) => { + * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + * }, + * onTimeout: () => { + * console.log('Resend is now available'); + * } + * }); + * + * // Call startResend when user clicks resend button + * startResend(); + * ``` + */ + resendManager(options?: StartResendOptions): ResendControl { + return createResendControl( + MfaVoiceChallenge.screenIdentifier, + () => this.resendCode(), + options + ); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers) + +## Constructors + +<ParamField body="MfaVoiceChallenge" type="Constructor"> +{/*> **new MfaVoiceChallenge**(): `MfaVoiceChallenge`*/} + +Defined in: [src/screens/mfa-voice-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L41) + +Creates an instance of MfaVoiceChallenge. + +#### Returns + +`MfaVoiceChallenge` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge">ScreenMembersOnMfaVoiceChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge)*/} + +Defined in: [src/screens/mfa-voice-challenge/index.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L36) + +Screen-specific properties and data. + +#### Implementation of + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge">UntrustedDataMembersOnMfaVoiceChallenge</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge)*/} + +Defined in: [src/screens/mfa-voice-challenge/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L37) + +#### Implementation of + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.md#untrusteddata) + +#### Overrides + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_VOICE_CHALLENGE`*/} + +Defined in: [src/screens/mfa-voice-challenge/index.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L31) + +Screen identifier for validation and telemetry + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-voice-challenge/index.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L64) + +Submits the voice verification code to validate the MFA challenge. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions">MfaVoiceChallengeContinueOptions</a></span>}> +[`MfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions) + +Object containing the verification code and optional parameters +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +Promise that resolves when the code is successfully validated + +#### Example + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.continue({ + code: '123456', + rememberDevice: true +}); +``` + +#### Implementation of + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='pickPhone' type='Promise<void>'> +{/*> **pickPhone**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-voice-challenge/index.ts:91](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L91) + +Navigates to the screen for selecting a different phone number. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +Promise that resolves when navigation is complete + +#### Example + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.pickPhone(); +``` + +#### Implementation of + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers).[`pickPhone`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.md#pickphone) + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-voice-challenge/index.ts:139](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L139) + +Requests a new voice call with a verification code. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +Promise that resolves when the new code is sent + +#### Example + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.resendCode(); +``` + +#### Implementation of + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers).[`resendCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.md#resendcode) + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [src/screens/mfa-voice-challenge/index.ts:203](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L203) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +#### Example + +```typescript +import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; + +const mfaVoiceChallenge = new MfaVoiceChallenge(); +const { startResend } = mfaVoiceChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: (remainingSeconds, isDisabled) => { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + }, + onTimeout: () => { + console.log('Resend is now available'); + } +}); + +// Call startResend when user clicks resend button +startResend(); +``` + +#### Implementation of + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers).[`resendManager`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.md#resendmanager) + +</ParamField> + +<ParamField body='switchToSms' type='Promise<void>'> +{/*> **switchToSms**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-voice-challenge/index.ts:115](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L115) + +Switches to SMS verification method instead of voice call. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +Promise that resolves when switching is complete + +#### Example + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.switchToSms(); +``` + +#### Implementation of + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers).[`switchToSms`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.md#switchtosms) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-voice-challenge/index.ts:163](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L163) + +Navigates to the screen for selecting an alternative MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +Promise that resolves when navigation is complete + +#### Example + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.tryAnotherMethod(); +``` + +#### Implementation of + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceEnrollment.mdx new file mode 100644 index 000000000..00f6360ae --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceEnrollment.mdx @@ -0,0 +1,410 @@ +--- +title: "MfaVoiceEnrollment" +--- + +Defined in: [src/screens/mfa-voice-enrollment/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L12) + +Class implementing the mfa-voice-enrollment screen functionality. + + +<RequestExample> +```ts +export default class MfaVoiceEnrollment extends BaseContext implements MfaVoiceEnrollmentMembers { + static screenIdentifier: string = ScreenIds.MFA_VOICE_ENROLLMENT; + + /** + * Creates an instance of MfaVoiceEnrollment screen manager. + */ + constructor() { + super(); + } + + /** + * Continues with the default action. + * @param payload - Optional payload. + * @returns {Promise<void>} + * @example + * ```typescript + * import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; + * const mfaVoiceEnrollmentManager = new MfaVoiceEnrollment(); + * const handleContinueEnrollment = async () => { + * try { + * await mfaVoiceEnrollmentManager.continue({ + * phone: '+1234567890', + * // Add any optional CustomOptions here if needed + * }); + * console.log('Voice enrollment continued successfully.'); + * } catch (error) { + * console.error('Error continuing voice enrollment:', error); + * } + * }; + * ``` + */ + async continue(payload: ContinueOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaVoiceEnrollment.screenIdentifier, 'continue'], + }; + + await new FormHandler(options).submitData({ + ...payload, + action: FormActions.DEFAULT, + }); + } + + /** + * Allows trying another authentication method + * @param {CustomOptions} [payload] - Optional payload. + * @example + * ```typescript + * import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; + * const mfaVoiceEnrollment = new MfaVoiceEnrollment(); + * const handleTryAnotherMethod = async () => { + * await mfaVoiceEnrollment.tryAnotherMethod(); + * }; + * ``` + */ + async tryAnotherMethod(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaVoiceEnrollment.screenIdentifier, 'tryAnotherMethod'], + }; + + await new FormHandler(options).submitData({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } + + /** + * Allows picking a country code for the phone number + * @param {CustomOptions} [payload] - Optional payload. + * @example + * ```typescript + * import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; + * const mfaVoiceEnrollment = new MfaVoiceEnrollment(); + * const handlePickCountryCode = async () => { + * await mfaVoiceEnrollment.selectPhoneCountryCode(); + * }; + * ``` + */ + async selectPhoneCountryCode(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaVoiceEnrollment.screenIdentifier, 'selectPhoneCountryCode'], + }; + + await new FormHandler(options).submitData({ + ...payload, + action: FormActions.PICK_COUNTRY_CODE, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers) + +## Constructors + +<ParamField body="MfaVoiceEnrollment" type="Constructor"> +{/*> **new MfaVoiceEnrollment**(): `MfaVoiceEnrollment`*/} + +Defined in: [src/screens/mfa-voice-enrollment/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L18) + +Creates an instance of MfaVoiceEnrollment screen manager. + +#### Returns + +`MfaVoiceEnrollment` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_VOICE_ENROLLMENT`*/} + +Defined in: [src/screens/mfa-voice-enrollment/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L13) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-voice-enrollment/index.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L43) + +Continues with the default action. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions">MfaVoiceEnrollmentContinueOptions</a></span>}> +[`MfaVoiceEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; +const mfaVoiceEnrollmentManager = new MfaVoiceEnrollment(); +const handleContinueEnrollment = async () => { + try { + await mfaVoiceEnrollmentManager.continue({ + phone: '+1234567890', + // Add any optional CustomOptions here if needed + }); + console.log('Voice enrollment continued successfully.'); + } catch (error) { + console.error('Error continuing voice enrollment:', error); + } +}; +``` + +#### Implementation of + +[`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='selectPhoneCountryCode' type='Promise<void>'> +{/*> **selectPhoneCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-voice-enrollment/index.ts:91](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L91) + +Allows picking a country code for the phone number + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; +const mfaVoiceEnrollment = new MfaVoiceEnrollment(); +const handlePickCountryCode = async () => { + await mfaVoiceEnrollment.selectPhoneCountryCode(); +}; +``` + +#### Implementation of + +[`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers).[`selectPhoneCountryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.md#selectphonecountrycode) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-voice-enrollment/index.ts:67](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L67) + +Allows trying another authentication method + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; +const mfaVoiceEnrollment = new MfaVoiceEnrollment(); +const handleTryAnotherMethod = async () => { + await mfaVoiceEnrollment.tryAnotherMethod(); +}; +``` + +#### Implementation of + +[`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname.mdx new file mode 100644 index 000000000..d9497aed7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname.mdx @@ -0,0 +1,322 @@ +--- +title: "MfaWebAuthnChangeKeyNickname" +--- + +Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L15) + +MfaWebAuthnChangeKeyNicknameMembers + + +<RequestExample> +```ts +export default class MfaWebAuthnChangeKeyNickname extends BaseContext implements MfaWebAuthnChangeKeyNicknameMembers { + + static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_CHANGE_KEY_NICKNAME; + + /** + * Holds the specific screen data and properties for this screen, + * processed by `ScreenOverride`. This includes the current `nickname` of the key. + * @type {ScreenOptions} + * @public + */ + public screen: ScreenOptions; + + /** + * Initializes a new instance of the `MfaWebAuthnChangeKeyNickname` class. + * It retrieves the necessary context (screen, transaction, etc.) from the global + * `universal_login_context` and sets up screen-specific properties via `ScreenOverride`. + * @throws {Error} If the Universal Login Context is not available or if the screen name + * in the context does not match `MfaWebAuthnChangeKeyNickname.screenIdentifier`. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Submits the new nickname provided by the user for their WebAuthn security key. + * This method prepares and posts the form data, including the new `nickname` and the + * required `action: "default"`, to the `/u/mfa-webauthn-change-key-nickname` endpoint. + * + * @param {ContinueOptions} payload - An object containing the `nickname` (string) + * entered by the user. May also contain other custom + * parameters if needed for extensibility. + * @returns {Promise<void>} A promise that resolves once the form submission is initiated. + * Typically, a successful submission leads to a server-side redirect. + * If the nickname is invalid or another error occurs, the page will + * re-render, and `this.transaction.errors` will be populated with details. + * @throws {Error} If `payload.nickname` is missing or not a string. It can also + * throw if `FormHandler` encounters an unrecoverable issue during submission + * (e.g., network error). Auth0 validation errors (e.g., "nickname-too-long") + * are not thrown as JS errors but are made available in `this.transaction.errors` + * post-operation. + */ + async continueWithNewNickname(payload: ContinueOptions): Promise<void> { + if (!payload || typeof payload.nickname !== 'string') { + throw new Error('The `nickname` property in the payload is required and must be a string.'); + } + + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnChangeKeyNickname.screenIdentifier, 'continueWithNewNickname'] + }; + + // Prepare the data to be submitted. + // The `action: "default"` signals the server to process the nickname change. + const submitPayload = { + ...payload, // Includes the 'nickname' and any other custom options passed in. + action: FormActions.DEFAULT, + }; + + // Use FormHandler to submit the data. + await new FormHandler(formOptions).submitData<typeof submitPayload>(submitPayload); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers) + +## Constructors + +<ParamField body="MfaWebAuthnChangeKeyNickname" type="Constructor"> +{/*> **new MfaWebAuthnChangeKeyNickname**(): `MfaWebAuthnChangeKeyNickname`*/} + +Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L34) + +Initializes a new instance of the `MfaWebAuthnChangeKeyNickname` class. +It retrieves the necessary context (screen, transaction, etc.) from the global +`universal_login_context` and sets up screen-specific properties via `ScreenOverride`. + +#### Returns + +`MfaWebAuthnChangeKeyNickname` + +#### Throws + +If the Universal Login Context is not available or if the screen name +in the context does not match `MfaWebAuthnChangeKeyNickname.screenIdentifier`. + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname">ScreenMembersOnMfaWebAuthnChangeKeyNickname</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname)*/} + +Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L25) + +Holds the specific screen data and properties for this screen, +processed by `ScreenOverride`. This includes the current `nickname` of the key. + +#### Implementation of + +[`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_CHANGE_KEY_NICKNAME`*/} + +Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L17) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continueWithNewNickname' type='Promise<void>'> +{/*> **continueWithNewNickname**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L58) + +Submits the new nickname provided by the user for their WebAuthn security key. +This method prepares and posts the form data, including the new `nickname` and the +required `action: "default"`, to the `/u/mfa-webauthn-change-key-nickname` endpoint. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions">MfaWebAuthnChangeKeyNicknameContinueOptions</a></span>}> +[`MfaWebAuthnChangeKeyNicknameContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions) + +An object containing the `nickname` (string) + entered by the user. May also contain other custom + parameters if needed for extensibility. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves once the form submission is initiated. + Typically, a successful submission leads to a server-side redirect. + If the nickname is invalid or another error occurs, the page will + re-render, and `this.transaction.errors` will be populated with details. + +#### Throws + +If `payload.nickname` is missing or not a string. It can also + throw if `FormHandler` encounters an unrecoverable issue during submission + (e.g., network error). Auth0 validation errors (e.g., "nickname-too-long") + are not thrown as JS errors but are made available in `this.transaction.errors` + post-operation. + +#### Implementation of + +[`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers).[`continueWithNewNickname`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.md#continuewithnewnickname) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess.mdx new file mode 100644 index 000000000..8201f3aca --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess.mdx @@ -0,0 +1,344 @@ +--- +title: "MfaWebAuthnEnrollmentSuccess" +--- + +Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L24) + +MfaWebAuthnEnrollmentSuccess + + +<RequestExample> +```ts +export default class MfaWebAuthnEnrollmentSuccess extends BaseContext implements MfaWebAuthnEnrollmentSuccessMembers { + /** + * static + * @property {string} screenIdentifier - The unique identifier for the 'mfa-webauthn-enrollment-success' screen. + * This is used by the `BaseContext` to ensure the correct screen class is instantiated based on the + * `window.universal_login_context.screen.name`. + */ + static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_ENROLLMENT_SUCCESS; + + /** + * @property {ScreenOptions} screen - Holds the specific screen data and properties for this screen, + * processed by `ScreenOverride`. This includes the enrolled authenticator's `nickname` and `webauthnType`. + */ + public screen: ScreenOptions; + + /** + * Initializes a new instance of the `MfaWebAuthnEnrollmentSuccess` class. + * It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context` + * and sets up screen-specific properties via `ScreenOverride`. + * @throws {Error} If the Universal Login Context is not available or if the screen name + * in the context does not match `MfaWebAuthnEnrollmentSuccess.screenIdentifier`. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Allows the user to continue the authentication flow after a successful WebAuthn enrollment. + * This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` endpoint + * with the action set to "default", indicating the user is proceeding from this success screen. + * + * @param {ContinueOptions} [payload] - Optional. An object for `CustomOptions` if any + * additional parameters need to be sent with the request. + * These custom parameters will be included in the form data. + * @returns {Promise<void>} A promise that resolves when the continue action is successfully submitted. + * On successful submission, the Auth0 server will typically redirect the user + * to the next appropriate step in the authentication flow. + * @throws {Error} Throws an error if the form submission fails (e.g., due to network issues, + * an invalid transaction state, or other server-side validation errors). + * If an error occurs, details might be available in `this.transaction.errors` + * if the page re-renders. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnEnrollmentSuccess + * async function handleContinueClick() { + * try { + * await sdk.continue(); + * // User will be redirected by Auth0. + * } catch (error) { + * console.error("Error continuing after WebAuthn enrollment success:", error); + * // Display error message to the user, potentially from sdk.transaction.errors + * } + * } + * ``` + */ + async continue(payload?: ContinueOptions): Promise<void> { + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnEnrollmentSuccess.screenIdentifier, 'continue'] + }; + + // The payload for this action is simple, primarily just the action itself. + // Any custom options from the 'payload' argument are also included. + const submitPayload: CustomOptions & { action: string } = { + ...(payload || {}), // Spread custom options if any + action: FormActions.DEFAULT, + }; + + await new FormHandler(formOptions).submitData(submitPayload); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers) + +## Constructors + +<ParamField body="MfaWebAuthnEnrollmentSuccess" type="Constructor"> +{/*> **new MfaWebAuthnEnrollmentSuccess**(): `MfaWebAuthnEnrollmentSuccess`*/} + +Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L46) + +Initializes a new instance of the `MfaWebAuthnEnrollmentSuccess` class. +It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context` +and sets up screen-specific properties via `ScreenOverride`. + +#### Returns + +`MfaWebAuthnEnrollmentSuccess` + +#### Throws + +If the Universal Login Context is not available or if the screen name +in the context does not match `MfaWebAuthnEnrollmentSuccess.screenIdentifier`. + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess">ScreenMembersOnMfaWebAuthnEnrollmentSuccess</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess)*/} + +Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L37) + +#### Implementation of + +[`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_ENROLLMENT_SUCCESS`*/} + +Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L31) + +static + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L82) + +Allows the user to continue the authentication flow after a successful WebAuthn enrollment. +This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` endpoint +with the action set to "default", indicating the user is proceeding from this success screen. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions">WebAuthnEnrollSuccessContinueOptions</a></span>}> +[`WebAuthnEnrollSuccessContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions) + +Optional. An object for `CustomOptions` if any + additional parameters need to be sent with the request. + These custom parameters will be included in the form data. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the continue action is successfully submitted. + On successful submission, the Auth0 server will typically redirect the user + to the next appropriate step in the authentication flow. + +#### Throws + +Throws an error if the form submission fails (e.g., due to network issues, + an invalid transaction state, or other server-side validation errors). + If an error occurs, details might be available in `this.transaction.errors` + if the page re-renders. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnEnrollmentSuccess +async function handleContinueClick() { + try { + await sdk.continue(); + // User will be redirected by Auth0. + } catch (error) { + console.error("Error continuing after WebAuthn enrollment success:", error); + // Display error message to the user, potentially from sdk.transaction.errors + } +} +``` + +#### Implementation of + +[`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnError.mdx new file mode 100644 index 000000000..bccea0808 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnError.mdx @@ -0,0 +1,494 @@ +--- +title: "MfaWebAuthnError" +--- + +Defined in: [src/screens/mfa-webauthn-error/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L23) + +MfaWebAuthnError + + +<RequestExample> +```ts +export default class MfaWebAuthnError extends BaseContext implements MfaWebAuthnErrorMembers { + /** + * static + * @property {string} screenIdentifier - The unique identifier for the 'mfa-webauthn-error' screen. + */ + static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_ERROR; + + /** + * @property {ScreenOptions} screen - Holds the specific screen data and properties, + * processed by `ScreenOverride` for the MFA WebAuthn Error screen. This includes details + * like `errorType` and `webauthnType`. + */ + public screen: ScreenOptions; + + /** + * Initializes a new instance of the `MfaWebAuthnError` class. + * It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context`. + * @throws {Error} If the Universal Login Context is not available or if the screen name in the context + * does not match `MfaWebAuthnError.screenIdentifier`. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Allows the user to retry the previous WebAuthn operation. + * This action typically redirects the user to the screen where the WebAuthn process was + * initially attempted (e.g., back to the MFA challenge or enrollment screen for WebAuthn). + * + * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. + * @returns {Promise<void>} A promise that resolves upon successful submission of the 'tryagain' action. + * @throws {Error} Throws an error if the form submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnError + * await sdk.tryAgain(); + * ``` + */ + async tryAgain(payload?: CustomOptions): Promise<void> { + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnError.screenIdentifier, 'tryAgain'], + }; + await new FormHandler(formOptions).submitData<CustomOptions>({ + ...payload, + action: FormActions.TRY_AGAIN, + }); + } + + /** + * Allows the user to attempt authentication using their password, if this alternative is configured + * and appropriate for the current flow (e.g., if password was a prior authentication step or is a valid MFA bypass). + * + * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. + * @returns {Promise<void>} A promise that resolves upon successful submission of the 'use-password' action. + * @throws {Error} Throws an error if the form submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnError + * await sdk.usePassword(); + * ``` + */ + async usePassword(payload?: CustomOptions): Promise<void> { + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnError.screenIdentifier, 'usePassword'], + }; + await new FormHandler(formOptions).submitData<CustomOptions>({ + ...payload, + action: FormActions.USE_PASSWORD, + }); + } + + /** + * Allows the user to choose a different Multi-Factor Authentication method. + * This action navigates the user to a screen where they can select from other available/enrolled MFA factors. + * + * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. + * @returns {Promise<void>} A promise that resolves upon successful submission of the 'pick-authenticator' action. + * @throws {Error} Throws an error if the form submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnError + * await sdk.tryAnotherMethod(); + * ``` + */ + async tryAnotherMethod(payload?: CustomOptions): Promise<void> { + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnError.screenIdentifier, 'tryAnotherMethod'], + }; + await new FormHandler(formOptions).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } + + /** + * Allows the user to decline the current WebAuthn operation (e.g., refuse to add a device during enrollment). + * This action signifies the user's choice not to proceed with the WebAuthn step at this time. + * + * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. + * @returns {Promise<void>} A promise that resolves upon successful submission of the 'refuse-add-device' action. + * @throws {Error} Throws an error if the form submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnError + * await sdk.noThanks(); + * ``` + */ + async noThanks(payload?: CustomOptions): Promise<void> { + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnError.screenIdentifier, 'noThanks'], + }; + await new FormHandler(formOptions).submitData<CustomOptions>({ + ...payload, + action: FormActions.REFUSE_ADD_DEVICE, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers) + +## Constructors + +<ParamField body="MfaWebAuthnError" type="Constructor"> +{/*> **new MfaWebAuthnError**(): `MfaWebAuthnError`*/} + +Defined in: [src/screens/mfa-webauthn-error/index.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L43) + +Initializes a new instance of the `MfaWebAuthnError` class. +It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context`. + +#### Returns + +`MfaWebAuthnError` + +#### Throws + +If the Universal Login Context is not available or if the screen name in the context +does not match `MfaWebAuthnError.screenIdentifier`. + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError">ScreenMembersOnMfaWebAuthnError</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaWebAuthnError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError)*/} + +Defined in: [src/screens/mfa-webauthn-error/index.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L35) + +#### Implementation of + +[`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_ERROR`*/} + +Defined in: [src/screens/mfa-webauthn-error/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L28) + +static + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='noThanks' type='Promise<void>'> +{/*> **noThanks**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-error/index.ts:135](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L135) + +Allows the user to decline the current WebAuthn operation (e.g., refuse to add a device during enrollment). +This action signifies the user's choice not to proceed with the WebAuthn step at this time. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters to be sent with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves upon successful submission of the 'refuse-add-device' action. + +#### Throws + +Throws an error if the form submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.noThanks(); +``` + +#### Implementation of + +[`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers).[`noThanks`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.md#nothanks) + +</ParamField> + +<ParamField body='tryAgain' type='Promise<void>'> +{/*> **tryAgain**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-error/index.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L63) + +Allows the user to retry the previous WebAuthn operation. +This action typically redirects the user to the screen where the WebAuthn process was +initially attempted (e.g., back to the MFA challenge or enrollment screen for WebAuthn). + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters to be sent with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves upon successful submission of the 'tryagain' action. + +#### Throws + +Throws an error if the form submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.tryAgain(); +``` + +#### Implementation of + +[`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers).[`tryAgain`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.md#tryagain) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-error/index.ts:111](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L111) + +Allows the user to choose a different Multi-Factor Authentication method. +This action navigates the user to a screen where they can select from other available/enrolled MFA factors. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters to be sent with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves upon successful submission of the 'pick-authenticator' action. + +#### Throws + +Throws an error if the form submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.tryAnotherMethod(); +``` + +#### Implementation of + +[`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.md#tryanothermethod) + +</ParamField> + +<ParamField body='usePassword' type='Promise<void>'> +{/*> **usePassword**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-error/index.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L87) + +Allows the user to attempt authentication using their password, if this alternative is configured +and appropriate for the current flow (e.g., if password was a prior authentication step or is a valid MFA bypass). + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters to be sent with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves upon successful submission of the 'use-password' action. + +#### Throws + +Throws an error if the form submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.usePassword(); +``` + +#### Implementation of + +[`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers).[`usePassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.md#usepassword) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError.mdx new file mode 100644 index 000000000..e87518eab --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError.mdx @@ -0,0 +1,311 @@ +--- +title: "MfaWebAuthnNotAvailableError" +--- + +Defined in: [src/screens/mfa-webauthn-not-available-error/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-not-available-error/index.ts#L19) + +MfaWebAuthnNotAvailableError + + +<RequestExample> +```ts +export default class MfaWebAuthnNotAvailableError extends BaseContext implements MfaWebAuthnNotAvailableErrorMembers { + /** + * static + * @property {string} screenIdentifier - The unique identifier for the 'mfa-webauthn-not-available-error' screen. + */ + static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_NOT_AVAILABLE_ERROR; + + /** + * Initializes a new instance of the `MfaWebAuthnNotAvailableError` class. + * It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context`. + * @throws {Error} If the Universal Login Context is not available or if the screen name in the context + * does not match `MfaWebAuthnNotAvailableError.screenIdentifier`. + */ + constructor() { + super(); + // The base BaseContext constructor handles screen property initialization using the base Screen model, + // as MfaWebAuthnNotAvailableErrorMembers.screen is of type ScreenMembers (not a specialized one). + } + + /** + * Allows the user to select a different Multi-Factor Authentication method because WebAuthn + * is not available or supported on their current device/browser. + * This action navigates the user to a screen where they can choose from other available/enrolled MFA factors. + * + * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. + * @returns {Promise<void>} A promise that resolves upon successful submission of the 'pick-authenticator' action. + * @throws {Error} Throws an error if the form submission fails (e.g., network issues, server-side validation errors). + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnNotAvailableError + * try { + * await sdk.tryAnotherMethod(); + * // On success, Auth0 typically handles redirection to the MFA factor selection screen. + * } catch (error) { + * console.error('Failed to initiate "try another method":', error); + * // Update UI to inform the user about the failure to switch methods. + * } + * ``` + */ + async tryAnotherMethod(payload?: CustomOptions): Promise<void> { + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnNotAvailableError.screenIdentifier, 'tryAnotherMethod'], + route: '/u/mfa-webauthn-enrollment', // As per provided OpenAPI spec + }; + await new FormHandler(formOptions).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers) + +## Constructors + +<ParamField body="MfaWebAuthnNotAvailableError" type="Constructor"> +{/*> **new MfaWebAuthnNotAvailableError**(): `MfaWebAuthnNotAvailableError`*/} + +Defined in: [src/screens/mfa-webauthn-not-available-error/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-not-available-error/index.ts#L32) + +Initializes a new instance of the `MfaWebAuthnNotAvailableError` class. +It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context`. + +#### Returns + +`MfaWebAuthnNotAvailableError` + +#### Throws + +If the Universal Login Context is not available or if the screen name in the context +does not match `MfaWebAuthnNotAvailableError.screenIdentifier`. + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_NOT_AVAILABLE_ERROR`*/} + +Defined in: [src/screens/mfa-webauthn-not-available-error/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-not-available-error/index.ts#L24) + +static + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-not-available-error/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-not-available-error/index.ts#L58) + +Allows the user to select a different Multi-Factor Authentication method because WebAuthn +is not available or supported on their current device/browser. +This action navigates the user to a screen where they can choose from other available/enrolled MFA factors. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters to be sent with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves upon successful submission of the 'pick-authenticator' action. + +#### Throws + +Throws an error if the form submission fails (e.g., network issues, server-side validation errors). + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnNotAvailableError +try { + await sdk.tryAnotherMethod(); + // On success, Auth0 typically handles redirection to the MFA factor selection screen. +} catch (error) { + console.error('Failed to initiate "try another method":', error); + // Update UI to inform the user about the failure to switch methods. +} +``` + +#### Implementation of + +[`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge.mdx new file mode 100644 index 000000000..be38d20bc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,453 @@ +--- +title: "MfaWebAuthnPlatformChallenge" +--- + +Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L30) + +MfaWebAuthnPlatformChallenge + + +<RequestExample> +```ts +export default class MfaWebAuthnPlatformChallenge extends BaseContext implements MfaWebAuthnPlatformChallengeMembers { + /** + * static + * @property {string} screenIdentifier - The unique identifier for the 'mfa-webauthn-platform-challenge' screen. + * Used by `BaseContext` to ensure the correct screen class is instantiated. + */ + static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_PLATFORM_CHALLENGE; + + /** + * @property {ScreenOptions} screen - Holds the specific screen data and properties for this screen, + * processed by `ScreenOverride`. This includes `publicKey` for the WebAuthn API call + * and `showRememberDevice`. + */ + public screen: ScreenOptions; + + /** + * Initializes a new instance of the `MfaWebAuthnPlatformChallenge` class. + * It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context`. + * @throws {Error} If the Universal Login Context is not available or if the screen name + * in the context does not match `MfaWebAuthnPlatformChallenge.screenIdentifier`. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Initiates the WebAuthn platform authenticator challenge. + * Internally, this method retrieves the challenge options from `this.screen.publicKey`, + * calls `navigator.credentials.get()` (via the `getPasskeyCredentials` utility), + * and then submits the resulting credential assertion to the Auth0 server. + * + * @param {VerifyPlatformAuthenticatorOptions} [options] - Optional parameters for the verification. + * This can include `rememberDevice` if `this.screen.showRememberDevice` is true, + * and any other custom key-value pairs to be sent in the form submission. + * @returns {Promise<void>} A promise that resolves when the credential submission is initiated. + * A successful operation typically results in a server-side redirect. + * @throws {Error} Throws an error if `this.screen.publicKey` is not available (indicating missing challenge options), + * if `getPasskeyCredentials` (and thus `navigator.credentials.get()`) fails (e.g., user cancellation, + * no authenticator found, hardware error), or if the final form submission to Auth0 fails. + * It's crucial to catch errors from this method. WebAuthn API errors (like `NotAllowedError`) + * should ideally be reported using `this.reportBrowserError()`. + */ + async verify(options?: VerifyPlatformAuthenticatorOptions): Promise<void> { + const publicKeyOpts = this.screen.publicKey; + if (!publicKeyOpts) { + throw new Error(Errors.PASSKEY_PUBLIC_KEY_UNAVAILABLE); + } + + // `getPasskeyCredentials` calls `navigator.credentials.get()` and processes the response. + // It will throw if `navigator.credentials.get()` fails or returns null. + const credential = await getPasskeyCredentials(publicKeyOpts); + + // If credential is null (though getPasskeyCredentials should throw if it fails to get one), + // this is an unexpected state. + if (!credential) { + throw new Error(Errors.PASSKEY_CREDENTIALS_UNAVAILABLE); // Or a more specific error + } + + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnPlatformChallenge.screenIdentifier, 'verify'] + }; + + const { rememberDevice, ...customSubmissionOptions } = options || {}; + const payloadToSubmit: CustomOptions & { action: string; response: string; rememberBrowser?: boolean } = { + ...customSubmissionOptions, + action: FormActions.DEFAULT, + response: JSON.stringify(credential), // The PublicKeyCredential response as a JSON string + }; + + if (this.screen.showRememberDevice && rememberDevice) { + payloadToSubmit.rememberBrowser = true; + } + + await new FormHandler(formOptions).submitData(payloadToSubmit); + } + + /** + * Reports a browser-side error encountered during the WebAuthn `navigator.credentials.get()` operation. + * This method should be called when `verify()` fails due to a WebAuthn API error (e.g., user cancellation). + * It sends the error details to the server with a specific action format. + * + * @param {ReportBrowserErrorOptions} options - Contains the `error` object (with `name` and `message` + * properties from the browser's WebAuthn API DOMException) and any other custom options. + * The `error` object will be JSON stringified and embedded in the `action` parameter. + * @returns {Promise<void>} A promise that resolves when the error report is successfully submitted. + * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). + */ + async reportBrowserError(options: ReportBrowserErrorOptions): Promise<void> { + const { error: errorDetails, ...customPayload } = options; + + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnPlatformChallenge.screenIdentifier, 'reportBrowserError'] + }; + + // Sanitize errorDetails to include only known and safe properties if necessary, + // though WebAuthnErrorDetails interface already limits it to name, message, and custom string/number/boolean. + const errorDetailsString = JSON.stringify(errorDetails); + + await new FormHandler(formOptions).submitData({ + ...customPayload, // Spread any other custom key-value pairs from the 'options' object + action: `${FormActions.SHOW_ERROR_ACTION_PREFIX}${errorDetailsString}`, + response: '', // As per OpenAPI examples for showError actions + }); + } + + /** + * Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. + * This action submits `action: "pick-authenticator"` to Auth0, which should navigate + * the user to an MFA factor selection screen. + * + * @param {TryAnotherMethodOptions} [options] - Optional. Any custom parameters to be sent with the request. + * @returns {Promise<void>} A promise that resolves when the 'pick-authenticator' action is submitted. + * @throws {Error} Throws an error if the form submission fails (e.g., network error, invalid state). + */ + async tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void> { + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnPlatformChallenge.screenIdentifier, 'tryAnotherMethod'] + }; + + await new FormHandler(formOptions).submitData({ + ...(options || {}), // Spread all properties from the options object + action: FormActions.PICK_AUTHENTICATOR, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers) + +## Constructors + +<ParamField body="MfaWebAuthnPlatformChallenge" type="Constructor"> +{/*> **new MfaWebAuthnPlatformChallenge**(): `MfaWebAuthnPlatformChallenge`*/} + +Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L51) + +Initializes a new instance of the `MfaWebAuthnPlatformChallenge` class. +It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context`. + +#### Returns + +`MfaWebAuthnPlatformChallenge` + +#### Throws + +If the Universal Login Context is not available or if the screen name +in the context does not match `MfaWebAuthnPlatformChallenge.screenIdentifier`. + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge">ScreenMembersOnMfaWebAuthnPlatformChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge)*/} + +Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L43) + +#### Implementation of + +[`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_PLATFORM_CHALLENGE`*/} + +Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L36) + +static + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='reportBrowserError' type='Promise<void>'> +{/*> **reportBrowserError**(`options`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:120](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L120) + +Reports a browser-side error encountered during the WebAuthn `navigator.credentials.get()` operation. +This method should be called when `verify()` fails due to a WebAuthn API error (e.g., user cancellation). +It sends the error details to the server with a specific action format. + +<Expandable title="Parameters"> +<ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions">MfaWebAuthnPlatformChallengeReportErrorOptions</a></span>}> +[`MfaWebAuthnPlatformChallengeReportErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions) + +Contains the `error` object (with `name` and `message` +properties from the browser's WebAuthn API DOMException) and any other custom options. +The `error` object will be JSON stringified and embedded in the `action` parameter. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the error report is successfully submitted. + +#### Throws + +Throws an error if the form submission fails (e.g., network issue, invalid state). + +#### Implementation of + +[`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers).[`reportBrowserError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.md#reportbrowsererror) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:148](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L148) + +Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. +This action submits `action: "pick-authenticator"` to Auth0, which should navigate +the user to an MFA factor selection screen. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions">MfaWebAuthnPlatformChallengeTryAnotherMethodOptions</a></span>}> +[`MfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions) + +Optional. Any custom parameters to be sent with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the 'pick-authenticator' action is submitted. + +#### Throws + +Throws an error if the form submission fails (e.g., network error, invalid state). + +#### Implementation of + +[`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.md#tryanothermethod) + +</ParamField> + +<ParamField body='verify' type='Promise<void>'> +{/*> **verify**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:74](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L74) + +Initiates the WebAuthn platform authenticator challenge. +Internally, this method retrieves the challenge options from `this.screen.publicKey`, +calls `navigator.credentials.get()` (via the `getPasskeyCredentials` utility), +and then submits the resulting credential assertion to the Auth0 server. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions">VerifyPlatformAuthenticatorOptions</a></span>}> +[`VerifyPlatformAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions) + +Optional parameters for the verification. +This can include `rememberDevice` if `this.screen.showRememberDevice` is true, +and any other custom key-value pairs to be sent in the form submission. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the credential submission is initiated. +A successful operation typically results in a server-side redirect. + +#### Throws + +Throws an error if `this.screen.publicKey` is not available (indicating missing challenge options), +if `getPasskeyCredentials` (and thus `navigator.credentials.get()`) fails (e.g., user cancellation, +no authenticator found, hardware error), or if the final form submission to Auth0 fails. +It's crucial to catch errors from this method. WebAuthn API errors (like `NotAllowedError`) +should ideally be reported using `this.reportBrowserError()`. + +#### Implementation of + +[`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers).[`verify`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.md#verify) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment.mdx new file mode 100644 index 000000000..cf4baefc3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment.mdx @@ -0,0 +1,473 @@ +--- +title: "MfaWebAuthnPlatformEnrollment" +--- + +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L27) + +MfaWebAuthnPlatformEnrollment + + +<RequestExample> +```ts +export default class MfaWebAuthnPlatformEnrollment extends BaseContext implements MfaWebAuthnPlatformEnrollmentMembers { + /** + * static + * @property {string} screenIdentifier - The unique identifier for the 'mfa-webauthn-platform-enrollment' screen. + */ + static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_PLATFORM_ENROLLMENT; + + /** + * @property {ScreenOptions} screen - Holds the specific screen data and properties, + * processed by `ScreenOverride` for the MFA WebAuthn Platform Enrollment screen. + * This includes convenient access to `screen.publicKey`. + */ + public screen: ScreenOptions; + + /** + * Initializes a new instance of the `MfaWebAuthnPlatformEnrollment` class. + * @throws {Error} If the Universal Login Context is not available or if the screen name + * in the context does not match `MfaWebAuthnPlatformEnrollment.screenIdentifier`. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Initiates the WebAuthn platform credential creation process using the public key options + * available on `this.screen.publicKey` and submits the resulting credential to the server. + * This method internally calls `createPasskeyCredentials` (which wraps `navigator.credentials.create()`). + * + * @param {SubmitPasskeyCredentialOptions} [payload] - Optional custom parameters to be sent to the server + * along with the created credential. + * @returns {Promise<void>} A promise that resolves when the credential is successfully created and submitted. + * @throws {Error} Throws an error if `this.screen.publicKey` is not available, if `createPasskeyCredentials` fails + * (e.g., user cancellation, hardware issues), or if the submission to the server fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment + * try { + * await sdk.submitPasskeyCredential(); // No need to pass publicKey explicitly + * // On success, Auth0 handles redirection. + * } catch (error) { + * console.error('Passkey enrollment failed:', error); + * if (error.name && error.message) { // Check if it looks like a WebAuthn error + * await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + * } + * } + * ``` + */ + async submitPasskeyCredential(payload?: SubmitPasskeyCredentialOptions): Promise<void> { + const publicKeyOptions = this.screen.publicKey; + + if (!publicKeyOptions) { + throw new Error(Errors.PASSKEY_PUBLIC_KEY_UNAVAILABLE); + } + + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnPlatformEnrollment.screenIdentifier, 'submitPasskeyCredential'], + }; + + const credentialResponse = await createPasskeyCredentials(publicKeyOptions); + await new FormHandler(formOptions).submitData({ + ...(payload || {}), // Spread custom options if any + action: FormActions.DEFAULT, + response: JSON.stringify(credentialResponse), + }); + } + + /** + * Reports a browser-side error encountered during the WebAuthn `navigator.credentials.create()` operation. + * + * @param {ReportBrowserErrorOptions} payload - An object containing the `error` (with `name` and `message` properties + * from the browser's WebAuthn API error) and any other custom options. + * @returns {Promise<void>} A promise that resolves upon successful submission of the error report. + * @throws {Error} Throws an error if the form submission fails. + */ + async reportBrowserError(payload: ReportBrowserErrorOptions): Promise<void> { + const { error, ...customPayload } = payload; + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnPlatformEnrollment.screenIdentifier, 'reportBrowserError'], + }; + await new FormHandler(formOptions).submitData({ + ...customPayload, + action: `${FormActions.SHOW_ERROR_ACTION_PREFIX}${JSON.stringify(error)}`, + response: '', + }); + } + + /** + * Allows the user to choose to snooze the WebAuthn platform enrollment. + * + * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. + * @returns {Promise<void>} A promise that resolves upon successful submission of the snooze action. + */ + async snoozeEnrollment(payload?: CustomOptions): Promise<void> { + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnPlatformEnrollment.screenIdentifier, 'snoozeEnrollment'], + }; + await new FormHandler(formOptions).submitData<CustomOptions>({ + ...payload, + action: FormActions.SNOOZE_ENROLLMENT, + }); + } + + /** + * Allows the user to refuse WebAuthn platform enrollment on the current device. + * + * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. + * @returns {Promise<void>} A promise that resolves upon successful submission of the refusal action. + */ + async refuseEnrollmentOnThisDevice(payload?: CustomOptions): Promise<void> { + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnPlatformEnrollment.screenIdentifier, 'refuseEnrollmentOnThisDevice'], + }; + await new FormHandler(formOptions).submitData<CustomOptions>({ + ...payload, + action: FormActions.REFUSE_ADD_DEVICE, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers) + +## Constructors + +<ParamField body="MfaWebAuthnPlatformEnrollment" type="Constructor"> +{/*> **new MfaWebAuthnPlatformEnrollment**(): `MfaWebAuthnPlatformEnrollment`*/} + +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L46) + +Initializes a new instance of the `MfaWebAuthnPlatformEnrollment` class. + +#### Returns + +`MfaWebAuthnPlatformEnrollment` + +#### Throws + +If the Universal Login Context is not available or if the screen name +in the context does not match `MfaWebAuthnPlatformEnrollment.screenIdentifier`. + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment">ScreenMembersOnMfaWebAuthnPlatformEnrollment</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment)*/} + +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L39) + +#### Implementation of + +[`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_PLATFORM_ENROLLMENT`*/} + +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L32) + +static + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='refuseEnrollmentOnThisDevice' type='Promise<void>'> +{/*> **refuseEnrollmentOnThisDevice**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:140](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L140) + +Allows the user to refuse WebAuthn platform enrollment on the current device. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters to be sent with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves upon successful submission of the refusal action. + +#### Implementation of + +[`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers).[`refuseEnrollmentOnThisDevice`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.md#refuseenrollmentonthisdevice) + +</ParamField> + +<ParamField body='reportBrowserError' type='Promise<void>'> +{/*> **reportBrowserError**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:104](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L104) + +Reports a browser-side error encountered during the WebAuthn `navigator.credentials.create()` operation. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions">ReportBrowserErrorOptions</a></span>}> +[`ReportBrowserErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions) + +An object containing the `error` (with `name` and `message` properties +from the browser's WebAuthn API error) and any other custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves upon successful submission of the error report. + +#### Throws + +Throws an error if the form submission fails. + +#### Implementation of + +[`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers).[`reportBrowserError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.md#reportbrowsererror) + +</ParamField> + +<ParamField body='snoozeEnrollment' type='Promise<void>'> +{/*> **snoozeEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:123](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L123) + +Allows the user to choose to snooze the WebAuthn platform enrollment. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters to be sent with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves upon successful submission of the snooze action. + +#### Implementation of + +[`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers).[`snoozeEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.md#snoozeenrollment) + +</ParamField> + +<ParamField body='submitPasskeyCredential' type='Promise<void>'> +{/*> **submitPasskeyCredential**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:76](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L76) + +Initiates the WebAuthn platform credential creation process using the public key options +available on `this.screen.publicKey` and submits the resulting credential to the server. +This method internally calls `createPasskeyCredentials` (which wraps `navigator.credentials.create()`). + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions">SubmitPasskeyCredentialOptions</a></span>}> +[`SubmitPasskeyCredentialOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions) + +Optional custom parameters to be sent to the server +along with the created credential. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the credential is successfully created and submitted. + +#### Throws + +Throws an error if `this.screen.publicKey` is not available, if `createPasskeyCredentials` fails +(e.g., user cancellation, hardware issues), or if the submission to the server fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment +try { + await sdk.submitPasskeyCredential(); // No need to pass publicKey explicitly + // On success, Auth0 handles redirection. +} catch (error) { + console.error('Passkey enrollment failed:', error); + if (error.name && error.message) { // Check if it looks like a WebAuthn error + await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + } +} +``` + +#### Implementation of + +[`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers).[`submitPasskeyCredential`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.md#submitpasskeycredential) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge.mdx new file mode 100644 index 000000000..04353e78b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,454 @@ +--- +title: "MfaWebAuthnRoamingChallenge" +--- + +Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L29) + +MfaWebAuthnRoamingChallenge + + +<RequestExample> +```ts +export default class MfaWebAuthnRoamingChallenge extends BaseContext implements MfaWebAuthnRoamingChallengeMembers { + /** + * static + * @property {string} screenIdentifier - The unique identifier for the 'mfa-webauthn-roaming-challenge' screen. + */ + static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_ROAMING_CHALLENGE; + + /** + * @property {ScreenOptions} screen - Holds the specific screen data and properties, + * processed by `ScreenOverride`. This includes `publicKeyChallengeOptions` for the WebAuthn API call. + */ + public screen: ScreenOptions; + + /** + * Initializes a new instance of the `MfaWebAuthnRoamingChallenge` class. + * @throws {Error} If the Universal Login Context is not available or if the screen name + * in the context does not match `MfaWebAuthnRoamingChallenge.screenIdentifier`. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + async verify(options?: VerifySecurityKeyOptions): Promise<void> { + const publicKeyOpts = this.screen.publicKey; + if (!publicKeyOpts) { + throw new Error(Errors.PASSKEY_PUBLIC_KEY_UNAVAILABLE); + } + + // getPasskeyCredentials will call navigator.credentials.get() and re-throw if it fails. + const credential = await getPasskeyCredentials(publicKeyOpts); + + // If credential is null (though getPasskeyCredentials should throw if it fails to get one) + if (!credential) { + throw new Error(Errors.PASSKEY_CREDENTIALS_UNAVAILABLE); + } + + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnRoamingChallenge.screenIdentifier, 'verify'], + route: '/u/mfa-webauthn-challenge', + }; + + const { rememberDevice, ...customSubmissionOptions } = options || {}; + + const payloadToSubmit: CustomOptions = { + ...customSubmissionOptions, // Spread any other custom options from the VerifySecurityKeyOptions + action: FormActions.DEFAULT, + response: JSON.stringify(credential), + }; + + if (rememberDevice && this.screen.data?.showRememberDevice) { + payloadToSubmit.rememberBrowser = true; + } + + await new FormHandler(formOptions).submitData(payloadToSubmit); + } + + async reportWebAuthnError(options: ReportWebAuthnErrorOptions): Promise<void> { + const { error, ...customPayload } = options; // Separate the 'error' object from other custom options + + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnRoamingChallenge.screenIdentifier, 'reportWebAuthnError'], + route: '/u/mfa-webauthn-challenge', + }; + + // Construct the error details object carefully, only including defined properties from the input 'error' + const errorDetailsForPayload: Partial<WebAuthnErrorDetails> = { name: error.name, message: error.message }; + if (error.code !== undefined) errorDetailsForPayload.code = error.code; + if (error.type !== undefined) errorDetailsForPayload.type = error.type; + const errorDetailsString = JSON.stringify(errorDetailsForPayload); + + await new FormHandler(formOptions).submitData({ + ...customPayload, // Spread any other custom key-value pairs from the 'options' object + action: `${FormActions.SHOW_ERROR_ACTION_PREFIX}${errorDetailsString}`, + response: '', // Response is typically empty when the action is showError, as per OpenAPI examples + }); + } + + async tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void> { + const formOptions: SDKFormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnRoamingChallenge.screenIdentifier, 'tryAnotherMethod'], + route: '/u/mfa-webauthn-challenge', + }; + + await new FormHandler(formOptions).submitData({ + ...(options || {}), // Spread all properties from the options object as custom parameters + action: FormActions.PICK_AUTHENTICATOR, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers) + +## Constructors + +<ParamField body="MfaWebAuthnRoamingChallenge" type="Constructor"> +{/*> **new MfaWebAuthnRoamingChallenge**(): `MfaWebAuthnRoamingChallenge`*/} + +Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L47) + +Initializes a new instance of the `MfaWebAuthnRoamingChallenge` class. + +#### Returns + +`MfaWebAuthnRoamingChallenge` + +#### Throws + +If the Universal Login Context is not available or if the screen name +in the context does not match `MfaWebAuthnRoamingChallenge.screenIdentifier`. + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge">ScreenMembersOnMfaWebAuthnRoamingChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge)*/} + +Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L40) + +#### Implementation of + +[`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_ROAMING_CHALLENGE`*/} + +Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L34) + +static + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='reportWebAuthnError' type='Promise<void>'> +{/*> **reportWebAuthnError**(`options`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L88) + +Reports a specific WebAuthn API error to Auth0. +This method should be used if `navigator.credentials.get()` fails in a way that +`verify()` doesn't automatically handle, or if the developer wants to explicitly +report an error before trying another action. +It submits the error details with `action: "showError::{errorDetails}"`. + +<Expandable title="Parameters"> +<ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions">MfaWebAuthnRoamingChallengeReportErrorOptions</a></span>}> +[`MfaWebAuthnRoamingChallengeReportErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions) + +Contains the `error` object with `name` and `message` +from the WebAuthn API, and any other custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the error report is submitted. + +#### Throws + +Throws an error if the form submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge +// And webAuthnError is an error object from a failed navigator.credentials.get() call. +try { + await sdk.reportWebAuthnError({ + error: { name: webAuthnError.name, message: webAuthnError.message } + }); +} catch (submitError) { + console.error("Failed to report WebAuthn error:", submitError); +} +``` + +#### Implementation of + +[`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers).[`reportWebAuthnError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.md#reportwebauthnerror) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:110](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L110) + +Allows the user to opt-out of the WebAuthn challenge and select a different MFA method. +This action submits `action: "pick-authenticator"` to Auth0, which should navigate +the user to an MFA factor selection screen. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions">MfaWebAuthnRoamingChallengeTryAnotherMethodOptions</a></span>}> +[`MfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions) + +Optional custom parameters for the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is submitted. + +#### Throws + +Throws an error if the form submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge +try { + await sdk.tryAnotherMethod(); + // On success, Auth0 handles redirection to MFA selection. +} catch (error) { + console.error("Failed to switch MFA method:", error); +} +``` + +#### Implementation of + +[`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.md#tryanothermethod) + +</ParamField> + +<ParamField body='verify' type='Promise<void>'> +{/*> **verify**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L53) + +Initiates the WebAuthn challenge by calling `navigator.credentials.get()` with the +options provided in `screen.data.publicKeyChallengeOptions`. +If successful, it submits the resulting credential to Auth0 with `action: "default"`. +If `navigator.credentials.get()` fails with a known WebAuthn API error (like `NotAllowedError`), +this method will internally call `reportWebAuthnError` to inform Auth0. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions">VerifySecurityKeyOptions</a></span>}> +[`VerifySecurityKeyOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions) + +Optional parameters for the verification process, +such as `rememberDevice` and other custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the verification attempt is submitted. + It does not directly return data as a successful operation typically results in a redirect. + +#### Throws + +Throws an error if `screen.data.publicKeyChallengeOptions` is missing, + if `navigator.credentials.get()` fails with an unexpected error, + or if the form submission to Auth0 fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge +try { + await sdk.verify({ rememberDevice: true }); + // On success, Auth0 handles redirection. +} catch (error) { + console.error("Security key verification failed:", error); + // Check sdk.transaction.errors for server-side validation messages if the page reloads. +} +``` + +#### Implementation of + +[`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers).[`verify`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.md#verify) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment.mdx new file mode 100644 index 000000000..30a96c93a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment.mdx @@ -0,0 +1,409 @@ +--- +title: "MfaWebAuthnRoamingEnrollment" +--- + +Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L22) + +Class implementing the mfa-webauthn-roaming-enrollment screen functionality. +This screen is displayed when a user needs to enroll a WebAuthn roaming authenticator (like a security key). + + +<RequestExample> +```ts +export default class MfaWebAuthnRoamingEnrollment extends BaseContext implements MfaWebAuthnRoamingEnrollmentMembers { + static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_ROAMING_ENROLLMENT; + screen: ScreenOptions; + /** + * Creates an instance of MfaWebAuthnRoamingEnrollment screen manager. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + /** + * Initiates the WebAuthn credential creation and submits the result to the server. + * This corresponds to the user interacting with the FIDO Security Keys prompt. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + * + * const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); + * // Assuming you have obtained the WebAuthn credential response (e.g., from navigator.credentials.create) + * const credentialResponse = { /* ... serialized credential ... */ }; + * await webauthnEnrollment.enroll({ response: JSON.stringify(credentialResponse) }); + * ``` + */ + async enroll(payload: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnRoamingEnrollment.screenIdentifier, 'enroll'], + }; + const publicKey = this.screen.publicKey; + const encoded = publicKey && (await createPasskeyCredentials(publicKey)); + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + response: JSON.stringify(encoded), + action: FormActions.DEFAULT, + }); + } + /** + * Submits details about a WebAuthn browser error to the server. + * This is used when the browser's WebAuthn API encounters an error. + * @param payload The options containing the error details. + * @example + * ```typescript + * import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + * + * const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); + * await webauthnEnrollment.showError({ + * error: { + * name: 'NotAllowedError', + * message: 'The operation either timed out or was not allowed.', + * }, + * }); + * ``` + */ + async showError(payload: ShowErrorOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnRoamingEnrollment.screenIdentifier, 'showError'], + }; + const actionValue = `showError::${JSON.stringify(payload.error)}`; + await new FormHandler(options).submitData<Omit<ShowErrorOptions, 'error'>>({ + ...payload, + action: actionValue, + response: '', // As per OpenAPI example + }); + } + /** + * Allows the user to try another MFA method. + * This corresponds to the "Try Another Method" button. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + * + * const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); + * await webauthnEnrollment.tryAnotherMethod(); + * ``` + */ + async tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [MfaWebAuthnRoamingEnrollment.screenIdentifier, 'tryAnotherMethod'], + }; + await new FormHandler(options).submitData<TryAnotherMethodOptions>({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers) + +## Constructors + +<ParamField body="MfaWebAuthnRoamingEnrollment" type="Constructor"> +{/*> **new MfaWebAuthnRoamingEnrollment**(): `MfaWebAuthnRoamingEnrollment`*/} + +Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L28) + +Creates an instance of MfaWebAuthnRoamingEnrollment screen manager. + +#### Returns + +`MfaWebAuthnRoamingEnrollment` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment">ScreenMembersOnMfaWebAuthnRoamingEnrollment</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment)*/} + +Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L24) + +#### Implementation of + +[`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_ROAMING_ENROLLMENT`*/} + +Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L23) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='enroll' type='Promise<void>'> +{/*> **enroll**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L47) + +Initiates the WebAuthn credential creation and submits the result to the server. +This corresponds to the user interacting with the FIDO Security Keys prompt. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + +const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); +// Assuming you have obtained the WebAuthn credential response (e.g., from navigator.credentials.create) +const credentialResponse = { /* ... serialized credential ... */ }; +await webauthnEnrollment.enroll({ response: JSON.stringify(credentialResponse) }); +``` + +#### Implementation of + +[`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers).[`enroll`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.md#enroll) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='showError' type='Promise<void>'> +{/*> **showError**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:77](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L77) + +Submits details about a WebAuthn browser error to the server. +This is used when the browser's WebAuthn API encounters an error. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions">ShowErrorOptions</a></span>}> +[`ShowErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions) + +The options containing the error details. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + +const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); +await webauthnEnrollment.showError({ + error: { + name: 'NotAllowedError', + message: 'The operation either timed out or was not allowed.', + }, +}); +``` + +#### Implementation of + +[`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers).[`showError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.md#showerror) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:101](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L101) + +Allows the user to try another MFA method. +This corresponds to the "Try Another Method" button. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions">MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions</a></span>}> +[`MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + +const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); +await webauthnEnrollment.tryAnotherMethod(); +``` + +#### Implementation of + +[`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationPicker.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationPicker.mdx new file mode 100644 index 000000000..80c6e1a8f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationPicker.mdx @@ -0,0 +1,346 @@ +--- +title: "OrganizationPicker" +--- + +Defined in: [src/screens/organization-picker/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-picker/index.ts#L13) + +Class implementing the organization-picker screen functionality. +This screen allows users to select an organization from a list of available organizations. + + +<RequestExample> +```ts +export default class OrganizationPicker extends BaseContext implements OrganizationPickerMembers { + /** + * Screen identifier for validation and telemetry + */ + static screenIdentifier: string = ScreenIds.ORGANIZATION_PICKER; + /** + * Creates an instance of OrganizationPicker screen manager. + */ + constructor() { + super(); + } + + /** + * Submits the selected organization ID. + * @param payload The ID of the selected organization. `{ organization: string; }` + * @example + * ```typescript + * import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; + * + * const organizationPicker = new OrganizationPicker(); + * organizationPicker.selectOrganization({ + * organization: 'org_XXXXXXXXXXXXXXX' + * }); + * ``` + */ + async selectOrganization(payload: SelectOrganizationOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [OrganizationPicker.screenIdentifier, 'selectOrganization'], + }; + await new FormHandler(options).submitData(payload); + } + + /** + * Submits the action to skip the organization selection. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; + * + * const organizationPicker = new OrganizationPicker(); + * organizationPicker.skipOrganizationSelection(); + * ``` + */ + async skipOrganizationSelection(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [OrganizationPicker.screenIdentifier, 'skipOrganizationSelection'], + }; + await new FormHandler(options).submitData({ + ...payload, + organizationSkipped: true, + state: this.transaction.state, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers) + +## Constructors + +<ParamField body="OrganizationPicker" type="Constructor"> +{/*> **new OrganizationPicker**(): `OrganizationPicker`*/} + +Defined in: [src/screens/organization-picker/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-picker/index.ts#L21) + +Creates an instance of OrganizationPicker screen manager. + +#### Returns + +`OrganizationPicker` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +--- + +</ParamField> +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +--- + +</ParamField> +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +--- + +</ParamField> +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +--- + +</ParamField> +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +--- + +</ParamField> +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +--- + +</ParamField> +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +--- + +</ParamField> +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +--- + +</ParamField> +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +--- + +</ParamField> +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.ORGANIZATION_PICKER`*/} + +Defined in: [src/screens/organization-picker/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-picker/index.ts#L17) + +Screen identifier for validation and telemetry + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +--- + +</ParamField> +<ParamField body='selectOrganization' type='Promise<void>'> +{/*> **selectOrganization**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/organization-picker/index.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-picker/index.ts#L38) + +Submits the selected organization ID. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectOrganizationOptions">SelectOrganizationOptions</a></span>}> +[`SelectOrganizationOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectOrganizationOptions) + +The ID of the selected organization. `{ organization: string; }` +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; + +const organizationPicker = new OrganizationPicker(); +organizationPicker.selectOrganization({ + organization: 'org_XXXXXXXXXXXXXXX', +}); +``` + +#### Implementation of + +[`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers).[`selectOrganization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.md#selectorganization) + +--- + +</ParamField> +<ParamField body='skipOrganizationSelection' type='Promise<void>'> +{/*> **skipOrganizationSelection**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/organization-picker/index.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-picker/index.ts#L57) + +Submits the action to skip the organization selection. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; + +const organizationPicker = new OrganizationPicker(); +organizationPicker.skipOrganizationSelection(); +``` + +#### Implementation of + +[`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers).[`skipOrganizationSelection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.md#skiporganizationselection) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationSelection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationSelection.mdx new file mode 100644 index 000000000..ca8e7035a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationSelection.mdx @@ -0,0 +1,287 @@ +--- +title: "OrganizationSelection" +--- + +Defined in: [src/screens/organization-selection/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-selection/index.ts#L17) + +Class implementing the organization-selection screen functionality. +This screen allows users to select an organization to continue with. + + +<RequestExample> +```ts +export default class OrganizationSelection extends BaseContext implements OrganizationSelectionMembers { + /** + * Screen identifier for validation and telemetry + */ + static screenIdentifier: string = ScreenIds.ORGANIZATION_SELECTION; + screen: ScreenOptions; + + /** + * Creates an instance of OrganizationSelection screen manager. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = screenContext as ScreenOptions; + } + + /** + * Continues with the selected organization name. + * @param payload The options containing the organization name. + * @example + * ```typescript + * import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection'; + * + * const organizationSelection = new OrganizationSelection(); + * await organizationSelection.continueWithOrganizationName({ + * organizationName: 'testOrganizationName', + * }); + * ``` + */ + async continueWithOrganizationName(payload: ContinueWithOrganizationNameOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [OrganizationSelection.screenIdentifier, 'continueWithOrganizationName'], + }; + await new FormHandler(options).submitData<ContinueWithOrganizationNameOptions>({ + ...payload, + action: FormActions.DEFAULT, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers) + +## Constructors + +<ParamField body="OrganizationSelection" type="Constructor"> +{/*> **new OrganizationSelection**(): `OrganizationSelection`*/} + +Defined in: [src/screens/organization-selection/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-selection/index.ts#L27) + +Creates an instance of OrganizationSelection screen manager. + +#### Returns + +`OrganizationSelection` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection">ScreenMembersOnOrganizationSelection</a></span>}> +{/*> **screen**: [`ScreenMembersOnOrganizationSelection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection)*/} + +Defined in: [src/screens/organization-selection/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-selection/index.ts#L22) + +The screen properties. + +#### Implementation of + +[`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.ORGANIZATION_SELECTION`*/} + +Defined in: [src/screens/organization-selection/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-selection/index.ts#L21) + +Screen identifier for validation and telemetry + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continueWithOrganizationName' type='Promise<void>'> +{/*> **continueWithOrganizationName**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/organization-selection/index.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-selection/index.ts#L46) + +Continues with the selected organization name. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions">ContinueWithOrganizationNameOptions</a></span>}> +[`ContinueWithOrganizationNameOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions) + +The options containing the organization name. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection'; + +const organizationSelection = new OrganizationSelection(); +await organizationSelection.continueWithOrganizationName({ + organizationName: 'testOrganizationName', +}); +``` + +#### Implementation of + +[`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers).[`continueWithOrganizationName`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.md#continuewithorganizationname) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollment.mdx new file mode 100644 index 000000000..3377fb2fd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollment.mdx @@ -0,0 +1,309 @@ +--- +title: "PasskeyEnrollment" +--- + +Defined in: [src/screens/passkey-enrollment/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L13) + + +<RequestExample> +```ts +export default class PasskeyEnrollment extends BaseContext implements PasskeyEnrollmentMembers { + static screenIdentifier: string = ScreenIds.PASSKEY_ENROLLMENT; + screen: ScreenOptions; + + constructor() { + super(); + + const screenContext = this.getContext('screen') as ScreenContext; + + this.screen = new ScreenOverride(screenContext); + } + + /** + * @example + * import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; + * + * const passkeyEnrollment = new PasskeyEnrollment(); + * passkeyEnrollment.continuePasskeyEnrollment(); + */ + async continuePasskeyEnrollment(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [PasskeyEnrollment.screenIdentifier, 'continuePasskeyEnrollment'], + }; + + const publicKey = this.screen.publicKey; + const encoded = publicKey && (await createPasskeyCredentials(publicKey)); + + await new FormHandler(options).submitData<CustomOptions>({ ...payload, passkey: JSON.stringify(encoded) }); + } + + /** + * @example + * import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; + * + * const passkeyEnrollment = new PasskeyEnrollment(); + * passkeyEnrollment.abortPasskeyEnrollment(); + */ + async abortPasskeyEnrollment(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [PasskeyEnrollment.screenIdentifier, 'abortPasskeyEnrollment'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.ABORT_PASSKEY_ENROLLMENT }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers) + +## Constructors + +<ParamField body="PasskeyEnrollment" type="Constructor"> +{/*> **new PasskeyEnrollment**(): `PasskeyEnrollment`*/} + +Defined in: [src/screens/passkey-enrollment/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L17) + +#### Returns + +`PasskeyEnrollment` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment">ScreenMembersOnPasskeyEnrollment</a></span>}> +{/*> **screen**: [`ScreenMembersOnPasskeyEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment)*/} + +Defined in: [src/screens/passkey-enrollment/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L15) + +#### Implementation of + +[`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.PASSKEY_ENROLLMENT`*/} + +Defined in: [src/screens/passkey-enrollment/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L14) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='abortPasskeyEnrollment' type='Promise<void>'> +{/*> **abortPasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/passkey-enrollment/index.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L51) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; + +const passkeyEnrollment = new PasskeyEnrollment(); +passkeyEnrollment.abortPasskeyEnrollment(); +``` + +#### Implementation of + +[`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers).[`abortPasskeyEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.md#abortpasskeyenrollment) + +</ParamField> + +<ParamField body='continuePasskeyEnrollment' type='Promise<void>'> +{/*> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/passkey-enrollment/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L32) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; + +const passkeyEnrollment = new PasskeyEnrollment(); +passkeyEnrollment.continuePasskeyEnrollment(); +``` + +#### Implementation of + +[`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers).[`continuePasskeyEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.md#continuepasskeyenrollment) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollmentLocal.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollmentLocal.mdx new file mode 100644 index 000000000..2248a72e3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollmentLocal.mdx @@ -0,0 +1,317 @@ +--- +title: "PasskeyEnrollmentLocal" +--- + +Defined in: [src/screens/passkey-enrollment-local/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L17) + + +<RequestExample> +```ts +export default class PasskeyEnrollmentLocal extends BaseContext implements PasskeyEnrollmentLocalMembers { + static screenIdentifier: string = ScreenIds.PASSKEY_ENROLLMENT_LOCAL; + screen: ScreenOptions; + + constructor() { + super(); + + const screenContext = this.getContext('screen') as ScreenContext; + + this.screen = new ScreenOverride(screenContext); + } + + /** + * @example + * import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local'; + * + * const passkeyEnrollment = new PasskeyEnrollmentLocal(); + * passkeyEnrollment.continuePasskeyEnrollment(); + */ + async continuePasskeyEnrollment(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [PasskeyEnrollmentLocal.screenIdentifier, 'continuePasskeyEnrollment'], + }; + + const publicKey = this.screen.publicKey; + const encoded = publicKey && (await createPasskeyCredentials(publicKey)); + + await new FormHandler(options).submitData<CustomOptions>({ ...payload, passkey: JSON.stringify(encoded) }); + } + + /** + * @example + * import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local'; + * + * const passkeyEnrollment = new PasskeyEnrollmentLocal(); + * passkeyEnrollment.abortPasskeyEnrollment({ + * doNotShowAgain: <boolean> + * }); + */ + async abortPasskeyEnrollment(payload: AbortEnrollmentOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [PasskeyEnrollmentLocal.screenIdentifier, 'abortPasskeyEnrollment'], + }; + + const userActions: { [key: string]: string } = {}; + if (payload['doNotShowAgain'] === true) { + userActions['dontShowAgain'] = 'on'; + } + await new FormHandler(options).submitData<AbortEnrollmentOptions>({ ...payload, action: FormActions.ABORT_PASSKEY_ENROLLMENT, ...userActions }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers) + +## Constructors + +<ParamField body="PasskeyEnrollmentLocal" type="Constructor"> +{/*> **new PasskeyEnrollmentLocal**(): `PasskeyEnrollmentLocal`*/} + +Defined in: [src/screens/passkey-enrollment-local/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L21) + +#### Returns + +`PasskeyEnrollmentLocal` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal">ScreenMembersOnPasskeyEnrollmentLocal</a></span>}> +{/*> **screen**: [`ScreenMembersOnPasskeyEnrollmentLocal`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal)*/} + +Defined in: [src/screens/passkey-enrollment-local/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L19) + +#### Implementation of + +[`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.PASSKEY_ENROLLMENT_LOCAL`*/} + +Defined in: [src/screens/passkey-enrollment-local/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L18) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='abortPasskeyEnrollment' type='Promise<void>'> +{/*> **abortPasskeyEnrollment**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/passkey-enrollment-local/index.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L57) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions">AbortEnrollmentOptions</a></span>}> +[`AbortEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local'; + +const passkeyEnrollment = new PasskeyEnrollmentLocal(); +passkeyEnrollment.abortPasskeyEnrollment({ + doNotShowAgain: <boolean> +}); +``` + +#### Implementation of + +[`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers).[`abortPasskeyEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.md#abortpasskeyenrollment) + +</ParamField> + +<ParamField body='continuePasskeyEnrollment' type='Promise<void>'> +{/*> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/passkey-enrollment-local/index.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L36) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local'; + +const passkeyEnrollment = new PasskeyEnrollmentLocal(); +passkeyEnrollment.continuePasskeyEnrollment(); +``` + +#### Implementation of + +[`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers).[`continuePasskeyEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.md#continuepasskeyenrollment) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierChallenge.mdx new file mode 100644 index 000000000..160bcf58d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierChallenge.mdx @@ -0,0 +1,533 @@ +--- +title: "PhoneIdentifierChallenge" +--- + +Defined in: [src/screens/phone-identifier-challenge/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L18) + + +<RequestExample> +```ts +export default class PhoneIdentifierChallenge extends BaseContext implements PhoneIdentifierChallengeMembers { + static screenIdentifier: string = ScreenIds.PHONE_IDENTIFIER_CHALLENGE; + screen: ScreenOptions; + + constructor() { + super(); + + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * @example + * import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + * + * const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); + * phoneIdentifierChallenge.submitPhoneChallenge({ + * code: "<string>" + * }); + */ + async submitPhoneChallenge(payload: PhoneChallengeOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [PhoneIdentifierChallenge.screenIdentifier, 'submitPhoneChallenge'], + }; + await new FormHandler(options).submitData<PhoneChallengeOptions>(payload); + } + + /** + * @example + * import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + * + * const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); + * phoneIdentifierChallenge.resendCode(); + */ + async resendCode(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [PhoneIdentifierChallenge.screenIdentifier, 'resendCode'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND_CODE }); + } + + /** + * @example + * import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + * + * const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); + * phoneIdentifierChallenge.returnToPrevious(); + */ + async returnToPrevious(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [PhoneIdentifierChallenge.screenIdentifier, 'returnToPrevious'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.BACK}); + } + + /** + * @example + * import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + * + * const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); + * phoneIdentifierChallenge.switchToVoice(); + */ + async switchToVoice(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [PhoneIdentifierChallenge.screenIdentifier, 'switchToVoice'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.SWITCH_TO_VOICE }); + } + + /** + * @example + * import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + * + * const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); + * phoneIdentifierChallenge.switchToText(); + */ + async switchToText(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [PhoneIdentifierChallenge.screenIdentifier, 'switchToText'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.SWITCH_TO_TEXT }); + } + + /** + * Gets resend functionality with timeout management for this screen + * @param options - Configuration options for resend functionality + * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) + * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) + * @param options.onTimeout - Callback to execute when timeout countdown reaches zero + * @returns ResendControl object with startResend method + * @utilityFeature + * + * @example + * import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + * const handleStatusChange = (remainingSeconds, isDisabled) => { + * setDisabled(isDisabled); + * setRemaining(remainingSeconds); + * }; + * + * const handleTimeout = () => { + * console.log('Timeout completed, resend is now available'); + * }; + * + * const { startResend } = phoneChallenge.resendManager({ + * timeoutSeconds: 30, + * onStatusChange: handleStatusChange, + * onTimeout: handleTimeout + * }); + * + * // Call startResend when user clicks resend button + * await startResend(); + * + */ + resendManager(options?: StartResendOptions): ResendControl { + return createResendControl( + PhoneIdentifierChallenge.screenIdentifier, + () => this.resendCode(), + options, + !!this.screen.data?.resendLimitReached + ); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers) + +## Constructors + +<ParamField body="PhoneIdentifierChallenge" type="Constructor"> +{/*> **new PhoneIdentifierChallenge**(): `PhoneIdentifierChallenge`*/} + +Defined in: [src/screens/phone-identifier-challenge/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L22) + +#### Returns + +`PhoneIdentifierChallenge` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge">ScreenMembersOnPhoneIdentifierChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnPhoneIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge)*/} + +Defined in: [src/screens/phone-identifier-challenge/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L20) + +#### Implementation of + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.PHONE_IDENTIFIER_CHALLENGE`*/} + +Defined in: [src/screens/phone-identifier-challenge/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L19) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/phone-identifier-challenge/index.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L53) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + +const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); +phoneIdentifierChallenge.resendCode(); +``` + +#### Implementation of + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers).[`resendCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.md#resendcode) + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [src/screens/phone-identifier-challenge/index.ts:136](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L136) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +#### Example + +```ts +import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + const handleStatusChange = (remainingSeconds, isDisabled) => { + setDisabled(isDisabled); + setRemaining(remainingSeconds); + }; + + const handleTimeout = () => { + console.log('Timeout completed, resend is now available'); + }; + + const { startResend } = phoneChallenge.resendManager({ + timeoutSeconds: 30, + onStatusChange: handleStatusChange, + onTimeout: handleTimeout + }); + + // Call startResend when user clicks resend button + await startResend(); +``` + +#### Implementation of + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers).[`resendManager`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.md#resendmanager) + +</ParamField> + +<ParamField body='returnToPrevious' type='Promise<void>'> +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/phone-identifier-challenge/index.ts:68](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L68) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + +const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); +phoneIdentifierChallenge.returnToPrevious(); +``` + +#### Implementation of + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers).[`returnToPrevious`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.md#returntoprevious) + +</ParamField> + +<ParamField body='submitPhoneChallenge' type='Promise<void>'> +{/*> **submitPhoneChallenge**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/phone-identifier-challenge/index.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L38) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions">PhoneChallengeOptions</a></span>}> +[`PhoneChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + +const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); +phoneIdentifierChallenge.submitPhoneChallenge({ + code: "<string>" +}); +``` + +#### Implementation of + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers).[`submitPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.md#submitphonechallenge) + +</ParamField> + +<ParamField body='switchToText' type='Promise<void>'> +{/*> **switchToText**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/phone-identifier-challenge/index.ts:98](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L98) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + +const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); +phoneIdentifierChallenge.switchToText(); +``` + +#### Implementation of + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers).[`switchToText`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.md#switchtotext) + +</ParamField> + +<ParamField body='switchToVoice' type='Promise<void>'> +{/*> **switchToVoice**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/phone-identifier-challenge/index.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L83) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + +const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); +phoneIdentifierChallenge.switchToVoice(); +``` + +#### Implementation of + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers).[`switchToVoice`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.md#switchtovoice) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierEnrollment.mdx new file mode 100644 index 000000000..b26e5f732 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierEnrollment.mdx @@ -0,0 +1,308 @@ +--- +title: "PhoneIdentifierEnrollment" +--- + +Defined in: [src/screens/phone-identifier-enrollment/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L16) + + +<RequestExample> +```ts +export default class PhoneIdentifierEnrollment extends BaseContext implements PhoneIdentifierEnrollmentMembers { + static screenIdentifier: string = ScreenIds.PHONE_IDENTIFIER_ENROLLMENT; + screen: ScreenOptions; + + constructor() { + super(); + + const screenContext = super.getContext('screen') as ScreenContext; + + this.screen = new ScreenOverride(screenContext); + } + + /** + * @example + * import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment'; + * + * const phoneIdentifierEnrollment = new PhoneIdentifierEnrollment(); + * phoneIdentifierChallenge.continuePhoneEnrollment({ + * type: "<text' | 'voice>" + * }); + */ + async continuePhoneEnrollment(payload: PhoneEnrollmentOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [PhoneIdentifierEnrollment.screenIdentifier, 'continuePhoneEnrollment'], + }; + await new FormHandler(options).submitData<PhoneEnrollmentOptions>(payload); + } + + /** + * @example + * import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment'; + * + * const phoneIdentifierEnrollment = new PhoneIdentifierEnrollment(); + * phoneIdentifierChallenge.returnToPrevious(); + */ + async returnToPrevious(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [PhoneIdentifierEnrollment.screenIdentifier, 'returnToPrevious'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.BACK }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers) + +## Constructors + +<ParamField body="PhoneIdentifierEnrollment" type="Constructor"> +{/*> **new PhoneIdentifierEnrollment**(): `PhoneIdentifierEnrollment`*/} + +Defined in: [src/screens/phone-identifier-enrollment/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L20) + +#### Returns + +`PhoneIdentifierEnrollment` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment">ScreenMembersOnPhoneIdentifierEnrollment</a></span>}> +{/*> **screen**: [`ScreenMembersOnPhoneIdentifierEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment)*/} + +Defined in: [src/screens/phone-identifier-enrollment/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L18) + +#### Implementation of + +[`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.PHONE_IDENTIFIER_ENROLLMENT`*/} + +Defined in: [src/screens/phone-identifier-enrollment/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L17) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continuePhoneEnrollment' type='Promise<void>'> +{/*> **continuePhoneEnrollment**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/phone-identifier-enrollment/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L37) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions">PhoneEnrollmentOptions</a></span>}> +[`PhoneEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment'; + +const phoneIdentifierEnrollment = new PhoneIdentifierEnrollment(); +phoneIdentifierChallenge.continuePhoneEnrollment({ + type: "<text' | 'voice>" +}); +``` + +#### Implementation of + +[`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers).[`continuePhoneEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.md#continuephoneenrollment) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='returnToPrevious' type='Promise<void>'> +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/phone-identifier-enrollment/index.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L52) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment'; + +const phoneIdentifierEnrollment = new PhoneIdentifierEnrollment(); +phoneIdentifierChallenge.returnToPrevious(); +``` + +#### Implementation of + +[`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers).[`returnToPrevious`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.md#returntoprevious) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/RedeemTicket.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/RedeemTicket.mdx new file mode 100644 index 000000000..51e1af647 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/RedeemTicket.mdx @@ -0,0 +1,283 @@ +--- +title: "RedeemTicket" +--- + +Defined in: [src/screens/redeem-ticket/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/redeem-ticket/index.ts#L12) + +Implements the redeem-ticket screen functionality. + + +<RequestExample> +```ts +export default class RedeemTicket extends BaseContext implements RedeemTicketMembers { + static screenIdentifier: string = ScreenIds.REDEEM_TICKET; + + /** + * Initializes a new instance of the RedeemTicket class. + */ + constructor() { + super(); + } + + /** + * Performs the default action on the redeem-ticket screen, usually continuing the flow. + * + * @param payload - Optional custom options to include with the request. + * @returns A promise that resolves when the action is complete. + * @throws {Error} If the operation fails. + * + * @example + * ```ts + * import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; + * + * const redeemTicket = new RedeemTicket(); + * await redeemTicket.continue(); + * ``` + */ + async continue(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [RedeemTicket.screenIdentifier, 'continue'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.DEFAULT, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers) + +## Constructors + +<ParamField body="RedeemTicket" type="Constructor"> +{/*> **new RedeemTicket**(): `RedeemTicket`*/} + +Defined in: [src/screens/redeem-ticket/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/redeem-ticket/index.ts#L18) + +Initializes a new instance of the RedeemTicket class. + +#### Returns + +`RedeemTicket` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.REDEEM_TICKET`*/} + +Defined in: [src/screens/redeem-ticket/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/redeem-ticket/index.ts#L13) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/redeem-ticket/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/redeem-ticket/index.ts#L37) + +Performs the default action on the redeem-ticket screen, usually continuing the flow. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is complete. + +#### Throws + +If the operation fails. + +#### Example + +```ts +import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; + +const redeemTicket = new RedeemTicket(); +await redeemTicket.continue(); +``` + +#### Implementation of + +[`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPassword.mdx new file mode 100644 index 000000000..b0eebdb47 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPassword.mdx @@ -0,0 +1,301 @@ +--- +title: "ResetPassword" +--- + +Defined in: [src/screens/reset-password/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password/index.ts#L19) + + +<RequestExample> +```ts +export default class ResetPassword extends BaseContext implements ResetPasswordMembers { + static screenIdentifier: string = ScreenIds.RESET_PASSWORD; + screen: ScreenOptions; + transaction: TransactionOptions; + + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + const transactionContext = this.getContext('transaction') as TransactionContext; + + this.transaction = new TransactionOverride(transactionContext); + } + /** + * @example + * import ResetPassword from '@auth0/auth0-acul-js/reset-password'; + * + * const resetPassword = new ResetPassword(); + * resetPassword.resetPassword({ + * 'password-reset': 'Test@123!', + * 're-enter-password': 'Test@123!', + * }); + */ + async resetPassword(payload: ResetPasswordOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPassword.screenIdentifier, 'resetPassword'], + }; + await new FormHandler(options).submitData(payload); + } + + /** + * @param password + * @returns An object of type {@link PasswordValidationResult} indicating whether the password is valid and why. + * @utilityFeature + */ + validatePassword(password: string): PasswordValidationResult { + const passwordPolicy = this.transaction?.passwordPolicy; + return _validatePassword(password, passwordPolicy); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers) + +## Constructors + +<ParamField body="ResetPassword" type="Constructor"> +{/*> **new ResetPassword**(): `ResetPassword`*/} + +Defined in: [src/screens/reset-password/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password/index.ts#L24) + +#### Returns + +`ResetPassword` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword">ScreenMembersOnResetPassword</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword)*/} + +Defined in: [src/screens/reset-password/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password/index.ts#L21) + +#### Implementation of + +[`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword">TransactionMembersOnResetPassword</a></span>}> +{/*> **transaction**: [`TransactionMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword)*/} + +Defined in: [src/screens/reset-password/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password/index.ts#L22) + +#### Implementation of + +[`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.md#transaction) + +#### Overrides + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD`*/} + +Defined in: [src/screens/reset-password/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password/index.ts#L20) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='resetPassword' type='Promise<void>'> +{/*> **resetPassword**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password/index.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password/index.ts#L42) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions">ResetPasswordOptions</a></span>}> +[`ResetPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import ResetPassword from '@auth0/auth0-acul-js/reset-password'; + +const resetPassword = new ResetPassword(); +resetPassword.resetPassword({ + 'password-reset': 'Test@123!', + 're-enter-password': 'Test@123!', +}); +``` + +#### Implementation of + +[`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers).[`resetPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.md#resetpassword) + +</ParamField> + +<ParamField body='validatePassword' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> +{/*> **validatePassword**(`password`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult)*/} + +Defined in: [src/screens/reset-password/index.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password/index.ts#L55) + +**`Utility Feature`** + +<Expandable title="Parameters"> +<ParamField body='password' type='string'> +`string` +</ParamField> +</Expandable> + +#### Returns + +[`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult) + +An object of type [PasswordValidationResult](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult) indicating whether the password is valid and why. + +#### Implementation of + +[`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers).[`validatePassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.md#validatepassword) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordEmail.mdx new file mode 100644 index 000000000..2254f4801 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordEmail.mdx @@ -0,0 +1,256 @@ +--- +title: "ResetPasswordEmail" +--- + +Defined in: [src/screens/reset-password-email/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-email/index.ts#L16) + + +<RequestExample> +```ts +export default class ResetPasswordEmail extends BaseContext implements ResetPasswordEmailMembers { + static screenIdentifier: string = ScreenIds.RESET_PASSWORD_EMAIL; + screen: ScreenOptions; + + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + /** + * @example + * import ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email'; + * + * const resetPasswordEmail = new ResetPasswordEmail(); + * resetPasswordEmail.resendEmail(); + */ + async resendEmail(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordEmail.screenIdentifier, 'resendEmail'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND_EMAIL }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers) + +## Constructors + +<ParamField body="ResetPasswordEmail" type="Constructor"> +{/*> **new ResetPasswordEmail**(): `ResetPasswordEmail`*/} + +Defined in: [src/screens/reset-password-email/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-email/index.ts#L20) + +#### Returns + +`ResetPasswordEmail` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail">ScreenMembersOnResetPasswordEmail</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordEmail`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail)*/} + +Defined in: [src/screens/reset-password-email/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-email/index.ts#L18) + +#### Implementation of + +[`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_EMAIL`*/} + +Defined in: [src/screens/reset-password-email/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-email/index.ts#L17) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='resendEmail' type='Promise<void>'> +{/*> **resendEmail**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-email/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-email/index.ts#L32) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email'; + +const resetPasswordEmail = new ResetPasswordEmail(); +resetPasswordEmail.resendEmail(); +``` + +#### Implementation of + +[`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers).[`resendEmail`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.md#resendemail) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordError.mdx new file mode 100644 index 000000000..e6148d7cc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordError.mdx @@ -0,0 +1,212 @@ +--- +title: "ResetPasswordError" +--- + +Defined in: [src/screens/reset-password-error/index.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-error/index.ts#L8) + + +<RequestExample> +```ts +export default class ResetPasswordError extends BaseContext implements ResetPasswordErrorMembers { + static screenIdentifier: string = ScreenIds.RESET_PASSWORD_ERROR; + screen: ScreenOptions; + + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers) + +## Constructors + +<ParamField body="ResetPasswordError" type="Constructor"> +{/*> **new ResetPasswordError**(): `ResetPasswordError`*/} + +Defined in: [src/screens/reset-password-error/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-error/index.ts#L12) + +#### Returns + +`ResetPasswordError` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError">ScreenMembersOnResetPasswordError</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError)*/} + +Defined in: [src/screens/reset-password-error/index.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-error/index.ts#L10) + +#### Implementation of + +[`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_ERROR`*/} + +Defined in: [src/screens/reset-password-error/index.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-error/index.ts#L9) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge.mdx new file mode 100644 index 000000000..2b9a355c3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge.mdx @@ -0,0 +1,469 @@ +--- +title: "ResetPasswordMfaEmailChallenge" +--- + +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L23) + +Class implementing the reset-password-mfa-email-challenge screen functionality + + +<RequestExample> +```ts +export default class ResetPasswordMfaEmailChallenge extends BaseContext implements ResetPasswordMfaEmailChallengeMembers { + static screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_EMAIL_CHALLENGE; + screen: ScreenOptions; + + /** + * Creates an instance of ResetPasswordMfaEmailChallenge screen manager + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Continues with the email challenge using the provided code. + * @param payload The options containing the code and rememberDevice flag. + * @example + * ```typescript + * import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; + * + * const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); + * await resetPasswordMfaEmailChallenge.continue({ + * code: '123456', + * }); + * ``` + */ + async continue(payload: ContinueOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaEmailChallenge.screenIdentifier, 'continue'], + }; + const submitPayload: Record<string, string | number | boolean> = { ...payload, action: 'default' }; + + await new FormHandler(options).submitData(submitPayload); + } + + /** + * Resends the email code. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; + * + * const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); + * await resetPasswordMfaEmailChallenge.resendCode(); + * ``` + */ + async resendCode(payload?: ResendCodeOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaEmailChallenge.screenIdentifier, 'resendCode'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND_CODE }); + } + + /** + * Allows the user to try another MFA method. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; + * + * const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); + * await resetPasswordMfaEmailChallenge.tryAnotherMethod(); + * ``` + */ + async tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaEmailChallenge.screenIdentifier, 'tryAnotherMethod'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.PICK_AUTHENTICATOR }); + } + + /** + * Gets resend functionality with timeout management for this screen + * @param options - Configuration options for resend functionality + * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) + * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) + * @param options.onTimeout - Callback to execute when timeout countdown reaches zero + * @returns ResendControl object with startResend method + * @utilityFeature + * + * @example + * ```typescript + * import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; + * + * const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); + * const { startResend } = resetPasswordMfaEmailChallenge.resendManager({ + * timeoutSeconds: 15, + * onStatusChange: (remainingSeconds, isDisabled) => { + * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + * }, + * onTimeout: () => { + * console.log('Resend is now available'); + * } + * }); + * + * // Call startResend when user clicks resend button + * startResend(); + * ``` + */ + resendManager(options?: StartResendOptions): ResendControl { + return createResendControl( + ResetPasswordMfaEmailChallenge.screenIdentifier, + () => this.resendCode(), + options + ); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers) + +## Constructors + +<ParamField body="ResetPasswordMfaEmailChallenge" type="Constructor"> +{/*> **new ResetPasswordMfaEmailChallenge**(): `ResetPasswordMfaEmailChallenge`*/} + +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L30) + +Creates an instance of ResetPasswordMfaEmailChallenge screen manager + +#### Returns + +`ResetPasswordMfaEmailChallenge` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge">ScreenMembersOnResetPasswordMfaEmailChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge)*/} + +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L25) + +#### Implementation of + +[`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_EMAIL_CHALLENGE`*/} + +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L24) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L49) + +Continues with the email challenge using the provided code. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions">ContinueOptions</a></span>}> +[`ContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions) + +The options containing the code and rememberDevice flag. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; + +const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); +await resetPasswordMfaEmailChallenge.continue({ + code: '123456', +}); +``` + +#### Implementation of + +[`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:70](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L70) + +Resends the email code. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions">ResendCodeOptions</a></span>}> +[`ResendCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; + +const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); +await resetPasswordMfaEmailChallenge.resendCode(); +``` + +#### Implementation of + +[`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers).[`resendCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.md#resendcode) + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:125](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L125) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +#### Example + +```typescript +import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; + +const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); +const { startResend } = resetPasswordMfaEmailChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: (remainingSeconds, isDisabled) => { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + }, + onTimeout: () => { + console.log('Resend is now available'); + } +}); + +// Call startResend when user clicks resend button +startResend(); +``` + +#### Implementation of + +[`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers).[`resendManager`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.md#resendmanager) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L89) + +Allows the user to try another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> +[`TryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; + +const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); +await resetPasswordMfaEmailChallenge.tryAnotherMethod(); +``` + +#### Implementation of + +[`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge.mdx new file mode 100644 index 000000000..777b796f6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge.mdx @@ -0,0 +1,336 @@ +--- +title: "ResetPasswordMfaOtpChallenge" +--- + +Defined in: [src/screens/reset-password-mfa-otp-challenge/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L16) + +Class implementing the reset-password-mfa-otp-challenge screen functionality + + +<RequestExample> +```ts +export default class ResetPasswordMfaOtpChallenge extends BaseContext implements ResetPasswordMfaOtpChallengeMembers { + /** + * Screen identifier for validation and telemetry + */ + static screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_OTP_CHALLENGE; + /** + * Creates an instance of ResetPasswordMfaOtpChallenge screen manager + */ + constructor() { + super(); + } + + /** + * Continues with the OTP challenge using the provided code. + * @param payload The options containing the code. + * @example + * ```typescript + * import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge'; + * + * const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge(); + * await resetPasswordMfaOtpChallenge.continue({ + * code: '123456', + * }); + * ``` + */ + async continue(payload: ContinueOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaOtpChallenge.screenIdentifier, 'continue'], + }; + await new FormHandler(options).submitData<ContinueOptions>({ + ...payload, + action: FormActions.DEFAULT, + }); + } + + /** + * Allows the user to try another MFA method. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge'; + * + * const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge(); + * await resetPasswordMfaOtpChallenge.tryAnotherMethod(); + * ``` + */ + async tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaOtpChallenge.screenIdentifier, 'continue'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers) + +## Constructors + +<ParamField body="ResetPasswordMfaOtpChallenge" type="Constructor"> +{/*> **new ResetPasswordMfaOtpChallenge**(): `ResetPasswordMfaOtpChallenge`*/} + +Defined in: [src/screens/reset-password-mfa-otp-challenge/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L24) + +Creates an instance of ResetPasswordMfaOtpChallenge screen manager + +#### Returns + +`ResetPasswordMfaOtpChallenge` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_OTP_CHALLENGE`*/} + +Defined in: [src/screens/reset-password-mfa-otp-challenge/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L20) + +Screen identifier for validation and telemetry + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-otp-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L41) + +Continues with the OTP challenge using the provided code. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions">ResetPasswordMfaOtpChallengeContinueOptions</a></span>}> +[`ResetPasswordMfaOtpChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions) + +The options containing the code. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge'; + +const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge(); +await resetPasswordMfaOtpChallenge.continue({ + code: '123456', +}); +``` + +#### Implementation of + +[`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-otp-challenge/index.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L63) + +Allows the user to try another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions">ResetPasswordMfaOtpChallengeTryAnotherMethodOptions</a></span>}> +[`ResetPasswordMfaOtpChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge'; + +const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge(); +await resetPasswordMfaOtpChallenge.tryAnotherMethod(); +``` + +#### Implementation of + +[`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge.mdx new file mode 100644 index 000000000..9a809502d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge.mdx @@ -0,0 +1,420 @@ +--- +title: "ResetPasswordMfaPhoneChallenge" +--- + +Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L23) + +ResetPasswordMfaPhoneChallenge + + +<RequestExample> +```ts +export default class ResetPasswordMfaPhoneChallenge extends BaseContext implements ResetPasswordMfaPhoneChallengeMembers { + /** + * The unique identifier for this screen, used internally and for telemetry. + * @type {string} + */ + static screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_PHONE_CHALLENGE; // Use the exact screen name from context definition + + /** + * Holds the specific screen data and properties, processed by ScreenOverride. + * @type {ScreenOptions} + */ + screen: ScreenOptions; + + /** + * Initializes a new instance of the `ResetPasswordMfaPhoneChallenge` class. + * It retrieves the screen context and sets up the screen-specific properties. + * @throws {Error} If the Universal Login Context is not available or if the screen name doesn't match. + */ + constructor() { + super(); // Calls BaseContext constructor which handles context retrieval and validation + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Sends the verification code to the user's phone via the selected method (SMS or Voice). + * Corresponds to the 'Continue' action in the OpenAPI definition (action: 'default'). + * + * @param {ContinueOptions} payload - Contains the delivery type (`sms` or `voice`) and any optional custom data. + * @returns {Promise<void>} A promise resolving upon successful submission to the server. + * @throws {Error} If the form submission fails. + * @example + * ```typescript + * const screen = new ResetPasswordMfaPhoneChallenge(); + * try { + * await screen.continue({ type: 'sms' }); + * // Redirects to code entry screen on success + * } catch (error) { + * console.error("Failed to send SMS code:", error); + * } + * ``` + */ + async continue(payload: ContinueOptions): Promise<void> { + // Prepare options for the FormHandler + const formHandlerOptions: FormOptions = { + // The state token identifying the current transaction + state: this.transaction.state, + // Telemetry data identifying the screen and method for monitoring + telemetry: [ResetPasswordMfaPhoneChallenge.screenIdentifier, 'continue'], + // The route endpoint for this action (typically inferred if not provided) + // As per OpenAPI, the endpoint is /u/mfa-phone-challenge + route: '/u/mfa-phone-challenge', + }; + + // Construct the data payload to be sent in the form submission + const submitPayload = { + // Include any other custom options passed in the payload + ...payload, + // Set the action to 'default' as specified by the OpenAPI definition for this operation + action: FormActions.DEFAULT, + }; + + // Use FormHandler to submit the data via a POST request + await new FormHandler(formHandlerOptions).submitData(submitPayload); + } + + /** + * Initiates the process for the user to select a different MFA authenticator. + * Corresponds to the 'Try Another Method' action in the OpenAPI definition (action: 'pick-authenticator'). + * + * @param {TryAnotherMethodOptions} payload - Contains the *current* challenge type (`sms` or `voice`) as required by the API, and any optional custom data. + * @returns {Promise<void>} A promise resolving upon successful submission to the server. + * @throws {Error} If the form submission fails. + * @example + * ```typescript + * const screen = new ResetPasswordMfaPhoneChallenge(); + * try { + * // Assuming the current screen was for SMS + * await screen.tryAnotherMethod({ type: 'sms' }); + * // Redirects to authenticator selection screen on success + * } catch (error) { + * console.error("Failed to switch MFA method:", error); + * } + * ``` + */ + async tryAnotherMethod(payload: TryAnotherMethodOptions): Promise<void> { + // Prepare options for the FormHandler + const formHandlerOptions: FormOptions = { + // The state token identifying the current transaction + state: this.transaction.state, + // Telemetry data identifying the screen and method + telemetry: [ResetPasswordMfaPhoneChallenge.screenIdentifier, 'tryAnotherMethod'], + // The route endpoint for this action + route: '/u/mfa-phone-challenge', + }; + + // Construct the data payload for the form submission + const submitPayload = { + // Include any other custom options passed in the payload + ...payload, + // Set the action to 'pick-authenticator' as specified by the OpenAPI definition + action: FormActions.PICK_AUTHENTICATOR, + }; + + // Use FormHandler to submit the data + await new FormHandler(formHandlerOptions).submitData(submitPayload); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers) + +## Constructors + +<ParamField body="ResetPasswordMfaPhoneChallenge" type="Constructor"> +{/*> **new ResetPasswordMfaPhoneChallenge**(): `ResetPasswordMfaPhoneChallenge`*/} + +Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L41) + +Initializes a new instance of the `ResetPasswordMfaPhoneChallenge` class. +It retrieves the screen context and sets up the screen-specific properties. + +#### Returns + +`ResetPasswordMfaPhoneChallenge` + +#### Throws + +If the Universal Login Context is not available or if the screen name doesn't match. + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +Access to client-specific information (e.g., client ID, name). + +#### Implementation of + +[`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +Access to organization-specific information, if applicable. + +#### Implementation of + +[`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +Access to prompt details (e.g., prompt name). + +#### Implementation of + +[`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge">ScreenMembersOnResetPasswordMfaPhoneChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge)*/} + +Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L34) + +Holds the specific screen data and properties, processed by ScreenOverride. + +#### Implementation of + +[`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +Access to the current transaction details (e.g., state, errors). + +#### Implementation of + +[`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_PHONE_CHALLENGE`*/} + +Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L28) + +The unique identifier for this screen, used internally and for telemetry. + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:65](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L65) + +Sends the verification code to the user's phone via the selected method (SMS or Voice). +Corresponds to the 'Continue' action in the OpenAPI definition (action: 'default'). + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions">ResetPasswordMfaPhoneChallengeContinueOptions</a></span>}> +[`ResetPasswordMfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions) + +Contains the delivery type (`sms` or `voice`) and any optional custom data. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise resolving upon successful submission to the server. + +#### Throws + +If the form submission fails. + +#### Example + +```typescript +const screen = new ResetPasswordMfaPhoneChallenge(); +try { + await screen.continue({ type: 'sms' }); + // Redirects to code entry screen on success +} catch (error) { + console.error("Failed to send SMS code:", error); +} +``` + +#### Implementation of + +[`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:108](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L108) + +Initiates the process for the user to select a different MFA authenticator. +Corresponds to the 'Try Another Method' action in the OpenAPI definition (action: 'pick-authenticator'). + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions">ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions</a></span>}> +[`ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions) + +Contains the *current* challenge type (`sms` or `voice`) as required by the API, and any optional custom data. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise resolving upon successful submission to the server. + +#### Throws + +If the form submission fails. + +#### Example + +```typescript +const screen = new ResetPasswordMfaPhoneChallenge(); +try { + // Assuming the current screen was for SMS + await screen.tryAnotherMethod({ type: 'sms' }); + // Redirects to authenticator selection screen on success +} catch (error) { + console.error("Failed to switch MFA method:", error); +} +``` + +#### Implementation of + +[`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush.mdx new file mode 100644 index 000000000..5aacc7a92 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush.mdx @@ -0,0 +1,546 @@ +--- +title: "ResetPasswordMfaPushChallengePush" +--- + +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L21) + +Class representing the reset-password-mfa-push-challenge-push screen functionality +This screen is shown when a push notification has been sent to the user's device during password reset + + +<RequestExample> +```ts +export default class ResetPasswordMfaPushChallengePush extends BaseContext implements ResetPasswordMfaPushChallengePushMembers { + static screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_PUSH_CHALLENGE_PUSH; + screen: ScreenOptions; + + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Continues with the push notification challenge + * @param payload Optional custom options to include with the request + * @example + * ```typescript + * import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; + * + * const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); + * await resetPasswordMfaPushChallengePush.continue(); + * ``` + */ + async continue(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaPushChallengePush.screenIdentifier, 'continue'], + }; + await new FormHandler(options).submitData<CustomOptions>(payload || {}); + } + + /** + * Re-sends the push notification + * @param payload Optional custom options to include with the request + * @example + * ```typescript + * import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; + * + * const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); + * await resetPasswordMfaPushChallengePush.resendPushNotification(); + * ``` + */ + async resendPushNotification(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaPushChallengePush.screenIdentifier, 'resendPushNotification'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.RESEND, + }); + } + + /** + * Switches to entering the verification code manually + * @param payload Optional custom options to include with the request + * @example + * ```typescript + * import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; + * + * const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); + * await resetPasswordMfaPushChallengePush.enterCodeManually(); + * ``` + */ + async enterCodeManually(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaPushChallengePush.screenIdentifier, 'enterCodeManually'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.ENTER_OTP_CODE, + }); + } + + /** + * Allows trying another authentication method + * @param payload Optional custom options to include with the request + * @example + * ```typescript + * import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; + * + * const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); + * await resetPasswordMfaPushChallengePush.tryAnotherMethod(); + * ``` + */ + async tryAnotherMethod(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaPushChallengePush.screenIdentifier, 'tryAnotherMethod'], + }; + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } + + /** + * Starts and manages polling for an MFA push challenge. + * + * Creates a polling session that repeatedly checks the MFA push challenge endpoint + * at the specified interval until the challenge is approved or an error occurs. + * When the approval condition is met, the provided + * {@link MfaPollingOptions.onCompleted | onCompleted} callback is invoked and + * polling stops automatically. + * + * Use the returned {@link MfaPushPollingControl} to start, stop, or check the + * status of the polling process at any time. + * + * @param options - {@link MfaPollingOptions | Configuration options} for the polling process: + * - `intervalMs` — Optional polling interval in milliseconds (defaults to SDK’s internal value, typically 5000 ms). + * - `onCompleted` — Optional callback fired when the MFA push is successfully approved. + * - `onError` — Optional callback fired when a polling error occurs, receiving an {@link ULError}. + * + * @returns A {@link MfaPushPollingControl} instance exposing: + * - `startPolling()` — Starts or resumes polling. + * - `stopPolling()` — Cancels polling immediately. + * - `isRunning()` — Indicates whether polling is currently active. + * + * @utilityFeature + * + * @example + * ```ts + * // Start polling every 5 seconds until the push challenge is approved + * const control = mfaPushChallengePush.pollingManager({ + * intervalMs: 5000, + * onCompleted: () => mfaPushChallengePush.continue(), + * onError: (error) => console.error('Polling error:', error), + * }); + * + * // Later, cancel polling if needed + * control.stopPolling(); + * ``` + * + * @remarks + * - HTTP 429 (rate limit) responses are handled internally: polling automatically + * waits until the rate limit resets before retrying. + * - Safe to call `startPolling()` multiple times; it has no effect if already running. + */ + pollingManager(options: MfaPollingOptions = {}): MfaPushPollingControl { + return createPollingControl(options); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers) + +## Constructors + +<ParamField body="ResetPasswordMfaPushChallengePush" type="Constructor"> +{/*> **new ResetPasswordMfaPushChallengePush**(): `ResetPasswordMfaPushChallengePush`*/} + +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L25) + +#### Returns + +`ResetPasswordMfaPushChallengePush` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush">ScreenMembersOnResetPasswordMfaPushChallengePush</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush)*/} + +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L23) + +#### Implementation of + +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_PUSH_CHALLENGE_PUSH`*/} + +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L22) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L42) + +Continues with the push notification challenge + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; + +const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); +await resetPasswordMfaPushChallengePush.continue(); +``` + +#### Implementation of + +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.md#continue) + +</ParamField> + +<ParamField body='enterCodeManually' type='Promise<void>'> +{/*> **enterCodeManually**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L83) + +Switches to entering the verification code manually + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; + +const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); +await resetPasswordMfaPushChallengePush.enterCodeManually(); +``` + +#### Implementation of + +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers).[`enterCodeManually`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.md#entercodemanually) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='pollingManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> +{/*> **pollingManager**(`options`): [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl)*/} + +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:158](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L158) + +**`Utility Feature`** + +Starts and manages polling for an MFA push challenge. + +Creates a polling session that repeatedly checks the MFA push challenge endpoint +at the specified interval until the challenge is approved or an error occurs. +When the approval condition is met, the provided +[onCompleted](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions.md#oncompleted) callback is invoked and +polling stops automatically. + +Use the returned [MfaPushPollingControl](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) to start, stop, or check the +status of the polling process at any time. + +<Expandable title="Parameters"> +<ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions">MfaPollingOptions</a></span>}> +[`MfaPollingOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions) = `{}` + +[Configuration options](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions) for the polling process: +- `intervalMs` — Optional polling interval in milliseconds (defaults to SDK’s internal value, typically 5000 ms). +- `onCompleted` — Optional callback fired when the MFA push is successfully approved. +- `onError` — Optional callback fired when a polling error occurs, receiving an [ULError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error). +</ParamField> +</Expandable> + +#### Returns + +[`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) + +A [MfaPushPollingControl](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) instance exposing: +- `startPolling()` — Starts or resumes polling. +- `stopPolling()` — Cancels polling immediately. +- `isRunning()` — Indicates whether polling is currently active. + +#### Example + +```ts +// Start polling every 5 seconds until the push challenge is approved +const control = mfaPushChallengePush.pollingManager({ + intervalMs: 5000, + onCompleted: () => mfaPushChallengePush.continue(), + onError: (error) => console.error('Polling error:', error), +}); + +// Later, cancel polling if needed +control.stopPolling(); +``` + +#### Remarks + +- HTTP 429 (rate limit) responses are handled internally: polling automatically + waits until the rate limit resets before retrying. +- Safe to call `startPolling()` multiple times; it has no effect if already running. + +#### Implementation of + +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers).[`pollingManager`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.md#pollingmanager) + +</ParamField> + +<ParamField body='resendPushNotification' type='Promise<void>'> +{/*> **resendPushNotification**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L61) + +Re-sends the push notification + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; + +const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); +await resetPasswordMfaPushChallengePush.resendPushNotification(); +``` + +#### Implementation of + +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers).[`resendPushNotification`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.md#resendpushnotification) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:105](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L105) + +Allows trying another authentication method + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; + +const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); +await resetPasswordMfaPushChallengePush.tryAnotherMethod(); +``` + +#### Implementation of + +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx new file mode 100644 index 000000000..f09b4771e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx @@ -0,0 +1,361 @@ +--- +title: "ResetPasswordMfaRecoveryCodeChallenge" +--- + +Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L12) + +Class implementing the Reset Password MFA Recovery Code Challenge screen functionality. + + +<RequestExample> +```ts +export default class ResetPasswordMfaRecoveryCodeChallenge extends BaseContext implements ResetPasswordMfaRecoveryCodeChallengeMembers { + static screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_RECOVERY_CODE_CHALLENGE; + + /** + * Creates an instance of the ResetPasswordMfaRecoveryCodeChallenge screen. + */ + constructor() { + super(); + } + + /** + * Continues with the provided recovery code. + * @param {string} code - The recovery code entered by the user. + * @param {CustomOptions} [payload] - Optional payload. + * @returns {Promise<void>} + * @example + * ```typescript + * import ResetPasswordMfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/reset-password-mfa-recovery-code-challenge'; + * const resetPasswordMfaManager = new ResetPasswordMfaRecoveryCodeChallenge(); + * const continueWithRecoveryCode = async () => { + * try { + * await resetPasswordMfaManager.continue('RECOVERY_CODE'); + * console.log('Recovery code submitted successfully.'); + * } catch (error) { + * console.error('Error submitting recovery code:', error); + * } + * }; + * ``` + */ + async continue(code: string, payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaRecoveryCodeChallenge.screenIdentifier, 'continue'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + code, + action: FormActions.DEFAULT, + }); + } + + /** + * Navigates to the screen where the user can pick another MFA method. + * @param {CustomOptions} [payload] - Optional payload. + * @returns {Promise<void>} + * @example + * ```typescript + * import ResetPasswordMfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/reset-password-mfa-recovery-code-challenge'; + * const resetPasswordMfaRecoveryCodeChallengeManager = new ResetPasswordMfaRecoveryCodeChallenge(); + * const handleTryAnotherMethod = async () => { + * try { + * await resetPasswordMfaRecoveryCodeChallengeManager.tryAnotherMethod(); + * } catch (error) { + * console.error('Failed to try another method:', error); + * } + * }; + * ``` + */ + async tryAnotherMethod(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaRecoveryCodeChallenge.screenIdentifier, 'tryAnotherMethod'], + }; + + await new FormHandler(options).submitData<CustomOptions>({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers) + +## Constructors + +<ParamField body="ResetPasswordMfaRecoveryCodeChallenge" type="Constructor"> +{/*> **new ResetPasswordMfaRecoveryCodeChallenge**(): `ResetPasswordMfaRecoveryCodeChallenge`*/} + +Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L18) + +Creates an instance of the ResetPasswordMfaRecoveryCodeChallenge screen. + +#### Returns + +`ResetPasswordMfaRecoveryCodeChallenge` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_RECOVERY_CODE_CHALLENGE`*/} + +Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L13) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`code`, `payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L41) + +Continues with the provided recovery code. + +<Expandable title="Parameters"> +<ParamField body='code' type='string'> +`string` + +The recovery code entered by the user. +</ParamField> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import ResetPasswordMfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/reset-password-mfa-recovery-code-challenge'; +const resetPasswordMfaManager = new ResetPasswordMfaRecoveryCodeChallenge(); +const continueWithRecoveryCode = async () => { + try { + await resetPasswordMfaManager.continue('RECOVERY_CODE'); + console.log('Recovery code submitted successfully.'); + } catch (error) { + console.error('Error submitting recovery code:', error); + } +}; +``` + +#### Implementation of + +[`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:71](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L71) + +Navigates to the screen where the user can pick another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import ResetPasswordMfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/reset-password-mfa-recovery-code-challenge'; +const resetPasswordMfaRecoveryCodeChallengeManager = new ResetPasswordMfaRecoveryCodeChallenge(); +const handleTryAnotherMethod = async () => { + try { + await resetPasswordMfaRecoveryCodeChallengeManager.tryAnotherMethod(); + } catch (error) { + console.error('Failed to try another method:', error); + } +}; +``` + +#### Implementation of + +[`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge.mdx new file mode 100644 index 000000000..a86347a85 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge.mdx @@ -0,0 +1,520 @@ +--- +title: "ResetPasswordMfaSmsChallenge" +--- + +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L22) + +This class provides methods to handle the reset-password-mfa-sms-challenge screen. + + +<RequestExample> +```ts +export default class ResetPasswordMfaSmsChallenge extends BaseContext implements ResetPasswordMfaSmsChallengeMembers { + static screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_SMS_CHALLENGE; + screen: ScreenOptions; + + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Submits the MFA SMS challenge with the provided code. + * @param {MfaSmsChallengeOptions} payload - The payload containing the code. + * @returns {Promise<void>} + * @example + * ```typescript + * import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; + * + * const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); + * await resetPasswordMfaSmsChallenge.continueMfaSmsChallenge({ + * code: '123456', + * }); + * ``` + */ + async continueMfaSmsChallenge(payload: MfaSmsChallengeOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaSmsChallenge.screenIdentifier, 'continueMfaSmsChallenge'], + }; + const submitPayload: Record<string, string | number | boolean> = { ...payload, action: 'default' }; + await new FormHandler(options).submitData(submitPayload); + } + + /** + * Submits the action to resend the SMS code. + * @param {CustomOptions} [payload] - Optional payload. + * @returns {Promise<void>} + * @example + * ```typescript + * import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; + * + * const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); + * await resetPasswordMfaSmsChallenge.resendCode(); + * ``` + */ + async resendCode(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaSmsChallenge.screenIdentifier, 'resendCode'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND_CODE }); + } + + /** + * Submits the action to try another MFA method. + * @param {CustomOptions} [payload] - Optional payload. + * @returns {Promise<void>} + * @example + * ```typescript + * import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; + * + * const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); + * await resetPasswordMfaSmsChallenge.tryAnotherMethod(); + * ``` + */ + async tryAnotherMethod(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaSmsChallenge.screenIdentifier, 'tryAnotherMethod'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.PICK_AUTHENTICATOR }); + } + + /** + * Submits the action to switch to voice call verification. + * @param {CustomOptions} [payload] - Optional payload. + * @returns {Promise<void>} + * @example + * ```typescript + * import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; + * + * const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); + * await resetPasswordMfaSmsChallenge.getACall(); + * ``` + */ + async getACall(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaSmsChallenge.screenIdentifier, 'getACall'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.SWITCH_TO_VOICE }); + } + + /** + * Gets resend functionality with timeout management for this screen + * @param options - Configuration options for resend functionality + * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) + * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) + * @param options.onTimeout - Callback to execute when timeout countdown reaches zero + * @returns ResendControl object with startResend method + * @utilityFeature + * + * @example + * ```typescript + * import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; + * + * const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); + * const { startResend } = resetPasswordMfaSmsChallenge.resendManager({ + * timeoutSeconds: 15, + * onStatusChange: (remainingSeconds, isDisabled) => { + * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + * }, + * onTimeout: () => { + * console.log('Resend is now available'); + * } + * }); + * + * // Call startResend when user clicks resend button + * startResend(); + * ``` + */ + resendManager(options?: StartResendOptions): ResendControl { + return createResendControl( + ResetPasswordMfaSmsChallenge.screenIdentifier, + () => this.resendCode(), + options + ); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers) + +## Constructors + +<ParamField body="ResetPasswordMfaSmsChallenge" type="Constructor"> +{/*> **new ResetPasswordMfaSmsChallenge**(): `ResetPasswordMfaSmsChallenge`*/} + +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L26) + +#### Returns + +`ResetPasswordMfaSmsChallenge` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge">ScreenMembersOnResetPasswordMfaSmsChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge)*/} + +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L24) + +#### Implementation of + +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_SMS_CHALLENGE`*/} + +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L23) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continueMfaSmsChallenge' type='Promise<void>'> +{/*> **continueMfaSmsChallenge**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L46) + +Submits the MFA SMS challenge with the provided code. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions">ResetPasswordMfaSmsChallengeOptions</a></span>}> +[`ResetPasswordMfaSmsChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions) + +The payload containing the code. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; + +const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); +await resetPasswordMfaSmsChallenge.continueMfaSmsChallenge({ + code: '123456', +}); +``` + +#### Implementation of + +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers).[`continueMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.md#continuemfasmschallenge) + +</ParamField> + +<ParamField body='getACall' type='Promise<void>'> +{/*> **getACall**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:107](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L107) + +Submits the action to switch to voice call verification. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; + +const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); +await resetPasswordMfaSmsChallenge.getACall(); +``` + +#### Implementation of + +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers).[`getACall`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.md#getacall) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:67](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L67) + +Submits the action to resend the SMS code. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; + +const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); +await resetPasswordMfaSmsChallenge.resendCode(); +``` + +#### Implementation of + +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers).[`resendCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.md#resendcode) + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:143](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L143) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +#### Example + +```typescript +import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; + +const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); +const { startResend } = resetPasswordMfaSmsChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: (remainingSeconds, isDisabled) => { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + }, + onTimeout: () => { + console.log('Resend is now available'); + } +}); + +// Call startResend when user clicks resend button +startResend(); +``` + +#### Implementation of + +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers).[`resendManager`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.md#resendmanager) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L87) + +Submits the action to try another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; + +const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); +await resetPasswordMfaSmsChallenge.tryAnotherMethod(); +``` + +#### Implementation of + +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge.mdx new file mode 100644 index 000000000..ec1100cdd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge.mdx @@ -0,0 +1,497 @@ +--- +title: "ResetPasswordMfaVoiceChallenge" +--- + +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L25) + +Class implementing the reset-password-mfa-voice-challenge screen functionality. + + +<RequestExample> +```ts +export default class ResetPasswordMfaVoiceChallenge extends BaseContext implements ResetPasswordMfaVoiceChallengeMembers { + static screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_VOICE_CHALLENGE; + screen: ScreenOptions; + + /** + * Creates an instance of ResetPasswordMfaVoiceChallenge screen manager. + */ + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + this.screen = new ScreenOverride(screenContext); + } + + /** + * Continues with the voice challenge using the provided code. + * + * @param payload - The options containing the code. + * @returns A promise that resolves when the challenge is submitted. + * + * @example + * ```ts + * const reset = new ResetPasswordMfaVoiceChallenge(); + * await reset.continue({ code: '123456' }); + * ``` + */ + async continue(payload: ContinueOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaVoiceChallenge.screenIdentifier, 'continue'], + }; + + await new FormHandler(options).submitData({ + ...payload, + action: FormActions.DEFAULT, + }); + } + + /** + * Switches to SMS verification. + * + * @param payload - Optional custom options to include with the request. + * @returns A promise that resolves when the action completes. + */ + async switchToSms(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaVoiceChallenge.screenIdentifier, 'switchToSms'], + }; + + await new FormHandler(options).submitData({ + ...payload, + action: FormActions.SWITCH_TO_SMS, + }); + } + + /** + * Resends the code via voice call. + * + * @param payload - Optional custom options to include with the request. + * @returns A promise that resolves when the code is resent. + */ + async resendCode(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaVoiceChallenge.screenIdentifier, 'resendCode'], + }; + + await new FormHandler(options).submitData({ + ...payload, + action: FormActions.RESEND_CODE, + }); + } + + /** + * Allows the user to try another MFA method. + * + * @param payload - Optional custom options to include with the request. + * @returns A promise that resolves when the request is submitted. + */ + async tryAnotherMethod(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordMfaVoiceChallenge.screenIdentifier, 'tryAnotherMethod'], + }; + + await new FormHandler(options).submitData({ + ...payload, + action: FormActions.PICK_AUTHENTICATOR, + }); + } + + /** + * Gets resend functionality with timeout management for this screen + * @param options - Configuration options for resend functionality + * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) + * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) + * @param options.onTimeout - Callback to execute when timeout countdown reaches zero + * @returns ResendControl object with startResend method + * @utilityFeature + * + * @example + * ```typescript + * import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge'; + * + * const resetPasswordMfaVoiceChallenge = new ResetPasswordMfaVoiceChallenge(); + * const { startResend } = resetPasswordMfaVoiceChallenge.resendManager({ + * timeoutSeconds: 15, + * onStatusChange: (remainingSeconds, isDisabled) => { + * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + * }, + * onTimeout: () => { + * console.log('Resend is now available'); + * } + * }); + * + * // Call startResend when user clicks resend button + * startResend(); + * ``` + */ + resendManager(options?: StartResendOptions): ResendControl { + return createResendControl( + ResetPasswordMfaVoiceChallenge.screenIdentifier, + () => this.resendCode(), + options + ); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers) + +## Constructors + +<ParamField body="ResetPasswordMfaVoiceChallenge" type="Constructor"> +{/*> **new ResetPasswordMfaVoiceChallenge**(): `ResetPasswordMfaVoiceChallenge`*/} + +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L32) + +Creates an instance of ResetPasswordMfaVoiceChallenge screen manager. + +#### Returns + +`ResetPasswordMfaVoiceChallenge` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge">ScreenMembersOnResetPasswordMfaVoiceChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge)*/} + +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L27) + +#### Implementation of + +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_VOICE_CHALLENGE`*/} + +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L26) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L50) + +Continues with the voice challenge using the provided code. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions">ResetPasswordMfaVoiceChallengeContinueOptions</a></span>}> +[`ResetPasswordMfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions) + +The options containing the code. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the challenge is submitted. + +#### Example + +```ts +const reset = new ResetPasswordMfaVoiceChallenge(); +await reset.continue({ code: '123456' }); +``` + +#### Implementation of + +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers).[`continue`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.md#continue) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L86) + +Resends the code via voice call. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the code is resent. + +#### Implementation of + +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers).[`resendCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.md#resendcode) + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:144](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L144) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +#### Example + +```typescript +import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge'; + +const resetPasswordMfaVoiceChallenge = new ResetPasswordMfaVoiceChallenge(); +const { startResend } = resetPasswordMfaVoiceChallenge.resendManager({ + timeoutSeconds: 15, + onStatusChange: (remainingSeconds, isDisabled) => { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + }, + onTimeout: () => { + console.log('Resend is now available'); + } +}); + +// Call startResend when user clicks resend button +startResend(); +``` + +#### Implementation of + +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers).[`resendManager`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.md#resendmanager) + +</ParamField> + +<ParamField body='switchToSms' type='Promise<void>'> +{/*> **switchToSms**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:68](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L68) + +Switches to SMS verification. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action completes. + +#### Implementation of + +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers).[`switchToSms`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.md#switchtosms) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:104](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L104) + +Allows the user to try another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the request is submitted. + +#### Implementation of + +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx new file mode 100644 index 000000000..1b94c71e3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,372 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallenge" +--- + +Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L37) + +ResetPasswordMfaWebAuthnPlatformChallenge + + +<RequestExample> +```ts +export default class ResetPasswordMfaWebAuthnPlatformChallenge +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers) + +## Constructors + +<ParamField body="ResetPasswordMfaWebAuthnPlatformChallenge" type="Constructor"> +{/*> **new ResetPasswordMfaWebAuthnPlatformChallenge**(): `ResetPasswordMfaWebAuthnPlatformChallenge`*/} + +Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L64) + +Initializes a new instance of the `ResetPasswordMfaWebAuthnPlatformChallenge` class. +It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context` +and sets up screen-specific properties via `ScreenOverride`. + +#### Returns + +`ResetPasswordMfaWebAuthnPlatformChallenge` + +#### Throws + +If the Universal Login Context is not available or if the screen name +in the context does not match `ResetPasswordMfaWebAuthnPlatformChallenge.screenIdentifier`. + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge">ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge)*/} + +Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L55) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_WEBAUTHN_PLATFORM_CHALLENGE`*/} + +Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L47) + +static + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='continueWithPasskey' type='Promise<void>'> +{/*> **continueWithPasskey**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:102](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L102) + +Initiates the WebAuthn platform authenticator challenge by calling `navigator.credentials.get()` +using the challenge options provided in `screen.publicKey`. +If successful, it submits the resulting credential assertion to Auth0 with `action: "default"`. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions">ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions</a></span>}> +[`ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions) + +Optional parameters for the verification process, +such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the verification attempt is submitted. + A successful operation typically results in a redirect. + +#### Throws + +Throws an error if `screen.publicKey` is missing, + if `navigator.credentials.get()` fails (e.g., user cancellation `NotAllowedError`), + or if the form submission to Auth0 fails. If `navigator.credentials.get()` fails + with a `DOMException`, it's recommended to catch that error and call `reportBrowserError`. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge +try { + await sdk.continueWithPasskey({ + rememberDevice: true // if user checked the box and sdk.screen.showRememberDevice is true + }); + // On success, Auth0 handles redirection. +} catch (error) { + console.error("Platform authenticator verification failed:", error); + // If it's a WebAuthn API error (DOMException), report it + if (error instanceof DOMException && error.name && error.message) { // DOMException check + await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + } + // Check sdk.transaction.errors for server-side validation messages if the page reloads. +} +``` + +#### Implementation of + +[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers).[`continueWithPasskey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.md#continuewithpasskey) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='reportBrowserError' type='Promise<void>'> +{/*> **reportBrowserError**(`options`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L168) + +Reports a browser-side error that occurred during the `navigator.credentials.get()` API call. +This is used to inform Auth0 about issues like user cancellation (`NotAllowedError`), +timeout, or other WebAuthn API specific errors. +It submits the error details with `action: "showError::{errorDetailsJsonString}"`. + +<Expandable title="Parameters"> +<ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions">ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions</a></span>}> +[`ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions) + +An object containing: + - `error`: A `WebAuthnErrorDetails` object with at least `name` and `message` properties + from the `DOMException` thrown by `navigator.credentials.get()`. + - Any other `CustomOptions` to be included in the form submission. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the error report is successfully submitted. + +#### Throws + +If the form submission fails (e.g., network error, invalid state). + +#### Example + +```typescript +// In your UI component, in the catch block of navigator.credentials.get(): +// } catch (webAuthnError) { +// if (webAuthnError instanceof DOMException) { +// await sdk.reportBrowserError({ +// error: { name: webAuthnError.name, message: webAuthnError.message } +// }); +// } else { +// // Handle other types of errors +// } +// } +``` + +#### Implementation of + +[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers).[`reportBrowserError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.md#reportbrowsererror) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:212](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L212) + +Allows the user to opt-out of the WebAuthn platform authenticator challenge and select +a different MFA method for verifying their identity during password reset. +This action submits `action: "pick-authenticator"` to Auth0, which should navigate +the user to an MFA factor selection screen. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions">ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions</a></span>}> +[`ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions) + +Optional. Any custom parameters to be sent with the request. + These will be included in the form data. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the 'pick-authenticator' action is submitted. + +#### Throws + +If the form submission fails (e.g., network error, invalid state). + +#### Example + +```typescript +// In your UI component, when a "Try Another Method" button is clicked: +try { + await sdk.tryAnotherMethod(); + // On success, Auth0 handles redirection to the MFA factor selection screen. +} catch (error) { + console.error("Failed to switch MFA method:", error); +} +``` + +#### Implementation of + +[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.md#tryanothermethod) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx new file mode 100644 index 000000000..65d44aef8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,380 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallenge" +--- + +Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L32) + +ResetPasswordMfaWebAuthnRoamingChallenge + + +<RequestExample> +```ts +export default class ResetPasswordMfaWebAuthnRoamingChallenge +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers) + +## Constructors + +<ParamField body="ResetPasswordMfaWebAuthnRoamingChallenge" type="Constructor"> +{/*> **new ResetPasswordMfaWebAuthnRoamingChallenge**(): `ResetPasswordMfaWebAuthnRoamingChallenge`*/} + +Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L58) + +Initializes a new instance of the `ResetPasswordMfaWebAuthnRoamingChallenge` class. +It retrieves the necessary context (screen, transaction, etc.) from the global + +#### Returns + +`ResetPasswordMfaWebAuthnRoamingChallenge` + +#### Throws + +If the Universal Login Context is not available or if the screen name +in the context does not match `ResetPasswordMfaWebAuthnRoamingChallenge.screenIdentifier`. + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge">ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge)*/} + +Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L50) + +Holds the specific screen data and properties for this screen, + +(for the WebAuthn challenge) and `showRememberDevice`. + +#### Implementation of + +[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `readonly` `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_WEBAUTHN_ROAMING_CHALLENGE`*/} + +Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L41) + +The unique identifier for this screen, used for internal SDK logic and telemetry. + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='showError' type='Promise<void>'> +{/*> **showError**(`options`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L170) + +Reports a client-side WebAuthn API error (from `navigator.credentials.get()`) to Auth0. +This method is intended to be called when [useSecurityKey](#usesecuritykey) (or a direct call to +`navigator.credentials.get()`) fails due to a standard WebAuthn API error +(e.g., `NotAllowedError` if the user cancels, `NotFoundError`, `SecurityError`, timeout). +It submits the error details with `action: "showError::{errorDetailsJsonString}"` and an empty `response`. + +<Expandable title="Parameters"> +<ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions">ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions</a></span>}> +[`ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions) + +Contains the `error` object (with `name` and `message` +from the WebAuthn API DOMException), an optional `rememberDevice` flag, and any other custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the error report is successfully submitted. +Auth0 may re-render the page with specific error messages in `this.transaction.errors` or redirect. + +#### Throws + +Throws an error if the form submission itself fails (e.g., network error, invalid state). + +#### Example + +```typescript +// In your UI, after catching an error from `sdk.useSecurityKey()` or `navigator.credentials.get()`: +if (webAuthnError instanceof DOMException) { + await sdk.showError({ + error: { name: webAuthnError.name, message: webAuthnError.message }, + rememberDevice: userWantsToRemember // if applicable + }); +} +``` + +#### Implementation of + +[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers).[`showError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.md#showerror) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:217](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L217) + +Allows the user to opt-out of the WebAuthn roaming authenticator challenge and select a different MFA method. +This action submits `action: "pick-authenticator"` to Auth0, which should navigate +the user to an MFA factor selection screen. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions">ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions</a></span>}> +[`ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions) + +Optional. Parameters for the operation, +such as `rememberDevice` (if `this.screen.showRememberDevice` is true) and other custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the 'pick-authenticator' action is submitted. + +#### Throws + +Throws an error if the form submission fails (e.g., network error, invalid state). + +#### Example + +```typescript +// When the user clicks a "Try Another Way" button: +await sdk.tryAnotherMethod({ rememberDevice: userWantsToRemember }); +// Auth0 handles redirection to the MFA selection screen. +``` + +#### Implementation of + +[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers).[`tryAnotherMethod`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.md#tryanothermethod) + +</ParamField> + +<ParamField body='useSecurityKey' type='Promise<void>'> +{/*> **useSecurityKey**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:109](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L109) + +Initiates the WebAuthn security key challenge. +This method internally calls `navigator.credentials.get()` using the challenge +options provided in `this.screen.publicKey`. +If the user successfully authenticates with their security key, the resulting +`PublicKeyCredential` is stringified and submitted to Auth0 with `action: "default"`. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions">ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions</a></span>}> +[`ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions) + +Optional parameters for the operation. +This can include `rememberDevice` (if `this.screen.showRememberDevice` is true) and +any other custom key-value pairs to be sent in the form submission. +The `response` field (the WebAuthn credential) is handled internally by this method. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the verification attempt is submitted. +A successful operation usually results in Auth0 redirecting the user. + +#### Throws + +Throws an error if `this.screen.publicKey` is missing (indicating missing challenge options), +if `getPasskeyCredentials` (which wraps `navigator.credentials.get()`) fails (e.g., user cancellation, +no authenticator found, hardware error), or if the final form submission to Auth0 fails. +It is crucial to catch errors from this method. WebAuthn API errors (like `NotAllowedError`) +should be reported using [showError](#showerror). + +#### Example + +```typescript +// In your UI component for the reset-password-mfa-webauthn-roaming-challenge screen: +const sdk = new ResetPasswordMfaWebAuthnRoamingChallenge(); + +async function handleSecurityKeyAuth() { + try { + const userWantsToRemember = document.getElementById('remember-device-checkbox')?.checked || false; + await sdk.useSecurityKey({ rememberDevice: sdk.screen.showRememberDevice && userWantsToRemember }); + // On success, Auth0 typically handles redirection. + } catch (err) { + console.error("Security key authentication failed:", err); + // If it's a WebAuthn API error, report it to Auth0 + if (err.name && err.message) { // Basic check for DOMException-like error + try { + await sdk.showError({ error: { name: err.name, message: err.message } }); + } catch (reportError) { + console.error("Failed to report WebAuthn error:", reportError); + } + } + // Update UI to inform the user, e.g., "Security key verification failed. Please try again." + // Also check `sdk.transaction.errors` if the page might have reloaded with an error message from the server. + } +} +``` + +#### Implementation of + +[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers).[`useSecurityKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.md#usesecuritykey) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordRequest.mdx new file mode 100644 index 000000000..5af8a4a43 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordRequest.mdx @@ -0,0 +1,350 @@ +--- +title: "ResetPasswordRequest" +--- + +Defined in: [src/screens/reset-password-request/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L21) + + +<RequestExample> +```ts +export default class ResetPasswordRequest extends BaseContext implements ResetPasswordRequestMembers { + static screenIdentifier: string = ScreenIds.RESET_PASSWORD_REQUEST; + screen: ScreenOptions; + transaction: TransactionOptions; + + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + const transactionContext = this.getContext('transaction') as TransactionContext; + this.screen = new ScreenOverride(screenContext); + this.transaction = new TransactionOverride(transactionContext); + } + + /** + * @example + * import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request'; + * + * const resetPasswordRequest = new ResetPasswordRequest(); + * resetPasswordRequest.resetPassword({ username: 'testuser' }); + */ + async resetPassword(payload: ResetPasswordRequestOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordRequest.screenIdentifier, 'resetPassword'], + }; + const updatedPayload = updatePayloadByIdentifier(payload, this.transaction.hasFlexibleIdentifier); + await new FormHandler(options).submitData(updatedPayload); + } + + /** + * @example + * import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request'; + * + * const resetPasswordRequest = new ResetPasswordRequest(); + * resetPasswordRequest.backToLogin(); + */ + async backToLogin(payload?: CustomOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [ResetPasswordRequest.screenIdentifier, 'backToLogin'], + }; + await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.BACK_TO_LOGIN }); + } + + /** + * Gets the active identifier types for the reset-password-request screen + * @returns An array of active identifier types or null if none are active + * @example + * ```typescript + * import ResetPasswordRequest from "@auth0/auth0-acul-js/reset-password-request"; + * const resetPasswordRequest = new ResetPasswordRequest(); + * resetPasswordRequest.getLoginIdentifiers(); + * ``` + * @utilityFeature + */ + getLoginIdentifiers(): IdentifierType[] | null { + return _getLoginIdentifiers(this.transaction.allowedIdentifiers); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers) + +## Constructors + +<ParamField body="ResetPasswordRequest" type="Constructor"> +{/*> **new ResetPasswordRequest**(): `ResetPasswordRequest`*/} + +Defined in: [src/screens/reset-password-request/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L26) + +#### Returns + +`ResetPasswordRequest` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest">ScreenMembersOnResetPasswordRequest</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest)*/} + +Defined in: [src/screens/reset-password-request/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L23) + +#### Implementation of + +[`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest">TransactionMembersOnResetPasswordRequest</a></span>}> +{/*> **transaction**: [`TransactionMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest)*/} + +Defined in: [src/screens/reset-password-request/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L24) + +#### Implementation of + +[`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.md#transaction) + +#### Overrides + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_REQUEST`*/} + +Defined in: [src/screens/reset-password-request/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L22) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='backToLogin' type='Promise<void>'> +{/*> **backToLogin**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-request/index.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L57) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request'; + +const resetPasswordRequest = new ResetPasswordRequest(); +resetPasswordRequest.backToLogin(); +``` + +#### Implementation of + +[`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers).[`backToLogin`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.md#backtologin) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='getLoginIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType">ScreenIdentifierType</a>[]</span>}> +{/*> **getLoginIdentifiers**(): [`ScreenIdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType)[] \| `null`*/} + +Defined in: [src/screens/reset-password-request/index.ts:76](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L76) + +**`Utility Feature`** + +Gets the active identifier types for the reset-password-request screen + +#### Returns + +[`ScreenIdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType)[] \| `null` + +An array of active identifier types or null if none are active + +#### Example + +```typescript +import ResetPasswordRequest from "@auth0/auth0-acul-js/reset-password-request"; +const resetPasswordRequest = new ResetPasswordRequest(); +resetPasswordRequest.getLoginIdentifiers(); +``` + +#### Implementation of + +[`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers).[`getLoginIdentifiers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.md#getloginidentifiers) + +</ParamField> + +<ParamField body='resetPassword' type='Promise<void>'> +{/*> **resetPassword**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/reset-password-request/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L41) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions">ResetPasswordRequestOptions</a></span>}> +[`ResetPasswordRequestOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request'; + +const resetPasswordRequest = new ResetPasswordRequest(); +resetPasswordRequest.resetPassword({ username: 'testuser' }); +``` + +#### Implementation of + +[`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers).[`resetPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.md#resetpassword) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordSuccess.mdx new file mode 100644 index 000000000..1d2433734 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordSuccess.mdx @@ -0,0 +1,209 @@ +--- +title: "ResetPasswordSuccess" +--- + +Defined in: [src/screens/reset-password-success/index.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-success/index.ts#L9) + + +<RequestExample> +```ts +export default class ResetPasswordSuccess extends BaseContext implements ResetPasswordSuccessMembers { + static screenIdentifier: string = ScreenIds.RESET_PASSWORD_SUCCESS; + + constructor() { + super(); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers) + +## Constructors + +<ParamField body="ResetPasswordSuccess" type="Constructor"> +{/*> **new ResetPasswordSuccess**(): `ResetPasswordSuccess`*/} + +Defined in: [src/screens/reset-password-success/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-success/index.ts#L12) + +#### Returns + +`ResetPasswordSuccess` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) + +#### Implementation of + +[`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.md#screen) + +#### Inherited from + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) + +#### Implementation of + +[`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.md#transaction) + +#### Inherited from + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_SUCCESS`*/} + +Defined in: [src/screens/reset-password-success/index.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-success/index.ts#L10) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError.mdx new file mode 100644 index 000000000..3ea15473a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError.mdx @@ -0,0 +1,78 @@ +--- +title: "SDKUsageError" +--- + +Defined in: [src/utils/errors.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L46) + +SDKUsageError + + +<RequestExample> +```ts +export class SDKUsageError extends AculError { + public readonly code = 'SDK_USAGE_ERROR'; + + constructor(message: string, field?: string) { + super(message, field); + Object.setPrototypeOf(this, new.target.prototype); + } +} +``` +</RequestExample> + +## Param + +The error message. + +## Param + +The optional field associated with the error. + +## Extends + +- [`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError) + +## Constructors + +<ParamField body="SDKUsageError" type="Constructor"> +{/*> **new SDKUsageError**(`message`, `field?`): `SDKUsageError`*/} + +Defined in: [src/utils/errors.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L49) + +<Expandable title="Parameters"> +<ParamField body='message' type='string'> +</ParamField> +<ParamField body='field?' type='string'> +</ParamField> +</Expandable> +#### Returns + +`SDKUsageError` + +#### Overrides + +[`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError).[`constructor`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.md#constructor) + +</ParamField> +## Properties + +<ParamField body='code' type='"SDK_USAGE_ERROR"'> +{/*> `readonly` **code**: `"SDK_USAGE_ERROR"` = `'SDK_USAGE_ERROR'`*/} + +Defined in: [src/utils/errors.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L47) + +#### Overrides + +[`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError).[`code`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.md#code) + +</ParamField> + +<ParamField body='field?' type='string'> +{/*> `readonly` `optional` **field**: `string`*/} + +Defined in: [src/utils/errors.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L12) + +#### Inherited from + +[`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError).[`field`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.md#field) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Signup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Signup.mdx new file mode 100644 index 000000000..a1f241f1d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Signup.mdx @@ -0,0 +1,528 @@ +--- +title: "Signup" +--- + +Defined in: [src/screens/signup/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L25) + + +<RequestExample> +```ts +export default class Signup extends BaseContext implements SignupMembers { + static screenIdentifier: string = ScreenIds.SIGNUP; + screen: ScreenOptions; + transaction: TransactionOptions; + + constructor() { + super(); + const screenContext = this.getContext('screen') as ScreenContext; + const transactionContext = this.getContext('transaction') as TransactionContext; + + this.screen = new ScreenOverride(screenContext); + this.transaction = new TransactionOverride(transactionContext); + } + /** + * @remarks + * This method handles the submission of the signup form. + * + * @example + * ```typescript + * import Signup from '@auth0/auth0-acul-js/signup'; + * + * const signupManager = new Signup(); + * + * signupManager.signup({ + * email: 'test@example.com', + * password: 'P@$$wOrd123!', + * }); + * ``` + */ + async signup(payload: SignupOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [Signup.screenIdentifier, 'signup'], + }; + await new FormHandler(options).submitData<SignupOptions>(payload); + } + + /** + * Handles the submission of the social signup form. + * + * @remarks + * This method is similar to the {@link signup} method but is used for social signups. + * + * @param payload - The payload containing the social signup options. + * + * @example + * ```typescript + * import Signup from '@auth0/auth0-acul-js/signup'; + * + * const signupManager = new Signup(); + * + * signupManager.federatedSignup({ + * connection: 'google-oauth2' + * }); + * ``` + */ + + async federatedSignup(payload: FederatedSignupOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [Signup.screenIdentifier, 'federatedSignup'], + }; + await new FormHandler(options).submitData<FederatedSignupOptions>(payload); + } + + /** + * @example + * import Signup from "@auth0/auth0-acul-js/signup"; + * const signupManager = new Signup(); + * + * signupManager.pickCountryCode(); + */ + async pickCountryCode(): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [Signup.screenIdentifier, 'pickCountryCode'], + }; + + await new FormHandler(options).submitData({ + action: FormActions.PICK_COUNTRY_CODE, + }); + } + + /** + * @param password + * @returns An object of type {@link PasswordValidationResult} indicating whether the password is valid and why. + * @utilityFeature + */ + validatePassword(password: string): PasswordValidationResult { + const passwordPolicy = this.transaction?.passwordPolicy; + return _validatePassword(password, passwordPolicy); + } + + /** + * Returns the list of enabled identifiers for the signup form, + * marking each as required or optional based on transaction config. + * + * @returns Array of identifier objects (e.g., email, phone, username). + * @utilityFeature + * @example + * const signup = new Signup(); + * const identifiers = signup.getSignupIdentifiers(); + * // [{ type: 'email', required: true }, { type: 'username', required: false }] + */ + getSignupIdentifiers(): Identifier[] | null { + const transaction = { + ...this.transaction, + errors: this.transaction.errors ?? undefined, // convert `null` to `undefined` + }; + return _getSignupIdentifiers(transaction.requiredIdentifiers ?? [], transaction.optionalIdentifiers ?? [], transaction.connectionStrategy); + } + + /** + * Validates a given username against the current username policy + * defined in the transaction context. + * + * @param username - The username string to validate. + * @returns Result object indicating whether the username is valid and why. + * @utilityFeature + * + * @example + * const signup = new Signup(); + * const result = signup.validateUsername('myusername'); + * // result => { valid: true, errors: [] } + */ + validateUsername(username: string): UsernameValidationResult { + const usernameValidationConfig = this.transaction.usernamePolicy; + return _validateUsername(username, usernameValidationConfig); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers) + +## Constructors + +<ParamField body="Signup" type="Constructor"> +{/*> **new Signup**(): `Signup`*/} + +Defined in: [src/screens/signup/index.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L30) + +#### Returns + +`Signup` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup">ScreenMembersOnSignup</a></span>}> +{/*> **screen**: [`ScreenMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup)*/} + +Defined in: [src/screens/signup/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L27) + +#### Implementation of + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup">TransactionMembersOnSignup</a></span>}> +{/*> **transaction**: [`TransactionMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup)*/} + +Defined in: [src/screens/signup/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L28) + +#### Implementation of + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.md#transaction) + +#### Overrides + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.SIGNUP`*/} + +Defined in: [src/screens/signup/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L26) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='federatedSignup' type='Promise<void>'> +{/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/signup/index.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L82) + +Handles the submission of the social signup form. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions">FederatedSignupPayloadOptions</a></span>}> +[`FederatedSignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions) + +The payload containing the social signup options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Remarks + +This method is similar to the [signup](#signup) method but is used for social signups. + +#### Example + +```typescript +import Signup from '@auth0/auth0-acul-js/signup'; + +const signupManager = new Signup(); + +signupManager.federatedSignup({ + connection: 'google-oauth2' +}); +``` + +#### Implementation of + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers).[`federatedSignup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.md#federatedsignup) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='getSignupIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier">Identifier</a>[]</span>}> +{/*> **getSignupIdentifiers**(): [`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier)[] \| `null`*/} + +Defined in: [src/screens/signup/index.ts:129](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L129) + +**`Utility Feature`** + +Returns the list of enabled identifiers for the signup form, +marking each as required or optional based on transaction config. + +#### Returns + +[`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier)[] \| `null` + +Array of identifier objects (e.g., email, phone, username). + +#### Example + +```ts +const signup = new Signup(); +const identifiers = signup.getSignupIdentifiers(); +// [{ type: 'email', required: true }, { type: 'username', required: false }] +``` + +#### Implementation of + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers).[`getSignupIdentifiers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.md#getsignupidentifiers) + +</ParamField> + +<ParamField body='pickCountryCode' type='Promise<void>'> +{/*> **pickCountryCode**(): `Promise`\<`void`\>*/} + +Defined in: [src/screens/signup/index.ts:97](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L97) + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import Signup from "@auth0/auth0-acul-js/signup"; +const signupManager = new Signup(); + +signupManager.pickCountryCode(); +``` + +#### Implementation of + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers).[`pickCountryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.md#pickcountrycode) + +</ParamField> + +<ParamField body='signup' type='Promise<void>'> +{/*> **signup**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/signup/index.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L54) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions">SignupPayloadOptions</a></span>}> +[`SignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Remarks + +This method handles the submission of the signup form. + +#### Example + +```typescript +import Signup from '@auth0/auth0-acul-js/signup'; + +const signupManager = new Signup(); + +signupManager.signup({ + email: 'test@example.com', + password: 'P@$$wOrd123!', +}); +``` + +#### Implementation of + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers).[`signup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.md#signup) + +</ParamField> + +<ParamField body='validatePassword' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> +{/*> **validatePassword**(`password`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult)*/} + +Defined in: [src/screens/signup/index.ts:113](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L113) + +**`Utility Feature`** + +<Expandable title="Parameters"> +<ParamField body='password' type='string'> +`string` +</ParamField> +</Expandable> + +#### Returns + +[`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult) + +An object of type [PasswordValidationResult](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult) indicating whether the password is valid and why. + +#### Implementation of + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers).[`validatePassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.md#validatepassword) + +</ParamField> + +<ParamField body='validateUsername' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}> +{/*> **validateUsername**(`username`): [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult)*/} + +Defined in: [src/screens/signup/index.ts:150](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L150) + +**`Utility Feature`** + +Validates a given username against the current username policy +defined in the transaction context. + +<Expandable title="Parameters"> +<ParamField body='username' type='string'> +`string` + +The username string to validate. +</ParamField> +</Expandable> + +#### Returns + +[`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult) + +Result object indicating whether the username is valid and why. + +#### Example + +```ts +const signup = new Signup(); +const result = signup.validateUsername('myusername'); +// result => { valid: true, errors: [] } +``` + +#### Implementation of + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers).[`validateUsername`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.md#validateusername) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupId.mdx new file mode 100644 index 000000000..7826709e5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupId.mdx @@ -0,0 +1,528 @@ +--- +title: "SignupId" +--- + +Defined in: [src/screens/signup-id/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L24) + + +<RequestExample> +```ts +export default class SignupId extends BaseContext implements SignupIdMembers { + static screenIdentifier: string = ScreenIds.SIGNUP_ID; + screen: ScreenOptions; + transaction: TransactionOptions; + + constructor() { + super(); + + const screenContext = this.getContext('screen') as ScreenContext; + const transactionContext = this.getContext('transaction') as TransactionContext; + + this.screen = new ScreenOverride(screenContext); + this.transaction = new TransactionOverride(transactionContext); + } + + /** + * @remarks + * This methods handles signup-id related configuration. + * It allows to signup new users via different identifiers. + * + * @example + * import SignupId from "@auth0/auth0-acul-js/signup-id"; + * + * const signupIdManager = new SignupId(); + * const { transaction } = signupIdManager; + * + * //get mandatory & optional identifiers required for signup + * const mandatoryIdentifier = transaction.getRequiredIdentifiers(); // eg: email + * const optionalIdentifiers = transaction.getOptionalIdentifiers() // eg: phone + * + * const signupParams = { + * email : "testEmail", + * phone : "+91923456789" + * }; + * + * signupIdManager.signup(signupParams); + */ + async signup(payload: SignupOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [SignupId.screenIdentifier, 'signup'], + }; + + const activeIdentifiers = this.transaction.requiredIdentifiers || []; + const missingParameters = activeIdentifiers.filter((param) => !Object.keys(payload).includes(param)); + if (missingParameters.length) { + throw new Error(`Missing parameter(s): ${missingParameters.join(', ')}`); + } + + if (payload.phone?.trim() ?? '') { + const { phone, ...rest } = payload; + payload = { ...rest, phone_number: phone }; + } + + const browserCapabilities = await getBrowserCapabilities() + await new FormHandler(options).submitData<SignupOptions>({ + ...payload, + ...browserCapabilities + }); + } + + /** + * @remarks + * This methods handles allows signup via different social identifiers. + * Eg: Google, Facebook etc. + * + * @example + * import SignupId from "@auth0/auth0-acul-js/signup-id"; + * + * const signupIdManager = new SignupId(); + * const { transaction } = signupIdManager; + * + * //get social connections + * const socialConnection = transaction.alternateConnections; //eg: "google-oauth2" + * + * const signupParams = { + * connection : socialConnection[0].name, // "google-oauth2" + * }; + * + * signupIdManager.federatedSignup(signupParams); + */ + async federatedSignup(payload: FederatedSignupOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [SignupId.screenIdentifier, 'federatedSignup'], + }; + await new FormHandler(options).submitData<FederatedSignupOptions>(payload); + } + + /** + * Returns the list of enabled identifiers for the signup-id form, + * marking each as required or optional based on transaction config. + * + * @returns Array of identifier objects (e.g., email, phone, username). + * @utilityFeature + * @example + * const signupId = new SignupId(); + * const identifiers = signupId.getSignupIdentifiers(); + * // [{ type: 'email', required: true }, { type: 'username', required: false }] + */ + getSignupIdentifiers(): Identifier[] | null { + const transaction = { + ...this.transaction, + errors: this.transaction.errors ?? undefined, // convert `null` to `undefined` + }; + return _getSignupIdentifiers(transaction.requiredIdentifiers ?? [], transaction.optionalIdentifiers ?? [], transaction.connectionStrategy); + } + + /** + * @example + * import SignupId from "@auth0/auth0-acul-js/signup-id"; + * const signupIdManager = new SignupId(); + * + * signupIdManager.pickCountryCode(); + */ + async pickCountryCode(): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [SignupId.screenIdentifier, 'pickCountryCode'], + }; + + await new FormHandler(options).submitData({ + action: FormActions.PICK_COUNTRY_CODE, + }); + } + + /** + * Validates a given username against the current username policy + * defined in the transaction context. + * + * @param username - The username string to validate. + * @returns Result object indicating whether the username is valid and why. + * @utilityFeature + * + * @example + * const signupIdManager = new SignupId(); + * const result = signupIdManager.validateUsername('myusername'); + * // result => { valid: true, errors: [] } + */ + validateUsername(username: string): UsernameValidationResult { + const usernameValidationConfig = this.transaction.usernamePolicy; + return _validateUsername(username, usernameValidationConfig); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers) + +## Constructors + +<ParamField body="SignupId" type="Constructor"> +{/*> **new SignupId**(): `SignupId`*/} + +Defined in: [src/screens/signup-id/index.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L29) + +#### Returns + +`SignupId` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId">ScreenMembersOnSignupId</a></span>}> +{/*> **screen**: [`ScreenMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId)*/} + +Defined in: [src/screens/signup-id/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L26) + +#### Implementation of + +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a></span>}> +{/*> **transaction**: [`TransactionMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId)*/} + +Defined in: [src/screens/signup-id/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L27) + +#### Implementation of + +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.md#transaction) + +#### Overrides + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.SIGNUP_ID`*/} + +Defined in: [src/screens/signup-id/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L25) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='federatedSignup' type='Promise<void>'> +{/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/signup-id/index.ts:105](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L105) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions">FederatedSignupOptions</a></span>}> +[`FederatedSignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Remarks + +This methods handles allows signup via different social identifiers. +Eg: Google, Facebook etc. + +#### Example + +```ts +import SignupId from "@auth0/auth0-acul-js/signup-id"; + +const signupIdManager = new SignupId(); +const { transaction } = signupIdManager; + +//get social connections +const socialConnection = transaction.alternateConnections; //eg: "google-oauth2" + +const signupParams = { + connection : socialConnection[0].name, // "google-oauth2" +}; + +signupIdManager.federatedSignup(signupParams); +``` + +#### Implementation of + +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers).[`federatedSignup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.md#federatedsignup) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='getSignupIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier">Identifier</a>[]</span>}> +{/*> **getSignupIdentifiers**(): [`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier)[] \| `null`*/} + +Defined in: [src/screens/signup-id/index.ts:124](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L124) + +**`Utility Feature`** + +Returns the list of enabled identifiers for the signup-id form, +marking each as required or optional based on transaction config. + +#### Returns + +[`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier)[] \| `null` + +Array of identifier objects (e.g., email, phone, username). + +#### Example + +```ts +const signupId = new SignupId(); +const identifiers = signupId.getSignupIdentifiers(); +// [{ type: 'email', required: true }, { type: 'username', required: false }] +``` + +#### Implementation of + +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers).[`getSignupIdentifiers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.md#getsignupidentifiers) + +</ParamField> + +<ParamField body='pickCountryCode' type='Promise<void>'> +{/*> **pickCountryCode**(): `Promise`\<`void`\>*/} + +Defined in: [src/screens/signup-id/index.ts:139](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L139) + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```ts +import SignupId from "@auth0/auth0-acul-js/signup-id"; +const signupIdManager = new SignupId(); + +signupIdManager.pickCountryCode(); +``` + +#### Implementation of + +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers).[`pickCountryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.md#pickcountrycode) + +</ParamField> + +<ParamField body='signup' type='Promise<void>'> +{/*> **signup**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/signup-id/index.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L61) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions">SignupOptions</a></span>}> +[`SignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Remarks + +This methods handles signup-id related configuration. +It allows to signup new users via different identifiers. + +#### Example + +```ts +import SignupId from "@auth0/auth0-acul-js/signup-id"; + +const signupIdManager = new SignupId(); +const { transaction } = signupIdManager; + +//get mandatory & optional identifiers required for signup +const mandatoryIdentifier = transaction.getRequiredIdentifiers(); // eg: email +const optionalIdentifiers = transaction.getOptionalIdentifiers() // eg: phone + +const signupParams = { + email : "testEmail", + phone : "+91923456789" +}; + +signupIdManager.signup(signupParams); +``` + +#### Implementation of + +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers).[`signup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.md#signup) + +</ParamField> + +<ParamField body='validateUsername' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}> +{/*> **validateUsername**(`username`): [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult)*/} + +Defined in: [src/screens/signup-id/index.ts:163](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L163) + +**`Utility Feature`** + +Validates a given username against the current username policy +defined in the transaction context. + +<Expandable title="Parameters"> +<ParamField body='username' type='string'> +`string` + +The username string to validate. +</ParamField> +</Expandable> + +#### Returns + +[`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult) + +Result object indicating whether the username is valid and why. + +#### Example + +```ts +const signupIdManager = new SignupId(); +const result = signupIdManager.validateUsername('myusername'); +// result => { valid: true, errors: [] } +``` + +#### Implementation of + +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers).[`validateUsername`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.md#validateusername) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupPassword.mdx new file mode 100644 index 000000000..957ec8db8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupPassword.mdx @@ -0,0 +1,456 @@ +--- +title: "SignupPassword" +--- + +Defined in: [src/screens/signup-password/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L22) + + +<RequestExample> +```ts +export default class SignupPassword extends BaseContext implements SignupPasswordMembers { + static screenIdentifier: string = ScreenIds.SIGNUP_PASSWORD; + screen: ScreenOptions; + transaction: TransactionOptions; + + constructor() { + super(); + + const screenContext = this.getContext('screen') as ScreenContextOnSignupPassword; + const transactionContext = this.getContext('transaction') as TransactionContext; + + this.screen = new ScreenOverride(screenContext); + this.transaction = new TransactionOverride(transactionContext); + } + + /** + * @remarks + * This methods handles signup-password related screen configuration. + * It allows to proceed with registering signup password along with signup identifiers passed in previous screen + * + * @example + * import SignupPassword from "@auth0/auth0-acul-js/signup-password"; + * + * const signupPasswordManager = new SignupPassword(); + * const { transaction, screen } = signupPasswordManager; + * + * //get mandatory & optional identifiers required for signup-password screen to proceed + * const mandatoryIdentifier = transaction.getRequiredIdentifiers(); //eg: email + * const optionalIdentifiers = transaction.getOptionalIdentifiers() //eg: phone + * + * //get signup data submitted on previous screen from previous screen + * const data = transaction.screen.getScreenData(); //eg: email, phone + * + * + * const signupParams = { + * email : data.email, + * password: "******" + * }; + * + * signupPasswordManager.signup(signupParams); + */ + async signup(payload: SignupPasswordOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [this.constructor.name, 'signup'], + }; + + await new FormHandler(options).submitData<SignupPasswordOptions>(payload); + } + + /** + * @remarks + * This methods handles allows signup via different social identifiers. + * Eg: Google, Facebook etc. + * + * @example + * import SignupPassword from "@auth0/auth0-acul-js/signup-id"; + * + * const signupIdManager = new SignupPassword(); + * const { transaction } = signupIdManager; + * + * //get social connections + * const socialConnection = transaction.alternateConnections; //eg: "google-oauth2" + * + * const signupParams = { + * connection : socialConnection[0].name, // "google-oauth2" + * }; + * + * signupIdManager.federatedSignup(signupParams); + */ + async federatedSignup(payload: FederatedSignupOptions): Promise<void> { + const options: FormOptions = { + state: this.transaction.state, + telemetry: [SignupPassword.screenIdentifier, 'federatedSignup'], + }; + + await new FormHandler(options).submitData<FederatedSignupOptions>(payload); + } + + /** + * Validates a password string against the current transaction's password policy. + * + * This method retrieves the password policy from the current transaction context + * and delegates the actual validation to `coreValidatePassword`. + * + * It returns an array of validation results, each containing: + * - `code`: the identifier of the password rule, + * - `policy`: a user-friendly description of the rule, + * - `isValid`: boolean indicating if the password passed that rule. + * + * @param {string} password - The password string to validate. + * @returns {PasswordValidationResult} + * @utilityFeature + * + * @example + * ```ts + * import SignupPassword from "@auth0/auth0-acul-js/signup-password"; + * const signupPasswordManager = new SignupPassword(); + * const validationResults = signupPasswordManager.validatePassword('MyP@ssw0rd!'); + * console.log(validationResults); + * // [ + * // { code: 'password-policy-length-at-least', policy: 'At least 12 characters', isValid: false }, + * // { code: 'password-policy-lower-case', policy: 'Lowercase letters (a-z)', isValid: true }, + * // ... + * // ] + * ``` + */ + validatePassword(password: string): PasswordValidationResult { + const passwordPolicy = this.transaction?.passwordPolicy; + return _validatePassword(password, passwordPolicy); + } +} +``` +</RequestExample> + +## Extends + +- `BaseContext` + +## Implements + +- [`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers) + +## Constructors + +<ParamField body="SignupPassword" type="Constructor"> +{/*> **new SignupPassword**(): `SignupPassword`*/} + +Defined in: [src/screens/signup-password/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L27) + +#### Returns + +`SignupPassword` + +#### Overrides + +`BaseContext.constructor` + +</ParamField> +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) + +#### Implementation of + +[`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.md#branding) + +#### Inherited from + +`BaseContext.branding` + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) + +#### Implementation of + +[`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.md#client) + +#### Inherited from + +`BaseContext.client` + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) + +#### Implementation of + +[`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.md#organization) + +#### Inherited from + +`BaseContext.organization` + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) + +#### Implementation of + +[`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.md#prompt) + +#### Inherited from + +`BaseContext.prompt` + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword">ScreenMembersOnSignupPassword</a></span>}> +{/*> **screen**: [`ScreenMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword)*/} + +Defined in: [src/screens/signup-password/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L24) + +#### Implementation of + +[`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.md#screen) + +#### Overrides + +`BaseContext.screen` + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) + +#### Implementation of + +[`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.md#tenant) + +#### Inherited from + +`BaseContext.tenant` + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword">TransactionMembersOnSignupPassword</a></span>}> +{/*> **transaction**: [`TransactionMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword)*/} + +Defined in: [src/screens/signup-password/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L25) + +#### Implementation of + +[`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.md#transaction) + +#### Overrides + +`BaseContext.transaction` + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) + +#### Implementation of + +[`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.md#untrusteddata) + +#### Inherited from + +`BaseContext.untrustedData` + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) + +#### Implementation of + +[`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.md#user) + +#### Inherited from + +`BaseContext.user` + +</ParamField> + +<ParamField body='screenIdentifier' type='string'> +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.SIGNUP_PASSWORD`*/} + +Defined in: [src/screens/signup-password/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L23) + +#### Overrides + +`BaseContext.screenIdentifier` + +</ParamField> +## Methods + +<ParamField body='federatedSignup' type='Promise<void>'> +{/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/signup-password/index.ts:92](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L92) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions">FederatedSignupPasswordPayloadOptions</a></span>}> +[`FederatedSignupPasswordPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Remarks + +This methods handles allows signup via different social identifiers. +Eg: Google, Facebook etc. + +#### Example + +```ts +import SignupPassword from "@auth0/auth0-acul-js/signup-id"; + +const signupIdManager = new SignupPassword(); +const { transaction } = signupIdManager; + +//get social connections +const socialConnection = transaction.alternateConnections; //eg: "google-oauth2" + +const signupParams = { + connection : socialConnection[0].name, // "google-oauth2" +}; + +signupIdManager.federatedSignup(signupParams); +``` + +#### Implementation of + +[`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers).[`federatedSignup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.md#federatedsignup) + +</ParamField> + +<ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> +{/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} + +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) + +Retrieves the array of transaction errors from the context, or an empty array if none exist. + +#### Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] + +An array of error objects from the transaction context. + +#### Inherited from + +`BaseContext.getErrors` + +</ParamField> + +<ParamField body='signup' type='Promise<void>'> +{/*> **signup**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [src/screens/signup-password/index.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L63) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions">SignupPasswordOptions</a></span>}> +[`SignupPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Remarks + +This methods handles signup-password related screen configuration. +It allows to proceed with registering signup password along with signup identifiers passed in previous screen + +#### Example + +```ts +import SignupPassword from "@auth0/auth0-acul-js/signup-password"; + +const signupPasswordManager = new SignupPassword(); +const { transaction, screen } = signupPasswordManager; + +//get mandatory & optional identifiers required for signup-password screen to proceed +const mandatoryIdentifier = transaction.getRequiredIdentifiers(); //eg: email +const optionalIdentifiers = transaction.getOptionalIdentifiers() //eg: phone + +//get signup data submitted on previous screen from previous screen +const data = transaction.screen.getScreenData(); //eg: email, phone + +const signupParams = { + email : data.email, + password: "******" +}; + +signupPasswordManager.signup(signupParams); +``` + +#### Implementation of + +[`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers).[`signup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.md#signup) + +</ParamField> + +<ParamField body='validatePassword' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> +{/*> **validatePassword**(`password`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult)*/} + +Defined in: [src/screens/signup-password/index.ts:129](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L129) + +**`Utility Feature`** + +Validates a password string against the current transaction's password policy. + +This method retrieves the password policy from the current transaction context +and delegates the actual validation to `coreValidatePassword`. + +It returns an array of validation results, each containing: +- `code`: the identifier of the password rule, +- `policy`: a user-friendly description of the rule, +- `isValid`: boolean indicating if the password passed that rule. + +<Expandable title="Parameters"> +<ParamField body='password' type='string'> +`string` + +The password string to validate. +</ParamField> +</Expandable> + +#### Returns + +[`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult) + +#### Example + +```ts +import SignupPassword from "@auth0/auth0-acul-js/signup-password"; +const signupPasswordManager = new SignupPassword(); +const validationResults = signupPasswordManager.validatePassword('MyP@ssw0rd!'); +console.log(validationResults); +// [ +// { code: 'password-policy-length-at-least', policy: 'At least 12 characters', isValid: false }, +// { code: 'password-policy-lower-case', policy: 'Lowercase letters (a-z)', isValid: true }, +// ... +// ] +``` + +#### Implementation of + +[`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers).[`validatePassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.md#validatepassword) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError.mdx new file mode 100644 index 000000000..5471a7745 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError.mdx @@ -0,0 +1,78 @@ +--- +title: "UserInputError" +--- + +Defined in: [src/utils/errors.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L30) + +UserInputError + + +<RequestExample> +```ts +export class UserInputError extends AculError { + public readonly code = 'USER_INPUT_ERROR'; + + constructor(message: string, field?: string) { + super(message, field); + Object.setPrototypeOf(this, new.target.prototype); + } +} +``` +</RequestExample> + +## Param + +The error message. + +## Param + +The optional field associated with the error. + +## Extends + +- [`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError) + +## Constructors + +<ParamField body="UserInputError" type="Constructor"> +{/*> **new UserInputError**(`message`, `field?`): `UserInputError`*/} + +Defined in: [src/utils/errors.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L33) + +<Expandable title="Parameters"> +<ParamField body='message' type='string'> +</ParamField> +<ParamField body='field?' type='string'> +</ParamField> +</Expandable> +#### Returns + +`UserInputError` + +#### Overrides + +[`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError).[`constructor`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.md#constructor) + +</ParamField> +## Properties + +<ParamField body='code' type='"USER_INPUT_ERROR"'> +{/*> `readonly` **code**: `"USER_INPUT_ERROR"` = `'USER_INPUT_ERROR'`*/} + +Defined in: [src/utils/errors.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L31) + +#### Overrides + +[`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError).[`code`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.md#code) + +</ParamField> + +<ParamField body='field?' type='string'> +{/*> `readonly` `optional` **field**: `string`*/} + +Defined in: [src/utils/errors.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L12) + +#### Inherited from + +[`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError).[`field`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.md#field) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreen.mdx new file mode 100644 index 000000000..fcc1b7ffd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreen.mdx @@ -0,0 +1,17 @@ +--- +title: "getCurrentScreen" +--- + +> **getCurrentScreen**(): `string` \| `null` + +Defined in: [src/common/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/common/index.ts#L14) + +**`Common Feature`** + +Gets the current screen name from the authentication context + +## Returns + +`string` \| `null` + +The current screen name or null if no screen is active \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreenOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreenOptions.mdx new file mode 100644 index 000000000..c5ea4a468 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreenOptions.mdx @@ -0,0 +1,17 @@ +--- +title: "getCurrentScreenOptions" +--- + +> **getCurrentScreenOptions**(): [`CurrentScreenOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CurrentScreenOptions) + +Defined in: [src/common/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/common/index.ts#L23) + +**`Common Feature`** + +Gets the current screen options including client, organization, prompt, screen, tenant, transaction, and untrusted data + +## Returns + +[`CurrentScreenOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CurrentScreenOptions) + +Current screen options object with all available context data \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentThemeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentThemeOptions.mdx new file mode 100644 index 000000000..ee93d51f0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentThemeOptions.mdx @@ -0,0 +1,17 @@ +--- +title: "getCurrentThemeOptions" +--- + +> **getCurrentThemeOptions**(): [`FlattenedTheme`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FlattenedTheme) \| `null` + +Defined in: [src/common/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/common/index.ts#L58) + +**`Common Feature`** + +Gets the current theme options with flattened configuration from branding context + +## Returns + +[`FlattenedTheme`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FlattenedTheme) \| `null` + +FlattenedTheme object containing colors, fonts, borders, pageBackground, and widget configurations, or null if no branding is available \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getErrors.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getErrors.mdx new file mode 100644 index 000000000..2314f376d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getErrors.mdx @@ -0,0 +1,17 @@ +--- +title: "getErrors" +--- + +> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null` + +Defined in: [src/common/index.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/common/index.ts#L87) + +**`Common Feature`** + +Gets the current errors from the transaction context + +## Returns + +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null` + +Array of Error objects or null if no errors are present \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/index.mdx new file mode 100644 index 000000000..567dbec1f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/index.mdx @@ -0,0 +1,384 @@ +--- +title: "Screens" +--- + +## Classes + +- [AcceptInvitation](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AcceptInvitation): Class implementing the accept-invitation screen functionality. This screen is displayed when a user needs to accept an invitation to an organization. +- [AculError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError): AculError +- [Auth0ServerError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError): Auth0ServerError +- [Consent](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Consent): ConsentMembers +- [CustomizedConsent](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/CustomizedConsent): CustomizedConsent +- [DeviceCodeActivation](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivation): Class implementing the Device Code Activation screen functionality. This screen is displayed when the user needs to enter the code on their device to activate it. +- [DeviceCodeActivationAllowed](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationAllowed): Class implementing the Device Code Activation Allowed screen functionality. This screen is displayed when the device code activation is allowed. +- [DeviceCodeActivationDenied](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationDenied): Class implementing the Device Code Activation Denied screen functionality. This screen is displayed when the device code activation is denied. +- [DeviceCodeConfirmation](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeConfirmation): Class implementing the Device Code Confirmation screen functionality. This screen is displayed when the user needs to confirm the device code. +- [EmailIdentifierChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailIdentifierChallenge) +- [EmailOTPChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailOTPChallenge): Represents the Email OTP Challenge screen. +- [EmailVerificationResult](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailVerificationResult): EmailVerificationResult +- [InterstitialCaptcha](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/InterstitialCaptcha) +- [Login](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Login): Login screen implementation class +- [LoginEmailVerification](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginEmailVerification): LoginEmailVerification classdesc Manages interactions for the "login-email-verification" screen. This screen prompts the user to enter a one-time code sent to their email address to verify their identity during the login process. +- [LoginId](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginId) +- [LoginPassword](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPassword) +- [LoginPasswordlessEmailCode](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessEmailCode) +- [LoginPasswordlessSmsOtp](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessSmsOtp) +- [Logout](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Logout): Class implementing the logout screen functionality. This screen allows users to confirm or deny the logout action. +- [LogoutAborted](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutAborted): Class implementing the logout-aborted screen functionality This screen is displayed when a user aborts the logout process. +- [LogoutComplete](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutComplete): Class implementing the logout-complete screen functionality This screen is displayed when a user aborts the logout process. +- [MfaBeginEnrollOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaBeginEnrollOptions): MFA Begin Enroll Options screen implementation class Handles the selection and enrollment of MFA factors +- [MfaCountryCodes](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaCountryCodes): Class implementing the mfa-country-codes screen functionality This screen allows users to select a country code for MFA phone number verification +- [MfaDetectBrowserCapabilities](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaDetectBrowserCapabilities): Class implementing the mfa-detect-browser-capabilities screen functionality This screen detects browser capabilities for MFA authentication methods +- [MfaEmailChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailChallenge): Class implementing the mfa-email-challenge screen functionality This screen is shown when a user needs to verify their email during MFA +- [MfaEmailList](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailList): Class implementing the mfa-email-list screen functionality This screen allows users to select an enrolled email address for MFA +- [MfaEnrollResult](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEnrollResult): MfaEnrollResult +- [MfaLoginOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaLoginOptions): Class implementing the mfa-login-options screen functionality This screen allows users to select which MFA factor they want to use for login +- [MfaOtpChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpChallenge): Class implementing the mfa-otp-challenge screen functionality This screen is shown when a user needs to enter an OTP code during MFA +- [MfaOtpEnrollmentCode](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentCode): Class implementing the mfa-otp-enrollment-code screen functionality. This screen is displayed when the user needs to enter the OTP code received during MFA enrollment. +- [MfaOtpEnrollmentQr](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentQr): Class implementing the mfa-otp-enrollment-qr screen functionality +- [MfaPhoneChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneChallenge): MfaPhoneChallenge +- [MfaPhoneEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneEnrollment): Class implementing the mfa-phone-enrollment screen functionality. This screen allows users to enroll using a phone number for MFA. +- [MfaPushChallengePush](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushChallengePush): Class implementing the mfa-push-challenge-push screen functionality This screen is shown when a user needs to confirm a push notification during MFA +- [MfaPushEnrollmentQr](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushEnrollmentQr): Class implementing the mfa-push-enrollment-qr screen functionality +- [MfaPushList](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushList): Class implementing the mfa-push-list screen functionality +- [MfaPushWelcome](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushWelcome) +- [MfaRecoveryCodeChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallenge): Class implementing the MFA Recovery Code Challenge screen functionality. +- [MfaRecoveryCodeChallengeNewCode](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode): MfaRecoveryCodeChallengeNewCode +- [MfaRecoveryCodeEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment): Class implementing the Mfa Recovery Code Enrollment screen functionality. This screen is displayed when the user needs to enroll with a recovery code for MFA. +- [MfaSmsChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsChallenge): This class provides methods to handle the mfa-sms-challenge screen. +- [MfaSmsEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsEnrollment): Represents the MFA SMS Enrollment screen. +- [MfaSmsList](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsList): MfaSmsList Class for handling the mfa-sms-list screen. +- [MfaVoiceChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceChallenge): MFA Voice Challenge screen implementation. +- [MfaVoiceEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceEnrollment): Class implementing the mfa-voice-enrollment screen functionality. +- [MfaWebAuthnChangeKeyNickname](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname): MfaWebAuthnChangeKeyNicknameMembers +- [MfaWebAuthnEnrollmentSuccess](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess): MfaWebAuthnEnrollmentSuccess +- [MfaWebAuthnError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnError): MfaWebAuthnError +- [MfaWebAuthnNotAvailableError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError): MfaWebAuthnNotAvailableError +- [MfaWebAuthnPlatformChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge): MfaWebAuthnPlatformChallenge +- [MfaWebAuthnPlatformEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment): MfaWebAuthnPlatformEnrollment +- [MfaWebAuthnRoamingChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge): MfaWebAuthnRoamingChallenge +- [MfaWebAuthnRoamingEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment): Class implementing the mfa-webauthn-roaming-enrollment screen functionality. This screen is displayed when a user needs to enroll a WebAuthn roaming authenticator (like a security key). +- [OrganizationPicker](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationPicker): Class implementing the organization-picker screen functionality. This screen allows users to select an organization from a list of available organizations. +- [OrganizationSelection](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationSelection): Class implementing the organization-selection screen functionality. This screen allows users to select an organization to continue with. +- [PasskeyEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollment) +- [PasskeyEnrollmentLocal](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollmentLocal) +- [PhoneIdentifierChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierChallenge) +- [PhoneIdentifierEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierEnrollment) +- [RedeemTicket](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/RedeemTicket): Implements the redeem-ticket screen functionality. +- [ResetPassword](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPassword) +- [ResetPasswordEmail](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordEmail) +- [ResetPasswordError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordError) +- [ResetPasswordMfaEmailChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge): Class implementing the reset-password-mfa-email-challenge screen functionality +- [ResetPasswordMfaOtpChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge): Class implementing the reset-password-mfa-otp-challenge screen functionality +- [ResetPasswordMfaPhoneChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge): ResetPasswordMfaPhoneChallenge +- [ResetPasswordMfaPushChallengePush](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush): Class representing the reset-password-mfa-push-challenge-push screen functionality This screen is shown when a push notification has been sent to the user's device during password reset +- [ResetPasswordMfaRecoveryCodeChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge): Class implementing the Reset Password MFA Recovery Code Challenge screen functionality. +- [ResetPasswordMfaSmsChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge): This class provides methods to handle the reset-password-mfa-sms-challenge screen. +- [ResetPasswordMfaVoiceChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge): Class implementing the reset-password-mfa-voice-challenge screen functionality. +- [ResetPasswordMfaWebAuthnPlatformChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge): ResetPasswordMfaWebAuthnPlatformChallenge +- [ResetPasswordMfaWebAuthnRoamingChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge): ResetPasswordMfaWebAuthnRoamingChallenge +- [ResetPasswordRequest](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordRequest) +- [ResetPasswordSuccess](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordSuccess) +- [SDKUsageError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError): SDKUsageError +- [Signup](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Signup) +- [SignupId](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupId) +- [SignupPassword](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupPassword) +- [UserInputError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError): UserInputError + +## Interfaces + +- [AbortEnrollmentOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions) +- [AcceptInvitationMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers) +- [AllowCredential](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential) +- [AuthorizationDetail](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail) +- [BaseMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) +- [Branding](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding) +- [BrandingMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers) +- [BrandingSettings](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings) +- [BrandingThemes](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes) +- [CaptchaContext](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) +- [ClientMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers) +- [ConfirmLogoutOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions): Options for confirming logout +- [Connection](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) +- [ConsentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers): ConsentMembers +- [ContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions): Options for continuing with the email challenge. +- [ContinueOTPOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions): Options for continuing with the OTP challenge +- [ContinuePayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions): Options for continuing with the email challenge +- [ContinueWithCodeOptionPayload](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload): ContinueWithCodeOptions description Options for the `continueWithCode` method on the Login Email Verification screen. This operation is used when the user submits the verification code they received via email to proceed with the authentication flow. +- [ContinueWithOrganizationNameOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions): Options for continuing with the selected organization name. +- [CredentialResponse](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse) +- [CurrentScreenOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CurrentScreenOptions): CurrentScreenOptions details. +- [CustomizedConsentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers): CustomizedConsentMembers +- [CustomOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +- [DeviceCodeActivationAllowedMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers): Interface describing the members of the Device Code Activation Allowed screen. +- [DeviceCodeActivationContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions): payload for continuing device code activation. +- [DeviceCodeActivationDeniedMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers): Interface describing the members of the Device Code Activation Denied screen. +- [DeviceCodeActivationMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers): Interface describing the members of the Device Code Activation screen. +- [DeviceCodeConfirmationMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers): Interface describing the members of the Device Code Confirmation screen. +- [EmailChallengeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions) +- [EmailIdentifierChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers) +- [EmailOTPChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers): Represents the Email OTP Challenge screen interface. +- [EmailVerificationResultMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers): EmailVerificationResultMembers +- [EnrolledDevice](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice) +- [EnrolledEmail](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail) +- [EnrolledPhoneNumber](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber) +- [EnterpriseConnection](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection) +- [Error](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error) +- [FederatedLoginOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions) +- [FederatedLoginPasswordOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions) +- [FederatedLoginPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions): Options for performing social login operations +- [FederatedSignupOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions) +- [FederatedSignupPasswordPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions) +- [FederatedSignupPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions) +- [FlattenedTheme](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FlattenedTheme) +- [Identifier](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier): Describes a configured identifier field (e.g. email, phone, or username) for use in a signup form or authentication flow. +- [InterstitialCaptchaMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers) +- [LoginEmailVerificationMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers): LoginEmailVerificationMembers description Defines the members (properties and methods) available for interacting with the Login Email Verification screen. This screen is a crucial part of email verification processes, typically during login, where a user must prove ownership of an email address by providing a one-time code. The SDK facilitates submitting this code or requesting a new one. +- [LoginEnrollOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions): Options for continuing with a selected MFA factor +- [LoginIdMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers) +- [LoginMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers): Login screen members interface extending base members +- [LoginOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions) +- [LoginPasswordlessEmailCodeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers) +- [LoginPasswordlessSmsOtpMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers) +- [LoginPasswordMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers) +- [LoginPasswordOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions) +- [LoginPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions): Options for performing login operations +- [LogoutAbortedMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers): Interface defining the available methods and properties for the logout-aborted screen +- [LogoutCompleteMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers): Interface defining the available methods and properties for the logout-complete screen +- [LogoutMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers): Interface defining the available methods and properties for the logout screen +- [MfaBeginEnrollOptionsMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers): MFA Begin Enroll Options screen members interface +- [MfaCountryCodesMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers): Interface defining the available methods and properties for the mfa-country-codes screen +- [MfaDetectBrowserCapabilitiesMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers): Interface defining the available methods and properties for the mfa-detect-browser-capabilities screen +- [MfaEmailChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers): Interface defining the available methods and properties for the mfa-email-challenge screen +- [MfaEmailListMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers): Interface defining the available methods and properties for the mfa-email-list screen +- [MfaEnrollOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions): Options for continuing with factor enrollment +- [MfaEnrollResultMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers): MfaEnrollResultMembers +- [MfaLoginOptionsMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers): Interface defining the available methods and properties for the mfa-login-options screen +- [MfaOtpChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers): Interface defining the available methods and properties for the mfa-otp-challenge screen +- [MfaOtpContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions): Options for continuing with the MFA OTP enrollment code. +- [MfaOtpEnrollmentCodeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers): Interface defining the available methods and properties for the mfa-otp-enrollment-code screen. +- [MfaOtpEnrollmentQrContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions): Interface for the payload of the continue method +- [MfaOtpEnrollmentQrMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers): Interface defining the available methods and properties for the mfa-otp-enrollment-qr screen +- [MfaOtpTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions): Options for trying another MFA method. +- [MfaPhoneChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions): ContinueOptions Defines the options required to continue the MFA phone challenge process. This typically involves selecting the method (SMS or Voice) to receive the verification code. +- [MfaPhoneChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers): MfaPhoneChallengeMembers +- [MfaPhoneChallengePickAuthenticatorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions): PickAuthenticatorOptions Defines the options for the 'pick-authenticator' action. This allows the user to choose a different MFA method if available. +- [MfaPhoneChallengePickPhoneOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions): PickPhoneOptions Defines the options for the 'pick-phone' action. Although the interface only shows one phone number, this action might be used in scenarios where the server needs to redirect to a phone selection screen. +- [MfaPhoneEnrollmentContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions): Options for continuing with the MFA phone enrollment. +- [MfaPhoneEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers) +- [MfaPushChallengePushMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers): Interface defining the available methods and properties for the mfa-push-challenge-push screen +- [MfaPushEnrollmentQrMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers): Interface defining the available methods and properties for the mfa-push-enrollment-qr screen +- [MfaPushListMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers): Interface defining the available methods and properties for the mfa-push-list screen +- [MfaPushPollingControl](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl): Control interface for managing an MFA push-notification polling session. +- [MfaPushWelcomeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers) +- [MfaRecoveryCodeChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions): Options for continuing with the MFA Recovery Code Challenge. +- [MfaRecoveryCodeChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers): Interface describing the members of the Mfa Recovery Code Challenge screen. +- [MfaRecoveryCodeChallengeNewCodeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions): ContinueOptions +- [MfaRecoveryCodeChallengeNewCodeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers): MfaRecoveryCodeChallengeNewCodeMembers +- [MfaRecoveryCodeEnrollmentContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions) +- [MfaRecoveryCodeEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers): Interface describing the members of the Mfa Recovery Code Enrollment screen. +- [MfaSmsChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers) +- [MfaSmsChallengeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions) +- [MfaSmsEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers) +- [MfaSmsEnrollmentOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions) +- [MfaSmsListMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers): MfaSmsListMembers Interface defining the members and methods for the MfaSmsList class. +- [MfaSmsListOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions): MfaSmsListOptions Options for performing actions on the mfa-sms-list screen. +- [MfaVoiceChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions): Options for submitting the voice challenge code. +- [MfaVoiceChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers): Interface defining all members and operations available on the MFA Voice Challenge screen. +- [MfaVoiceEnrollmentContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions): Payload for continuing the MFA Voice Enrollment flow. +- [MfaVoiceEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers): Interface describing the members of the Mfa Voice Enrollment screen. +- [MfaWebAuthnChangeKeyNicknameContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions): ContinueOptions +- [MfaWebAuthnChangeKeyNicknameMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers): MfaWebAuthnChangeKeyNicknameMembers +- [MfaWebAuthnEnrollmentSuccessMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers): MfaWebAuthnEnrollmentSuccessMembers +- [MfaWebAuthnErrorMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers): MfaWebAuthnErrorMembers +- [MfaWebAuthnNotAvailableErrorMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers): MfaWebAuthnNotAvailableErrorMembers +- [MfaWebAuthnPlatformChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers): MfaWebAuthnPlatformChallengeMembers +- [MfaWebAuthnPlatformChallengeReportErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions): ReportBrowserErrorOptions +- [MfaWebAuthnPlatformChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions): TryAnotherMethodOptions +- [MfaWebAuthnPlatformEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers): MfaWebAuthnPlatformEnrollmentMembers +- [MfaWebAuthnRoamingChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers): MfaWebAuthnRoamingChallengeMembers +- [MfaWebAuthnRoamingChallengeReportErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions): ReportWebAuthnErrorOptions +- [MfaWebAuthnRoamingChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions): TryAnotherMethodOptions +- [MfaWebAuthnRoamingEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers): Interface defining the available methods and properties for the mfa-webauthn-roaming-enrollment screen. +- [MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions): Options for trying another MFA method. +- [OrganizationMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers) +- [OrganizationPickerMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers): Interface defining the available methods and properties for the organization-picker screen +- [Organizations](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Organizations) +- [OrganizationSelectionMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers): Interface defining the available methods and properties for the organization-selection screen. +- [OtpCodeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions) +- [PasskeyCreate](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) +- [PasskeyCreateResponse](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreateResponse) +- [PasskeyEnrollmentLocalMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers) +- [PasskeyEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers) +- [PasswordComplexityRule](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule) +- [PasswordPolicy](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy) +- [PasswordValidationResult](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult) +- [PhoneChallengeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions) +- [PhoneEnrollmentOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions) +- [PhoneIdentifierChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers) +- [PhoneIdentifierEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers) +- [PhonePrefix](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix) +- [PromptMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers) +- [RedeemTicketMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers): Interface describing the data available on the Redeem Ticket screen. +- [ReportBrowserErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions): ReportBrowserErrorOptions +- [ResendCodeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions): Options for resending the email code. +- [ResendCodeOptionsPayload](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload): ResendCodeOptions description Options for the `resendCode` method on the Login Email Verification screen. This operation is used when the user requests a new verification code to be sent to their email, for instance, if they did not receive the initial code or if it has expired. +- [ResendCodePayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions): Options for resending the email code +- [ResendControl](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl): Control object returned by resendManager method +- [ResetPasswordEmailMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers) +- [ResetPasswordEmailOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailOptions) +- [ResetPasswordErrorMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers) +- [ResetPasswordMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers) +- [ResetPasswordMfaEmailChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers): Interface defining the available methods and properties for the reset-password-mfa-email-challenge screen +- [ResetPasswordMfaOtpChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions): Options for continuing with the OTP challenge. +- [ResetPasswordMfaOtpChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers): Interface defining the available methods and properties for the reset-password-mfa-otp-challenge screen +- [ResetPasswordMfaOtpChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions): Options for trying another method. +- [ResetPasswordMfaPhoneChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions): ContinueOptions +- [ResetPasswordMfaPhoneChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers): ResetPasswordMfaPhoneChallengeMembers +- [ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions): TryAnotherMethodOptions +- [ResetPasswordMfaPushChallengePushMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers): Interface defining the available methods and properties for the reset-password-mfa-push-challenge-push screen +- [ResetPasswordMfaRecoveryCodeChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers): Interface describing the members of the Mfa Recovery Code Challenge screen. +- [ResetPasswordMfaSmsChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers) +- [ResetPasswordMfaSmsChallengeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions) +- [ResetPasswordMfaVoiceChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions): Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers. +- [ResetPasswordMfaVoiceChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers): Interface defining the available methods and properties for the reset-password-mfa-voice-challenge screen. +- [ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions): ContinueWithPasskeyOptions +- [ResetPasswordMfaWebAuthnPlatformChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers): ResetPasswordMfaWebAuthnPlatformChallengeMembers +- [ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions): ReportBrowserErrorOptions +- [ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions): TryAnotherMethodOptions +- [ResetPasswordMfaWebAuthnRoamingChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers): ResetPasswordMfaWebAuthnRoamingChallengeMembers +- [ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions): ShowErrorOptions +- [ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions): TryAnotherMethodOptions +- [ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions): UseSecurityKeyOptions +- [ResetPasswordOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions) +- [ResetPasswordRequestMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers) +- [ResetPasswordRequestOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions) +- [ResetPasswordSuccessMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers) +- [Scope](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope) +- [ScreenMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) +- [ScreenMembersOnAcceptInvitation](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation) +- [ScreenMembersOnConsent](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent): ScreenMembersOnConsent +- [ScreenMembersOnCustomizedConsent](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent): ScreenMembersOnCustomizedConsent +- [ScreenMembersOnDeviceCodeConfirmation](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation): Interface describing the data available on the Device Code Confirmation screen. +- [ScreenMembersOnEmailIdentifierChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge) +- [ScreenMembersOnEmailOTPChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge): Represents the members of the Email OTP Challenge screen. Extends the base ScreenMembers interface. +- [ScreenMembersOnEmailVerificationResult](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult): ScreenMembersOnEmailVerificationResult +- [ScreenMembersOnLogin](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin): Extended screen members interface for the login screen +- [ScreenMembersOnLoginId](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId) +- [ScreenMembersOnLoginPassword](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword) +- [ScreenMembersOnLoginPasswordlessEmailCode](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode) +- [ScreenMembersOnLoginPasswordlessSmsOtp](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp) +- [ScreenMembersOnMfaCountryCodes](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes): Interface for screen data specific to mfa-country-codes screen +- [ScreenMembersOnMfaEmailChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge): Interface for the screen data specific to mfa-email-challenge screen +- [ScreenMembersOnMfaEmailList](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList): Interface for the screen data specific to mfa-email-list screen +- [ScreenMembersOnMfaEnrollResult](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult): ScreenMembersOnMfaEnrollResult +- [ScreenMembersOnMfaLoginOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions): Interface for the screen data specific to mfa-login-options screen +- [ScreenMembersOnMfaOtpChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge): Interface for the screen data specific to mfa-otp-challenge screen +- [ScreenMembersOnMfaOtpEnrollmentCode](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode): Interface for the screen data specific to the mfa-otp-enrollment-code screen. +- [ScreenMembersOnMfaOtpEnrollmentQr](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr): Interface for the screen data specific to mfa-otp-enrollment-qr screen +- [ScreenMembersOnMfaPhoneChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge): ScreenMembersOnMfaPhoneChallenge +- [ScreenMembersOnMfaPushChallengePush](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush): Interface for the screen data specific to mfa-push-challenge-push screen +- [ScreenMembersOnMfaPushEnrollmentQr](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr): Interface for the screen data specific to mfa-push-enrollment-qr screen +- [ScreenMembersOnMfaPushWelcome](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome) +- [ScreenMembersOnMfaRecoveryCodeChallengeNewCode](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode): ScreenMembersOnMfaRecoveryCodeChallengeNewCode +- [ScreenMembersOnMfaRecoveryCodeEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment): Interface describing the data available on the Mfa Recovery Code Enrollment screen. +- [ScreenMembersOnMfaSmsChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge): Interface for the screen data specific to mfa-sms-challenge screen +- [ScreenMembersOnMfaSmsEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment) +- [ScreenMembersOnMfaVoiceChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge): Extended screen members interface for the MFA Voice Challenge screen. +- [ScreenMembersOnMfaWebAuthnChangeKeyNickname](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname): ScreenMembersOnMfaWebAuthnChangeKeyNickname +- [ScreenMembersOnMfaWebAuthnEnrollmentSuccess](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess): ScreenMembersOnMfaWebAuthnEnrollmentSuccess +- [ScreenMembersOnMfaWebAuthnError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError): ScreenMembersOnMfaWebAuthnError +- [ScreenMembersOnMfaWebAuthnPlatformChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge): ScreenMembersOnMfaWebAuthnPlatformChallenge +- [ScreenMembersOnMfaWebAuthnPlatformEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment): ScreenMembersOnMfaWebAuthnPlatformEnrollment +- [ScreenMembersOnMfaWebAuthnRoamingChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge): ScreenMembersOnMfaWebAuthnRoamingChallenge +- [ScreenMembersOnMfaWebAuthnRoamingEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment): Interface for screen data specific to mfa-webauthn-roaming-enrollment screen. +- [ScreenMembersOnOrganizationSelection](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection): Interface for the screen data specific to organization-selection screen. +- [ScreenMembersOnPasskeyEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment) +- [ScreenMembersOnPasskeyEnrollmentLocal](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal) +- [ScreenMembersOnPhoneIdentifierChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge) +- [ScreenMembersOnPhoneIdentifierEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment) +- [ScreenMembersOnResetPassword](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword) +- [ScreenMembersOnResetPasswordEmail](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail) +- [ScreenMembersOnResetPasswordError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError) +- [ScreenMembersOnResetPasswordMfaEmailChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge): Interface for the screen data specific to reset-password-mfa-email-challenge screen +- [ScreenMembersOnResetPasswordMfaPhoneChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge): ScreenMembersOnResetPasswordMfaPhoneChallenge +- [ScreenMembersOnResetPasswordMfaPushChallengePush](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush): Interface for the screen data specific to reset-password-mfa-push-challenge-push screen +- [ScreenMembersOnResetPasswordMfaSmsChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge) +- [ScreenMembersOnResetPasswordMfaVoiceChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge): Interface for the screen data specific to reset-password-mfa-voice-challenge screen. +- [ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge): ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge +- [ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge): ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge +- [ScreenMembersOnResetPasswordRequest](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest) +- [ScreenMembersOnResetPasswordSuccess](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess) +- [ScreenMembersOnSignup](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup) +- [ScreenMembersOnSignupId](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId) +- [ScreenMembersOnSignupPassword](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword) +- [SelectCountryCodeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions): Options for selecting a country code +- [SelectMfaEmailOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions): Options for selecting an email address +- [SelectMfaPushDeviceOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions): Options for selecting an MFA push device. +- [SelectOrganizationOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectOrganizationOptions) +- [ShowErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions): Options for submitting a WebAuthn browser error. +- [SignupIdMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers) +- [SignupMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers) +- [SignupOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions) +- [SignupPasswordMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers) +- [SignupPasswordOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions) +- [SignupPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions) +- [StartResendOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions): Options for configuring resend functionality +- [SubmitCaptchaOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions) +- [SubmitCodeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions) +- [SubmitOTPOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions) +- [SubmitPasskeyCredentialOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions): SubmitPasskeyCredentialOptions +- [TenantMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers) +- [TransactionMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) +- [TransactionMembersOnLogin](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin): Extended transaction members interface for the login screen +- [TransactionMembersOnLoginId](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId) +- [TransactionMembersOnLoginPassword](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword) +- [TransactionMembersOnLoginPasswordlessEmailCode](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode) +- [TransactionMembersOnLoginPasswordlessSmsOtp](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp) +- [TransactionMembersOnResetPassword](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword) +- [TransactionMembersOnResetPasswordRequest](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest) +- [TransactionMembersOnSignup](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup) +- [TransactionMembersOnSignupId](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId) +- [TransactionMembersOnSignupPassword](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword) +- [TryAnotherMethodMfaOtpChallengeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions): Options for trying another method +- [TryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions): Options for trying another method. +- [TryAnotherMethodPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions): Options for trying another method +- [UntrustedDataMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers) +- [UntrustedDataMembersOnMfaEmailChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge): Interface for untrusted data specific to mfa-email-challenge screen +- [UntrustedDataMembersOnMfaOtpChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge): Interface for untrusted data specific to mfa-otp-challenge screen +- [UntrustedDataMembersOnMfaPushChallengePush](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush): Interface for untrusted data specific to mfa-push-challenge-push screen +- [UntrustedDataMembersOnMfaSmsChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge): Interface for untrusted data specific to mfa-sms-challenge screen +- [UntrustedDataMembersOnMfaVoiceChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge): Interface for untrusted data specific to mfa-voice-challenge screen +- [UserMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers) +- [UsernamePolicy](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy) +- [UsernameValidationError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError): Represents a single username validation error returned during validation. +- [UsernameValidationResult](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult): The result of validating a username against one or more rules. +- [VerifyPlatformAuthenticatorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions): VerifyPlatformAuthenticatorOptions +- [VerifySecurityKeyOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions): VerifySecurityKeyOptions +- [WebAuthnEnrollSuccessContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions): ContinueOptions +- [WebAuthnErrorDetails](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails): Details of a WebAuthn browser error. +- [WithRememberOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions) + +## Type Aliases + +- [AuthenticatorTransport](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/AuthenticatorTransport) +- [IdentifierType](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType): Type representing valid identifier values +- [MfaEnrollFactorType](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaEnrollFactorType): Type definition for MFA enroll factor constants +- [MfaLoginFactorType](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaLoginFactorType): Type definition for MFA login factor constants +- [MfaPollingOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions): Configuration options for managing an MFA push-notification polling process. +- [OnStatusChangeCallback](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/OnStatusChangeCallback): Callback function for status changes during resend countdown. +- [ScreenIdentifierType](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType): Represents the types of user identifiers that can be used during signup. +- [WebAuthnType](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType) + +## Functions + +- [getCurrentScreen](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreen): Gets the current screen name from the authentication context +- [getCurrentScreenOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreenOptions): Gets the current screen options including client, organization, prompt, screen, tenant, transaction, and untrusted data +- [getCurrentThemeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentThemeOptions): Gets the current theme options with flattened configuration from branding context +- [getErrors](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getErrors): Gets the current errors from the transaction context + +## References + +### ULError + +Renames and re-exports [Error](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error) \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions.mdx new file mode 100644 index 000000000..223f15729 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "AbortEnrollmentOptions" +--- + +Defined in: [interfaces/screens/passkey-enrollment-local.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L19) + + +<RequestExample> +```ts +export interface AbortEnrollmentOptions { + doNotShowAgain?: boolean; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='doNotShowAgain?' type='boolean'> +{/*> `optional` **doNotShowAgain**: `boolean`*/} + +Defined in: [interfaces/screens/passkey-enrollment-local.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L20) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.mdx new file mode 100644 index 000000000..3fce73f94 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.mdx @@ -0,0 +1,149 @@ +--- +title: "AcceptInvitationMembers" +--- + +Defined in: [interfaces/screens/accept-invitation.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L16) + + +<RequestExample> +```ts +export interface AcceptInvitationMembers extends BaseMembers { + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembersOnAcceptInvitation; + transaction: TransactionMembers; + /** + * Accepts the invitation to the organization. + * @param payload Optional custom options to include with the request. + */ + acceptInvitation(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/screens/accept-invitation.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L17) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/screens/accept-invitation.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L18) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/screens/accept-invitation.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L19) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation">ScreenMembersOnAcceptInvitation</a></span>}> +{/*> **screen**: [`ScreenMembersOnAcceptInvitation`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation)*/} + +Defined in: [interfaces/screens/accept-invitation.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L20) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/screens/accept-invitation.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L21) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='acceptInvitation' type='Promise<void>'> +{/*> **acceptInvitation**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/accept-invitation.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L26) + +Accepts the invitation to the organization. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential.mdx new file mode 100644 index 000000000..79b586521 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential.mdx @@ -0,0 +1,38 @@ +--- +title: "AllowCredential" +--- + +Defined in: [interfaces/models/screen.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L10) + + +<RequestExample> +```ts +export interface AllowCredential { + type: 'public-key'; + id: Base64URLString; + transports?: AuthenticatorTransport[]; +} +``` +</RequestExample> + +## Properties + +<ParamField body='id' type='string'> +{/*> **id**: `string`*/} + +Defined in: [interfaces/models/screen.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L12) + +</ParamField> + +<ParamField body='transports?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/AuthenticatorTransport">AuthenticatorTransport</a></span>}> +{/*> `optional` **transports**: [`AuthenticatorTransport`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/AuthenticatorTransport)[]*/} + +Defined in: [interfaces/models/screen.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L13) + +</ParamField> + +<ParamField body='type' type='"public-key"'> +{/*> **type**: `"public-key"`*/} + +Defined in: [interfaces/models/screen.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L11) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail.mdx new file mode 100644 index 000000000..e52215d89 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail.mdx @@ -0,0 +1,27 @@ +--- +title: "AuthorizationDetail" +--- + +Defined in: [interfaces/models/screen.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L63) + + +<RequestExample> +```ts +export interface AuthorizationDetail { + type: string; + [key: string]: string; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` + +## Properties + +<ParamField body='type' type='string'> +{/*> **type**: `string`*/} + +Defined in: [interfaces/models/screen.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L64) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.mdx new file mode 100644 index 000000000..3cd774cef --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.mdx @@ -0,0 +1,165 @@ +--- +title: "BaseMembers" +--- + +Defined in: [interfaces/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L23) + + +<RequestExample> +```ts +export interface BaseMembers { + branding: BrandingMembers; + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + tenant: TenantMembers; + transaction: TransactionMembers; + user: UserMembers; + untrustedData: UntrustedDataMembers; +} +``` +</RequestExample> + +## Extended by + +- [`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers) +- [`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers) +- [`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers) +- [`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers) +- [`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers) +- [`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers) +- [`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers) +- [`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers) +- [`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers) +- [`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers) +- [`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers) +- [`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers) +- [`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers) +- [`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers) +- [`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers) +- [`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers) +- [`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers) +- [`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers) +- [`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers) +- [`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers) +- [`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers) +- [`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers) +- [`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers) +- [`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers) +- [`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers) +- [`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers) +- [`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers) +- [`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers) +- [`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers) +- [`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers) +- [`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers) +- [`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers) +- [`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers) +- [`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers) +- [`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers) +- [`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers) +- [`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers) +- [`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers) +- [`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers) +- [`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers) +- [`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers) +- [`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers) +- [`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers) +- [`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers) +- [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers) +- [`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers) +- [`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers) +- [`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers) +- [`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers) +- [`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers) +- [`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers) +- [`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers) +- [`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers) +- [`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers) +- [`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers) +- [`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers) +- [`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers) +- [`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers) +- [`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers) +- [`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers) +- [`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers) +- [`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers) +- [`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers) +- [`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers) +- [`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers) +- [`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers) +- [`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers) +- [`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers) +- [`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers) +- [`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers) +- [`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers) +- [`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers) +- [`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers) +- [`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers) +- [`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers) +- [`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding.mdx new file mode 100644 index 000000000..e150c2531 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding.mdx @@ -0,0 +1,41 @@ +--- +title: "Branding" +--- + +Defined in: [interfaces/models/organization.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L18) + + +<RequestExample> +```ts +export interface Branding { + logoUrl?: string; + colors?: { + primary?: string; + pageBackground?: string; + }; +} +``` +</RequestExample> + +## Properties + +<ParamField body='colors?' type='object'> +{/*> `optional` **colors**: `object`*/} + +Defined in: [interfaces/models/organization.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L20) + +#### pageBackground? + +{/*> `optional` **pageBackground**: `string`*/} + +#### primary? + +{/*> `optional` **primary**: `string`*/} + +</ParamField> + +<ParamField body='logoUrl?' type='string'> +{/*> `optional` **logoUrl**: `string`*/} + +Defined in: [interfaces/models/organization.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L19) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers.mdx new file mode 100644 index 000000000..fd7c63787 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers.mdx @@ -0,0 +1,30 @@ +--- +title: "BrandingMembers" +--- + +Defined in: [interfaces/models/branding.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L61) + + +<RequestExample> +```ts +export interface BrandingMembers { + settings: BrandingSettings | null; + themes: BrandingThemes | null; +} +``` +</RequestExample> + +## Properties + +<ParamField body='settings' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings">BrandingSettings</a></span>}> +{/*> **settings**: [`BrandingSettings`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings) \| `null`*/} + +Defined in: [interfaces/models/branding.ts:62](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L62) + +</ParamField> + +<ParamField body='themes' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes">BrandingThemes</a></span>}> +{/*> **themes**: [`BrandingThemes`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes) \| `null`*/} + +Defined in: [interfaces/models/branding.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L63) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings.mdx new file mode 100644 index 000000000..062a8c596 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings.mdx @@ -0,0 +1,64 @@ +--- +title: "BrandingSettings" +--- + +Defined in: [interfaces/models/branding.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L32) + + +<RequestExample> +```ts +export interface BrandingSettings { + colors?: { + primary?: string; + pageBackground?: + | string + | { + type: string; + start: string; + end: string; + angleDegree: number; + }; + }; + faviconUrl?: string; + logoUrl?: string; + fontUrl?: string; +} +``` +</RequestExample> + +## Properties + +<ParamField body='colors?' type='object'> +{/*> `optional` **colors**: `object`*/} + +Defined in: [interfaces/models/branding.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L33) + +#### pageBackground? + +{/*> `optional` **pageBackground**: `string` \| \{ `angleDegree`: `number`; `end`: `string`; `start`: `string`; `type`: `string`; \}*/} + +#### primary? + +{/*> `optional` **primary**: `string`*/} + +</ParamField> + +<ParamField body='faviconUrl?' type='string'> +{/*> `optional` **faviconUrl**: `string`*/} + +Defined in: [interfaces/models/branding.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L44) + +</ParamField> + +<ParamField body='fontUrl?' type='string'> +{/*> `optional` **fontUrl**: `string`*/} + +Defined in: [interfaces/models/branding.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L46) + +</ParamField> + +<ParamField body='logoUrl?' type='string'> +{/*> `optional` **logoUrl**: `string`*/} + +Defined in: [interfaces/models/branding.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L45) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes.mdx new file mode 100644 index 000000000..24715d83c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes.mdx @@ -0,0 +1,53 @@ +--- +title: "BrandingThemes" +--- + +Defined in: [interfaces/models/branding.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L49) + + +<RequestExample> +```ts +export interface BrandingThemes { + default: { + borders: Record<string, string | boolean | number>; + colors: Record<string, string>; + displayName: string; + fonts: Record<string, string | boolean | object>; + pageBackground: Record<string, string>; + widget: Record<string, string | number>; + }; +} +``` +</RequestExample> + +## Properties + +<ParamField body='default' type='object'> +{/*> **default**: `object`*/} + +Defined in: [interfaces/models/branding.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L50) + +#### borders + +{/*> **borders**: `Record`\<`string`, `string` \| `boolean` \| `number`\>*/} + +#### colors + +{/*> **colors**: `Record`\<`string`, `string`\>*/} + +#### displayName + +{/*> **displayName**: `string`*/} + +#### fonts + +{/*> **fonts**: `Record`\<`string`, `string` \| `boolean` \| `object`\>*/} + +#### pageBackground + +{/*> **pageBackground**: `Record`\<`string`, `string`\>*/} + +#### widget + +{/*> **widget**: `Record`\<`string`, `string` \| `number`\>*/} +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext.mdx new file mode 100644 index 000000000..533094404 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext.mdx @@ -0,0 +1,38 @@ +--- +title: "CaptchaContext" +--- + +Defined in: [interfaces/models/screen.ts:1](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L1) + + +<RequestExample> +```ts +export interface CaptchaContext { + provider: string; + image?: string; + siteKey?: string; +} +``` +</RequestExample> + +## Properties + +<ParamField body='image?' type='string'> +{/*> `optional` **image**: `string`*/} + +Defined in: [interfaces/models/screen.ts:3](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L3) + +</ParamField> + +<ParamField body='provider' type='string'> +{/*> **provider**: `string`*/} + +Defined in: [interfaces/models/screen.ts:2](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L2) + +</ParamField> + +<ParamField body='siteKey?' type='string'> +{/*> `optional` **siteKey**: `string`*/} + +Defined in: [interfaces/models/screen.ts:4](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L4) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers.mdx new file mode 100644 index 000000000..2edaeb9ca --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers.mdx @@ -0,0 +1,54 @@ +--- +title: "ClientMembers" +--- + +Defined in: [interfaces/models/client.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/client.ts#L12) + + +<RequestExample> +```ts +export interface ClientMembers { + id: string; + name: string; + logoUrl: string | null; + description: string | null; + metadata: { [key: string]: string } | null; +} +``` +</RequestExample> + +## Properties + +<ParamField body='description' type='string'> +{/*> **description**: `string` \| `null`*/} + +Defined in: [interfaces/models/client.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/client.ts#L16) + +</ParamField> + +<ParamField body='id' type='string'> +{/*> **id**: `string`*/} + +Defined in: [interfaces/models/client.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/client.ts#L13) + +</ParamField> + +<ParamField body='logoUrl' type='string'> +{/*> **logoUrl**: `string` \| `null`*/} + +Defined in: [interfaces/models/client.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/client.ts#L15) + +</ParamField> + +<ParamField body='metadata' type='key'> +{/*> **metadata**: \{\[`key`: `string`\]: `string`; \} \| `null`*/} + +Defined in: [interfaces/models/client.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/client.ts#L17) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/client.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/client.ts#L14) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions.mdx new file mode 100644 index 000000000..42ef54cc3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "ConfirmLogoutOptions" +--- + +Defined in: [interfaces/screens/logout.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/logout.ts#L7) + +Options for confirming logout + + +<RequestExample> +```ts +export interface ConfirmLogoutOptions extends CustomOptions { + /** The authentication transaction state */ + action: 'accept' | 'deny'; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='action' type='"accept"'> +{/*> **action**: `"accept"` \| `"deny"`*/} + +Defined in: [interfaces/screens/logout.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/logout.ts#L9) + +The authentication transaction state +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection.mdx new file mode 100644 index 000000000..0cf204d1a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection.mdx @@ -0,0 +1,42 @@ +--- +title: "Connection" +--- + +Defined in: [interfaces/models/transaction.ts:1](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L1) + + +<RequestExample> +```ts +export interface Connection { + name: string; + strategy: string; + metadata?: Record<string, string>; +} +``` +</RequestExample> + +## Extended by + +- [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection) + +## Properties + +<ParamField body='metadata?' type='Record'> +{/*> `optional` **metadata**: `Record`\<`string`, `string`\>*/} + +Defined in: [interfaces/models/transaction.ts:4](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L4) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:2](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L2) + +</ParamField> + +<ParamField body='strategy' type='string'> +{/*> **strategy**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:3](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L3) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.mdx new file mode 100644 index 000000000..b3b64b61a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.mdx @@ -0,0 +1,279 @@ +--- +title: "ConsentMembers" +--- + +Defined in: [interfaces/screens/consent.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/consent.ts#L40) + +ConsentMembers + + +<RequestExample> +```ts +export interface ConsentMembers extends BaseMembers { + /** + * Provides access to the specific properties and data of the Consent screen, + * including the list of `scopes` being requested and the `hideScopes` flag. + * @type {ScreenMembersOnConsent} + */ + screen: ScreenMembersOnConsent; + + /** + * Submits the user's decision to accept (grant) the requested permissions. + * This action posts to the `/u/consent` endpoint with `action: "accept"`. + * + * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs + * to be sent with the request. These parameters will be + * included in the form data submitted to the server. + * @returns {Promise<void>} A promise that resolves when the accept action is successfully submitted. + * On success, Auth0 typically redirects the user back to the application + * or to the next step in the authentication flow. + * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). + * Server-side errors (like "invalid_request") will be reflected in `this.transaction.errors` + * after the operation, rather than being thrown as JavaScript errors. + * + * @example + * ```typescript + * // Assuming 'consentManager' is an instance of the Consent screen SDK class + * try { + * await consentManager.accept(); + * // If successful, the page will typically redirect. + * } catch (error) { + * // Handle unexpected errors during the submission itself. + * console.error("Failed to submit consent acceptance:", error); + * } + * // After the await, check consentManager.transaction.errors for server-side validation issues. + * ``` + */ + accept(payload?: CustomOptions): Promise<void>; + + /** + * Submits the user's decision to deny (reject) the requested permissions. + * This action posts to the `/u/consent` endpoint with `action: "deny"`. + * + * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs + * to be sent with the request. These parameters will be + * included in the form data submitted to the server. + * @returns {Promise<void>} A promise that resolves when the deny action is successfully submitted. + * On success, Auth0 typically redirects the user, potentially showing an + * access denied message or returning an error to the application. + * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). + * Server-side errors are reflected in `this.transaction.errors`. + * + * @example + * ```typescript + * // Assuming 'consentManager' is an instance of the Consent screen SDK class + * try { + * await consentManager.deny({ reason: "user_declined" }); // Example custom option + * // If successful, the page will typically redirect. + * } catch (error) { + * console.error("Failed to submit consent denial:", error); + * } + * // After the await, check consentManager.transaction.errors for server-side validation issues. + * ``` + */ + deny(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent">ScreenMembersOnConsent</a></span>}> +{/*> **screen**: [`ScreenMembersOnConsent`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent)*/} + +Defined in: [interfaces/screens/consent.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/consent.ts#L46) + +Provides access to the specific properties and data of the Consent screen, +including the list of `scopes` being requested and the `hideScopes` flag. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='accept' type='Promise<void>'> +{/*> **accept**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/consent.ts:75](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/consent.ts#L75) + +Submits the user's decision to accept (grant) the requested permissions. +This action posts to the `/u/consent` endpoint with `action: "accept"`. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional. An object for any custom key-value pairs + to be sent with the request. These parameters will be + included in the form data submitted to the server. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the accept action is successfully submitted. + On success, Auth0 typically redirects the user back to the application + or to the next step in the authentication flow. + +#### Throws + +Throws an error if the form submission fails (e.g., network issue, invalid state). + Server-side errors (like "invalid_request") will be reflected in `this.transaction.errors` + after the operation, rather than being thrown as JavaScript errors. + +#### Example + +```typescript +// Assuming 'consentManager' is an instance of the Consent screen SDK class +try { + await consentManager.accept(); + // If successful, the page will typically redirect. +} catch (error) { + // Handle unexpected errors during the submission itself. + console.error("Failed to submit consent acceptance:", error); +} +// After the await, check consentManager.transaction.errors for server-side validation issues. +``` + +</ParamField> + +<ParamField body='deny' type='Promise<void>'> +{/*> **deny**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/consent.ts:102](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/consent.ts#L102) + +Submits the user's decision to deny (reject) the requested permissions. +This action posts to the `/u/consent` endpoint with `action: "deny"`. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional. An object for any custom key-value pairs + to be sent with the request. These parameters will be + included in the form data submitted to the server. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the deny action is successfully submitted. + On success, Auth0 typically redirects the user, potentially showing an + access denied message or returning an error to the application. + +#### Throws + +Throws an error if the form submission fails (e.g., network issue, invalid state). + Server-side errors are reflected in `this.transaction.errors`. + +#### Example + +```typescript +// Assuming 'consentManager' is an instance of the Consent screen SDK class +try { + await consentManager.deny({ reason: "user_declined" }); // Example custom option + // If successful, the page will typically redirect. +} catch (error) { + console.error("Failed to submit consent denial:", error); +} +// After the await, check consentManager.transaction.errors for server-side validation issues. +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions.mdx new file mode 100644 index 000000000..bfc122fdc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions.mdx @@ -0,0 +1,46 @@ +--- +title: "ContinueOTPOptions" +--- + +Defined in: [interfaces/screens/mfa-otp-challenge.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L26) + +Options for continuing with the OTP challenge + + +<RequestExample> +```ts +export interface ContinueOptions { + /** The code entered by the user */ + code: string; + /** Indicates whether to remember the browser */ + rememberDevice?: boolean; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/mfa-otp-challenge.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L28) + +The code entered by the user + +</ParamField> + +<ParamField body='rememberDevice?' type='boolean'> +{/*> `optional` **rememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/mfa-otp-challenge.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L30) + +Indicates whether to remember the browser +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions.mdx new file mode 100644 index 000000000..3d374dc62 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions.mdx @@ -0,0 +1,46 @@ +--- +title: "ContinueOptions" +--- + +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L17) + +Options for continuing with the email challenge. + + +<RequestExample> +```ts +export interface ContinueOptions { + /** The code entered by the user. */ + code: string; + /** Indicates whether to remember the device. */ + rememberDevice?: boolean; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L19) + +The code entered by the user. + +</ParamField> + +<ParamField body='rememberDevice?' type='boolean'> +{/*> `optional` **rememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L21) + +Indicates whether to remember the device. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions.mdx new file mode 100644 index 000000000..cf75e8ac4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions.mdx @@ -0,0 +1,46 @@ +--- +title: "ContinuePayloadOptions" +--- + +Defined in: [interfaces/screens/mfa-email-challenge.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L29) + +Options for continuing with the email challenge + + +<RequestExample> +```ts +export interface ContinueOptions { + /** The code entered by the user */ + code: string; + /** Indicates whether to remember the device */ + rememberDevice?: boolean; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/mfa-email-challenge.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L31) + +The code entered by the user + +</ParamField> + +<ParamField body='rememberDevice?' type='boolean'> +{/*> `optional` **rememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/mfa-email-challenge.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L33) + +Indicates whether to remember the device +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload.mdx new file mode 100644 index 000000000..5103964d5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload.mdx @@ -0,0 +1,55 @@ +--- +title: "ContinueWithCodeOptionPayload" +--- + +Defined in: [interfaces/screens/login-email-verification.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L12) + +ContinueWithCodeOptions +description Options for the `continueWithCode` method on the Login Email Verification screen. +This operation is used when the user submits the verification code they received via email +to proceed with the authentication flow. + + +<RequestExample> +```ts +export interface ContinueWithCodeOptions extends CustomOptions { + /** + * The verification code sent to the user's email. This is typically a short numeric + * or alphanumeric string that the user must enter into the form. + * @type {string} + * @example "123456" + * @example "ABCXYZ" + */ + code: string; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/login-email-verification.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L20) + +The verification code sent to the user's email. This is typically a short numeric +or alphanumeric string that the user must enter into the form. + +#### Examples + +```ts +"123456" +``` + +```ts +"ABCXYZ" +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions.mdx new file mode 100644 index 000000000..9bccd78e6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions.mdx @@ -0,0 +1,39 @@ +--- +title: "ContinueWithOrganizationNameOptions" +--- + +Defined in: [interfaces/screens/organization-selection.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L12) + +Options for continuing with the selected organization name. + + +<RequestExample> +```ts +export interface ContinueWithOrganizationNameOptions { + /** + * The organization name. + */ + organizationName: string; + /** + * Any additional custom options. + */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options. + +## Properties + +<ParamField body='organizationName' type='string'> +{/*> **organizationName**: `string`*/} + +Defined in: [interfaces/screens/organization-selection.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L16) + +The organization name. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse.mdx new file mode 100644 index 000000000..7506ea479 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse.mdx @@ -0,0 +1,38 @@ +--- +title: "CredentialResponse" +--- + +Defined in: [interfaces/utils/passkeys.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L15) + + +<RequestExample> +```ts +export interface CredentialResponse { + clientDataJSON: string | null; + attestationObject: string | null; + transports?: string[]; +} +``` +</RequestExample> + +## Properties + +<ParamField body='attestationObject' type='string'> +{/*> **attestationObject**: `string` \| `null`*/} + +Defined in: [interfaces/utils/passkeys.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L17) + +</ParamField> + +<ParamField body='clientDataJSON' type='string'> +{/*> **clientDataJSON**: `string` \| `null`*/} + +Defined in: [interfaces/utils/passkeys.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L16) + +</ParamField> + +<ParamField body='transports?' type='string'> +{/*> `optional` **transports**: `string`[]*/} + +Defined in: [interfaces/utils/passkeys.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L18) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CurrentScreenOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CurrentScreenOptions.mdx new file mode 100644 index 000000000..90b8020ed --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CurrentScreenOptions.mdx @@ -0,0 +1,90 @@ +--- +title: "CurrentScreenOptions" +--- + +Defined in: [interfaces/common/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L27) + +CurrentScreenOptions details. + + +<RequestExample> +```ts +export interface CurrentScreenOptions { + client: { + id: string; + metadata: Record<string, string> | null; + } | null; + organization: { + id: string; + metadata: Record<string, string> | null; + } | null; + prompt: { + name: string; + } | null; + screen: { + name: string; + } | null; + tenant: { + enabledLocales: string[]; + } | null; + transaction: { + errors: TransactionError[] | null; + state: string; + locale: string; + } | null; + untrustedData: { + authorizationParams: Record<string, string> | null; + } | null; +} +``` +</RequestExample> + +## Properties + +<ParamField body='client' type='id'> +{/*> **client**: \{ `id`: `string`; `metadata`: `Record`\<`string`, `string`\> \| `null`; \} \| `null`*/} + +Defined in: [interfaces/common/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L28) + +</ParamField> + +<ParamField body='organization' type='id'> +{/*> **organization**: \{ `id`: `string`; `metadata`: `Record`\<`string`, `string`\> \| `null`; \} \| `null`*/} + +Defined in: [interfaces/common/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L32) + +</ParamField> + +<ParamField body='prompt' type='name'> +{/*> **prompt**: \{ `name`: `string`; \} \| `null`*/} + +Defined in: [interfaces/common/index.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L36) + +</ParamField> + +<ParamField body='screen' type='name'> +{/*> **screen**: \{ `name`: `string`; \} \| `null`*/} + +Defined in: [interfaces/common/index.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L39) + +</ParamField> + +<ParamField body='tenant' type='enabledLocales'> +{/*> **tenant**: \{ `enabledLocales`: `string`[]; \} \| `null`*/} + +Defined in: [interfaces/common/index.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L42) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> +{/*> **transaction**: \{ `errors`: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`; `locale`: `string`; `state`: `string`; \} \| `null`*/} + +Defined in: [interfaces/common/index.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L45) + +</ParamField> + +<ParamField body='untrustedData' type='authorizationParams'> +{/*> **untrustedData**: \{ `authorizationParams`: `Record`\<`string`, `string`\> \| `null`; \} \| `null`*/} + +Defined in: [interfaces/common/index.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L50) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions.mdx new file mode 100644 index 000000000..970ee847a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions.mdx @@ -0,0 +1,50 @@ +--- +title: "CustomOptions" +--- + +Defined in: [interfaces/common/index.ts:2](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L2) + + +<RequestExample> +```ts +export interface CustomOptions { + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Extended by + +- [`OtpCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions) +- [`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions) +- [`MfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions) +- [`MfaPhoneChallengePickPhoneOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions) +- [`MfaPhoneChallengePickAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions) +- [`MfaRecoveryCodeEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions) +- [`ResetPasswordMfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions) +- [`ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions) +- [`MfaRecoveryCodeChallengeNewCodeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions) +- [`ConfirmLogoutOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions) +- [`ContinueWithCodeOptionPayload`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload) +- [`ResendCodeOptionsPayload`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload) +- [`SubmitPasskeyCredentialOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions) +- [`VerifySecurityKeyOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions) +- [`MfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions) +- [`VerifyPlatformAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions) +- [`MfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions) +- [`WebAuthnEnrollSuccessContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions) +- [`MfaWebAuthnChangeKeyNicknameContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions) +- [`ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions) +- [`ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions) +- [`ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions) +- [`ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions) +- [`MfaOtpEnrollmentQrContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions) +- [`DeviceCodeActivationContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions) +- [`MfaPhoneEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions) +- [`MfaRecoveryCodeChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions) +- [`MfaVoiceEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions) +- [`ResetPasswordMfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.mdx new file mode 100644 index 000000000..91d76e8f1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.mdx @@ -0,0 +1,283 @@ +--- +title: "CustomizedConsentMembers" +--- + +Defined in: [interfaces/screens/customized-consent.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L52) + +CustomizedConsentMembers + + +<RequestExample> +```ts +export interface CustomizedConsentMembers extends BaseMembers { + /** + * Provides access to the specific properties and data of the Customized Consent screen, + * including the list of `scopes` and `authorizationDetails` being requested. + * @type {ScreenMembersOnCustomizedConsent} + */ + screen: ScreenMembersOnCustomizedConsent; + + /** + * Submits the user's decision to accept (grant) the requested permissions and authorization details. + * This action posts to the `/u/customized-consent` endpoint with `action: "accept"`. + * The transaction state is automatically included. + * + * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs + * to be sent with the request. These parameters will be + * included in the form data submitted to the server. + * @returns {Promise<void>} A promise that resolves when the accept action is successfully submitted. + * On success, Auth0 typically redirects the user back to the application + * or to the next step in the authentication flow. + * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). + * Server-side errors (like "invalid_request") will be reflected in `this.transaction.errors` + * after the operation, rather than being thrown as JavaScript errors. + * + * @example + * ```typescript + * // Assuming 'customizedConsentManager' is an instance of the CustomizedConsent SDK class + * try { + * await customizedConsentManager.accept(); + * // If successful, the page will typically redirect. + * } catch (error) { + * // Handle unexpected errors during the submission itself. + * console.error("Failed to submit consent acceptance:", error); + * } + * // After the await, check customizedConsentManager.transaction.errors for server-side validation issues. + * ``` + */ + accept(payload?: CustomOptions): Promise<void>; + + /** + * Submits the user's decision to deny (reject) the requested permissions and authorization details. + * This action posts to the `/u/customized-consent` endpoint with `action: "deny"`. + * The transaction state is automatically included. + * + * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs + * to be sent with the request. These parameters will be + * included in the form data submitted to the server. + * @returns {Promise<void>} A promise that resolves when the deny action is successfully submitted. + * On success, Auth0 typically redirects the user, potentially showing an + * access denied message or returning an error to the application. + * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). + * Server-side errors are reflected in `this.transaction.errors`. + * + * @example + * ```typescript + * // Assuming 'customizedConsentManager' is an instance of the CustomizedConsent SDK class + * try { + * await customizedConsentManager.deny({ reason_code: "user_rejected_details" }); // Example custom option + * // If successful, the page will typically redirect. + * } catch (error) { + * console.error("Failed to submit consent denial:", error); + * } + * // After the await, check customizedConsentManager.transaction.errors for server-side validation issues. + * ``` + */ + deny(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent">ScreenMembersOnCustomizedConsent</a></span>}> +{/*> **screen**: [`ScreenMembersOnCustomizedConsent`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent)*/} + +Defined in: [interfaces/screens/customized-consent.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L58) + +Provides access to the specific properties and data of the Customized Consent screen, +including the list of `scopes` and `authorizationDetails` being requested. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='accept' type='Promise<void>'> +{/*> **accept**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/customized-consent.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L88) + +Submits the user's decision to accept (grant) the requested permissions and authorization details. +This action posts to the `/u/customized-consent` endpoint with `action: "accept"`. +The transaction state is automatically included. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional. An object for any custom key-value pairs + to be sent with the request. These parameters will be + included in the form data submitted to the server. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the accept action is successfully submitted. + On success, Auth0 typically redirects the user back to the application + or to the next step in the authentication flow. + +#### Throws + +Throws an error if the form submission fails (e.g., network issue, invalid state). + Server-side errors (like "invalid_request") will be reflected in `this.transaction.errors` + after the operation, rather than being thrown as JavaScript errors. + +#### Example + +```typescript +// Assuming 'customizedConsentManager' is an instance of the CustomizedConsent SDK class +try { + await customizedConsentManager.accept(); + // If successful, the page will typically redirect. +} catch (error) { + // Handle unexpected errors during the submission itself. + console.error("Failed to submit consent acceptance:", error); +} +// After the await, check customizedConsentManager.transaction.errors for server-side validation issues. +``` + +</ParamField> + +<ParamField body='deny' type='Promise<void>'> +{/*> **deny**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/customized-consent.ts:116](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L116) + +Submits the user's decision to deny (reject) the requested permissions and authorization details. +This action posts to the `/u/customized-consent` endpoint with `action: "deny"`. +The transaction state is automatically included. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional. An object for any custom key-value pairs + to be sent with the request. These parameters will be + included in the form data submitted to the server. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the deny action is successfully submitted. + On success, Auth0 typically redirects the user, potentially showing an + access denied message or returning an error to the application. + +#### Throws + +Throws an error if the form submission fails (e.g., network issue, invalid state). + Server-side errors are reflected in `this.transaction.errors`. + +#### Example + +```typescript +// Assuming 'customizedConsentManager' is an instance of the CustomizedConsent SDK class +try { + await customizedConsentManager.deny({ reason_code: "user_rejected_details" }); // Example custom option + // If successful, the page will typically redirect. +} catch (error) { + console.error("Failed to submit consent denial:", error); +} +// After the await, check customizedConsentManager.transaction.errors for server-side validation issues. +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.mdx new file mode 100644 index 000000000..c332ce2ba --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.mdx @@ -0,0 +1,118 @@ +--- +title: "DeviceCodeActivationAllowedMembers" +--- + +Defined in: [interfaces/screens/device-code-activation-allowed.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-activation-allowed.ts#L6) + +Interface describing the members of the Device Code Activation Allowed screen. + + +<RequestExample> +```ts +export interface DeviceCodeActivationAllowedMembers extends BaseMembers {} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions.mdx new file mode 100644 index 000000000..3e63c2b15 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions.mdx @@ -0,0 +1,36 @@ +--- +title: "DeviceCodeActivationContinueOptions" +--- + +Defined in: [interfaces/screens/device-code-activation.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-activation.ts#L11) + +payload for continuing device code activation. + +This interface extends `CustomOptions`, meaning all custom option properties +are merged into the top level of the object. This avoids nesting and provides +a simpler structure for consumers of this interface. + + +<RequestExample> +```ts +export interface ContinueOptions extends CustomOptions { + code: string; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/device-code-activation.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-activation.ts#L12) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.mdx new file mode 100644 index 000000000..b3b35b6ee --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.mdx @@ -0,0 +1,118 @@ +--- +title: "DeviceCodeActivationDeniedMembers" +--- + +Defined in: [interfaces/screens/device-code-activation-denied.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-activation-denied.ts#L6) + +Interface describing the members of the Device Code Activation Denied screen. + + +<RequestExample> +```ts +export interface DeviceCodeActivationDeniedMembers extends BaseMembers {} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.mdx new file mode 100644 index 000000000..d4fd38809 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.mdx @@ -0,0 +1,156 @@ +--- +title: "DeviceCodeActivationMembers" +--- + +Defined in: [interfaces/screens/device-code-activation.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-activation.ts#L18) + +Interface describing the members of the Device Code Activation screen. + + +<RequestExample> +```ts +export interface DeviceCodeActivationMembers extends BaseMembers { + /** + * Submits the device code entered by the user. + * This action is triggered when the user enters the code displayed on their device and submits the form. + * + * @param {object} payload - An object containing the code entered by the user and any custom payload. + * @param {string} payload.code - The device code entered by the user. + * + * @returns {Promise<void>} A promise that resolves when the code is successfully submitted. + * Rejects with an error if the submission fails. + */ + continue(payload: ContinueOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/device-code-activation.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-activation.ts#L29) + +Submits the device code entered by the user. +This action is triggered when the user enters the code displayed on their device and submits the form. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions">DeviceCodeActivationContinueOptions</a></span>}> +[`DeviceCodeActivationContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions) + +An object containing the code entered by the user and any custom payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the code is successfully submitted. +Rejects with an error if the submission fails. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.mdx new file mode 100644 index 000000000..e033bc46b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.mdx @@ -0,0 +1,175 @@ +--- +title: "DeviceCodeConfirmationMembers" +--- + +Defined in: [interfaces/screens/device-code-confirmation.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L17) + +Interface describing the members of the Device Code Confirmation screen. + + +<RequestExample> +```ts +export interface DeviceCodeConfirmationMembers extends BaseMembers { + screen: ScreenMembersOnDeviceCodeConfirmation; + + /** + * Confirms the device code. + * @param payload Optional custom options to include with the request. + */ + confirm(payload?: CustomOptions): Promise<void>; + + /** + * Cancels the device code flow. + * @param payload Optional custom options to include with the request. + */ + cancel(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation">ScreenMembersOnDeviceCodeConfirmation</a></span>}> +{/*> **screen**: [`ScreenMembersOnDeviceCodeConfirmation`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation)*/} + +Defined in: [interfaces/screens/device-code-confirmation.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L18) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='cancel' type='Promise<void>'> +{/*> **cancel**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/device-code-confirmation.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L30) + +Cancels the device code flow. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='confirm' type='Promise<void>'> +{/*> **confirm**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/device-code-confirmation.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L24) + +Confirms the device code. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions.mdx new file mode 100644 index 000000000..af14baff7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "EmailChallengeOptions" +--- + +Defined in: [interfaces/screens/email-identifier-challenge.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L6) + + +<RequestExample> +```ts +export interface EmailChallengeOptions { + code: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='captcha?' type='string'> +{/*> `optional` **captcha**: `string`*/} + +Defined in: [interfaces/screens/email-identifier-challenge.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L8) + +</ParamField> + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/email-identifier-challenge.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L7) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.mdx new file mode 100644 index 000000000..598049fdc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.mdx @@ -0,0 +1,191 @@ +--- +title: "EmailIdentifierChallengeMembers" +--- + +Defined in: [interfaces/screens/email-identifier-challenge.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L20) + + +<RequestExample> +```ts +export interface EmailIdentifierChallengeMembers extends BaseMembers { + screen: ScreenMembersOnEmailIdentifierChallenge; + submitEmailChallenge(payload: EmailChallengeOptions): Promise<void>; + resendCode(payload?: CustomOptions): Promise<void>; + resendManager(payload?: StartResendOptions): ResendControl; + returnToPrevious(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge">ScreenMembersOnEmailIdentifierChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnEmailIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge)*/} + +Defined in: [interfaces/screens/email-identifier-challenge.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L21) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/email-identifier-challenge.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L23) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`payload?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [interfaces/screens/email-identifier-challenge.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L24) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +</ParamField> + +<ParamField body='returnToPrevious' type='Promise<void>'> +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/email-identifier-challenge.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L25) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='submitEmailChallenge' type='Promise<void>'> +{/*> **submitEmailChallenge**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/email-identifier-challenge.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L22) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions">EmailChallengeOptions</a></span>}> +[`EmailChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.mdx new file mode 100644 index 000000000..04c68e7d2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.mdx @@ -0,0 +1,199 @@ +--- +title: "EmailOTPChallengeMembers" +--- + +Defined in: [interfaces/screens/email-otp-challenge.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L25) + +Represents the Email OTP Challenge screen interface. + + +<RequestExample> +```ts +export interface EmailOTPChallengeMembers extends BaseMembers { + screen: ScreenMembersOnEmailOTPChallenge; + /** + * Submits the OTP code entered by the user. + * @param options Optional parameters to include in the submission. + */ + submitCode(options: OtpCodeOptions): Promise<void>; + /** + * Requests a new OTP code to be sent to the user's email. + * @param options Optional parameters to include in the resend request. + */ + resendCode(options?: CustomOptions): Promise<void>; + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge">ScreenMembersOnEmailOTPChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnEmailOTPChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge)*/} + +Defined in: [interfaces/screens/email-otp-challenge.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L26) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/email-otp-challenge.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L36) + +Requests a new OTP code to be sent to the user's email. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional parameters to include in the resend request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [interfaces/screens/email-otp-challenge.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L41) + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +</ParamField> + +<ParamField body='submitCode' type='Promise<void>'> +{/*> **submitCode**(`options`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/email-otp-challenge.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L31) + +Submits the OTP code entered by the user. + +<Expandable title="Parameters"> +<ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions">OtpCodeOptions</a></span>}> +[`OtpCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions) + +Optional parameters to include in the submission. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.mdx new file mode 100644 index 000000000..9ac8b21f8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.mdx @@ -0,0 +1,127 @@ +--- +title: "EmailVerificationResultMembers" +--- + +Defined in: [interfaces/screens/email-verification-result.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts#L45) + +EmailVerificationResultMembers + + +<RequestExample> +```ts +export interface EmailVerificationResultMembers extends BaseMembers { + /** + * Provides access to the specific properties and data of the Email Verification Result screen, + * including the verification `status` and the `login` link. + * @type {ScreenMembersOnEmailVerificationResult} + */ + screen: ScreenMembersOnEmailVerificationResult; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult">ScreenMembersOnEmailVerificationResult</a></span>}> +{/*> **screen**: [`ScreenMembersOnEmailVerificationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult)*/} + +Defined in: [interfaces/screens/email-verification-result.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts#L51) + +Screen-specific data, including verification status and login link. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice.mdx new file mode 100644 index 000000000..7e5e989b3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice.mdx @@ -0,0 +1,30 @@ +--- +title: "EnrolledDevice" +--- + +Defined in: [interfaces/models/user.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L12) + + +<RequestExample> +```ts +export interface EnrolledDevice { + id: number; + device: string; +} +``` +</RequestExample> + +## Properties + +<ParamField body='device' type='string'> +{/*> **device**: `string`*/} + +Defined in: [interfaces/models/user.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L14) + +</ParamField> + +<ParamField body='id' type='number'> +{/*> **id**: `number`*/} + +Defined in: [interfaces/models/user.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L13) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail.mdx new file mode 100644 index 000000000..a3c97e809 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail.mdx @@ -0,0 +1,30 @@ +--- +title: "EnrolledEmail" +--- + +Defined in: [interfaces/models/user.ts:2](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L2) + + +<RequestExample> +```ts +export interface EnrolledEmail { + id: number; + email: string; +} +``` +</RequestExample> + +## Properties + +<ParamField body='email' type='string'> +{/*> **email**: `string`*/} + +Defined in: [interfaces/models/user.ts:4](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L4) + +</ParamField> + +<ParamField body='id' type='number'> +{/*> **id**: `number`*/} + +Defined in: [interfaces/models/user.ts:3](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L3) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber.mdx new file mode 100644 index 000000000..c92c1502d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber.mdx @@ -0,0 +1,30 @@ +--- +title: "EnrolledPhoneNumber" +--- + +Defined in: [interfaces/models/user.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L7) + + +<RequestExample> +```ts +export interface EnrolledPhoneNumber { + id: number; + phoneNumber: string; +} +``` +</RequestExample> + +## Properties + +<ParamField body='id' type='number'> +{/*> **id**: `number`*/} + +Defined in: [interfaces/models/user.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L8) + +</ParamField> + +<ParamField body='phoneNumber' type='string'> +{/*> **phoneNumber**: `string`*/} + +Defined in: [interfaces/models/user.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L9) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection.mdx new file mode 100644 index 000000000..aee05d3a9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection.mdx @@ -0,0 +1,75 @@ +--- +title: "EnterpriseConnection" +--- + +Defined in: [interfaces/models/transaction.ts:126](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L126) + + +<RequestExample> +```ts +export interface EnterpriseConnection extends Connection { + options: { + iconUrl?: string; + displayName?: string; + showAsButton: boolean; + }; +} +``` +</RequestExample> + +## Extends + +- [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) + +## Properties + +<ParamField body='metadata?' type='Record'> +{/*> `optional` **metadata**: `Record`\<`string`, `string`\>*/} + +Defined in: [interfaces/models/transaction.ts:4](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L4) + +#### Inherited from + +[`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection).[`metadata`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection.md#metadata) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:2](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L2) + +#### Inherited from + +[`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection.md#name) + +</ParamField> + +<ParamField body='options' type='object'> +{/*> **options**: `object`*/} + +Defined in: [interfaces/models/transaction.ts:127](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L127) + +#### displayName? + +{/*> `optional` **displayName**: `string`*/} + +#### iconUrl? + +{/*> `optional` **iconUrl**: `string`*/} + +#### showAsButton + +{/*> **showAsButton**: `boolean`*/} + +</ParamField> + +<ParamField body='strategy' type='string'> +{/*> **strategy**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:3](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L3) + +#### Inherited from + +[`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection).[`strategy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection.md#strategy) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error.mdx new file mode 100644 index 000000000..7ba26e227 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error.mdx @@ -0,0 +1,46 @@ +--- +title: "Error" +--- + +Defined in: [interfaces/models/transaction.ts:149](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L149) + + +<RequestExample> +```ts +export interface Error { + code: string; + field?: string; + message: string; + rules?: PasswordComplexityRule[]; +} +``` +</RequestExample> + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:150](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L150) + +</ParamField> + +<ParamField body='field?' type='string'> +{/*> `optional` **field**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:151](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L151) + +</ParamField> + +<ParamField body='message' type='string'> +{/*> **message**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:152](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L152) + +</ParamField> + +<ParamField body='rules?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule">PasswordComplexityRule</a></span>}> +{/*> `optional` **rules**: [`PasswordComplexityRule`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule)[]*/} + +Defined in: [interfaces/models/transaction.ts:153](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L153) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions.mdx new file mode 100644 index 000000000..79d4ee192 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "FederatedLoginOptions" +--- + +Defined in: [interfaces/screens/login-id.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L52) + + +<RequestExample> +```ts +export interface FederatedLoginOptions { + connection: string; + [key: string]: string | number | boolean; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + +<ParamField body='connection' type='string'> +{/*> **connection**: `string`*/} + +Defined in: [interfaces/screens/login-id.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L53) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions.mdx new file mode 100644 index 000000000..b77e8db4c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "FederatedLoginPasswordOptions" +--- + +Defined in: [interfaces/screens/login-password.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L48) + + +<RequestExample> +```ts +export interface FederatedLoginOptions { + connection: string; + [key: string]: string | number | boolean; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + +<ParamField body='connection' type='string'> +{/*> **connection**: `string`*/} + +Defined in: [interfaces/screens/login-password.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L49) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions.mdx new file mode 100644 index 000000000..46f4360f5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "FederatedLoginPayloadOptions" +--- + +Defined in: [interfaces/screens/login.ts:70](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L70) + +Options for performing social login operations + + +<RequestExample> +```ts +export interface FederatedLoginOptions { + /** The social connection name to use */ + connection: string; + /** Any additional custom options */ + [key: string]: string | number | boolean; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +Any additional custom options + +## Properties + +<ParamField body='connection' type='string'> +{/*> **connection**: `string`*/} + +Defined in: [interfaces/screens/login.ts:72](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L72) + +The social connection name to use +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions.mdx new file mode 100644 index 000000000..0c4da3a7f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "FederatedSignupOptions" +--- + +Defined in: [interfaces/screens/signup-id.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L41) + + +<RequestExample> +```ts +export interface FederatedSignupOptions { + connection: string; + [key: string]: string | number | boolean; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + +<ParamField body='connection' type='string'> +{/*> **connection**: `string`*/} + +Defined in: [interfaces/screens/signup-id.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L42) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions.mdx new file mode 100644 index 000000000..975fbd451 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "FederatedSignupPasswordPayloadOptions" +--- + +Defined in: [interfaces/screens/signup-password.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L24) + + +<RequestExample> +```ts +export interface FederatedSignupOptions { + connection: string; + [key: string]: string | number | boolean; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + +<ParamField body='connection' type='string'> +{/*> **connection**: `string`*/} + +Defined in: [interfaces/screens/signup-password.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L25) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions.mdx new file mode 100644 index 000000000..244df3151 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "FederatedSignupPayloadOptions" +--- + +Defined in: [interfaces/screens/signup.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L18) + + +<RequestExample> +```ts +export interface FederatedSignupOptions { + connection: string; + [key: string]: string | number | boolean; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + +<ParamField body='connection' type='string'> +{/*> **connection**: `string`*/} + +Defined in: [interfaces/screens/signup.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L19) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FlattenedTheme.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FlattenedTheme.mdx new file mode 100644 index 000000000..d8e78379e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FlattenedTheme.mdx @@ -0,0 +1,54 @@ +--- +title: "FlattenedTheme" +--- + +Defined in: [interfaces/common/index.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L55) + + +<RequestExample> +```ts +export interface FlattenedTheme { + colors: Record<string, string>; + fonts: Record<string, string | number | boolean | object>; + borders: Record<string, string | number | boolean>; + pageBackground: Record<string, string>; + widget: Record<string, string | number>; +} +``` +</RequestExample> + +## Properties + +<ParamField body='borders' type='Record'> +{/*> **borders**: `Record`\<`string`, `string` \| `number` \| `boolean`\>*/} + +Defined in: [interfaces/common/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L58) + +</ParamField> + +<ParamField body='colors' type='Record'> +{/*> **colors**: `Record`\<`string`, `string`\>*/} + +Defined in: [interfaces/common/index.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L56) + +</ParamField> + +<ParamField body='fonts' type='Record'> +{/*> **fonts**: `Record`\<`string`, `string` \| `number` \| `boolean` \| `object`\>*/} + +Defined in: [interfaces/common/index.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L57) + +</ParamField> + +<ParamField body='pageBackground' type='Record'> +{/*> **pageBackground**: `Record`\<`string`, `string`\>*/} + +Defined in: [interfaces/common/index.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L59) + +</ParamField> + +<ParamField body='widget' type='Record'> +{/*> **widget**: `Record`\<`string`, `string` \| `number`\>*/} + +Defined in: [interfaces/common/index.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L60) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier.mdx new file mode 100644 index 000000000..4c4d8291f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier.mdx @@ -0,0 +1,59 @@ +--- +title: "Identifier" +--- + +Defined in: [interfaces/utils/signup-identifiers.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts#L30) + +Describes a configured identifier field (e.g. email, phone, or username) +for use in a signup form or authentication flow. + + +<RequestExample> +```ts +export interface Identifier { + /** + * The type of identifier, such as `'email'`, `'phone'`, or `'username'`. + * + * @see IdentifierType + */ + type: IdentifierType; + + /** + * Whether this identifier is required for signup. + */ + required: boolean; +} +``` +</RequestExample> + +## Example + +```ts +const emailIdentifier: Identifier = { + type: 'email', + required: true +}; +``` + +## Properties + +<ParamField body='required' type='boolean'> +{/*> **required**: `boolean`*/} + +Defined in: [interfaces/utils/signup-identifiers.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts#L41) + +Whether this identifier is required for signup. + +</ParamField> + +<ParamField body='type' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType">ScreenIdentifierType</a></span>}> +{/*> **type**: [`ScreenIdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType)*/} + +Defined in: [interfaces/utils/signup-identifiers.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts#L36) + +The type of identifier, such as `'email'`, `'phone'`, or `'username'`. + +#### See + +IdentifierType +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.mdx new file mode 100644 index 000000000..d53d869d4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.mdx @@ -0,0 +1,134 @@ +--- +title: "InterstitialCaptchaMembers" +--- + +Defined in: [interfaces/screens/interstitial-captcha.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts#L8) + + +<RequestExample> +```ts +export interface InterstitialCaptchaMembers extends BaseMembers { + submitCaptcha: (payload: SubmitCaptchaOptions) => void; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='Parameters' type='unknown'>{/*> **submitCaptcha**: (`payload`) => `void`*/} + +Defined in: [interfaces/screens/interstitial-captcha.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts#L9) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions">SubmitCaptchaOptions</a></span>}> +{/*> **payload**: [`SubmitCaptchaOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions)*/} +</ParamField> +</Expandable> +#### Returns + +`void` + + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.mdx new file mode 100644 index 000000000..1668d6992 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.mdx @@ -0,0 +1,367 @@ +--- +title: "LoginEmailVerificationMembers" +--- + +Defined in: [interfaces/screens/login-email-verification.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L48) + +LoginEmailVerificationMembers +description Defines the members (properties and methods) available for interacting with the Login Email Verification screen. +This screen is a crucial part of email verification processes, typically during login, where a user must prove +ownership of an email address by providing a one-time code. The SDK facilitates submitting this code +or requesting a new one. + +The `universal_login_context` for this screen (`window.universal_login_context`) will contain: +- `client`: Information about the Auth0 application. +- `organization` (optional): Details if the authentication is for a specific organization. +- `prompt`: Context of the current authentication prompt (e.g., 'login'). +- `screen`: UI texts and general screen information. No screen-specific `data` fields are uniquely defined for `login-email-verification` beyond standard ones. +- `transaction`: Details of the ongoing transaction, including state and any errors from previous attempts (e.g., "invalid-code"). + + +<RequestExample> +```ts +export interface LoginEmailVerificationMembers extends BaseMembers { + /** + * Submits the email verification code entered by the user. + * This action corresponds to the user entering the code they received via email and + * clicking a "Continue" or "Verify" button. The SDK will then POST this code + * to the Auth0 `/u/login-email-verification` endpoint. + * + * If the code is valid, Auth0 will typically redirect the user to the next step in the + * authentication flow. If the code is invalid, expired, or another error occurs, + * Auth0 will usually re-render the login-email-verification screen, and the + * `transaction.errors` array in the SDK's context will be updated with details + * about the failure (e.g., error code `invalid-code`). + * + * @param {ContinueWithCodeOptions} payload - An object containing the `code` string entered by the user. + * It can also include any `CustomOptions` for extensibility. + * @returns {Promise<void>} A promise that resolves when the form submission is initiated. + * It does not return data directly upon resolution, as a redirect or + * page re-render is the common outcome. + * @throws {Error} Throws an error if `payload.code` is not provided or is not a string, + * or if the `FormHandler` encounters an unrecoverable issue during submission (e.g., network error). + * Validation errors from Auth0 (like an invalid code) are not thrown as JavaScript errors + * but are reflected in `this.transaction.errors` after the operation. + * + * @example + * ```typescript + * // Assuming 'manager' is an instance of LoginEmailVerification + * const userInputCode = "123456"; + * try { + * await manager.continueWithCode({ code: userInputCode }); + * // If successful, page redirects. No further client-side action needed here. + * } catch (error) { + * // This catch is for unexpected errors, not for Auth0 validation errors. + * console.error("Failed to submit the verification code:", error); + * } + * // After the await, always check manager.transaction.errors for server-side validation issues. + * if (manager.transaction.errors && manager.transaction.errors.length > 0) { + * manager.transaction.errors.forEach(err => { + * if (err.code === 'invalid-code') { + * // Display "The code you entered is invalid" to the user. + * } + * }); + * } + * ``` + */ + continueWithCode(payload: ContinueWithCodeOptions): Promise<void>; + + /** + * Requests a new verification code to be sent to the user's email address. + * This action is typically invoked when the user clicks a "Resend Code" button, perhaps because + * they didn't receive the first email, the code expired, or they suspect an issue. + * The SDK will POST to the Auth0 `/u/login-email-verification` endpoint with an action indicating + * a resend request. + * + * Upon successful submission of this request, Auth0 attempts to send a new email. + * The page may re-render. If there are issues (e.g., too many resend attempts for the same email, + * identified by error code `too-many-emails`), `transaction.errors` will be updated. + * + * @param {ResendCodeOptions} [payload] - Optional. An object for `CustomOptions` if any + * additional parameters need to be sent with the request. + * @returns {Promise<void>} A promise that resolves when the resend request is initiated. + * Like `continueWithCode`, this usually results in a page re-render or state update + * rather than direct data in the promise resolution. + * @throws {Error} Throws if the `FormHandler` encounters an unrecoverable issue (e.g., network error). + * Server-side errors (like rate limits) are reflected in `this.transaction.errors`. + * + * @example + * ```typescript + * // Assuming 'manager' is an instance of LoginEmailVerification + * try { + * await manager.resendCode(); + * // Optionally, update UI to inform the user a new code has been sent. + * alert("A new verification code has been dispatched to your email."); + * } catch (error) { + * console.error("Failed to request a new code:", error); + * } + * // After the await, check manager.transaction.errors for server-side issues. + * if (manager.transaction.errors && manager.transaction.errors.length > 0) { + * manager.transaction.errors.forEach(err => { + * if (err.code === 'too-many-emails') { + * // Display "You have requested too many emails. Please wait a few minutes." + * } + * }); + * } + * ``` + */ + resendCode(payload?: ResendCodeOptions): Promise<void>; + + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continueWithCode' type='Promise<void>'> +{/*> **continueWithCode**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/login-email-verification.ts:92](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L92) + +Submits the email verification code entered by the user. +This action corresponds to the user entering the code they received via email and +clicking a "Continue" or "Verify" button. The SDK will then POST this code +to the Auth0 `/u/login-email-verification` endpoint. + +If the code is valid, Auth0 will typically redirect the user to the next step in the +authentication flow. If the code is invalid, expired, or another error occurs, +Auth0 will usually re-render the login-email-verification screen, and the +`transaction.errors` array in the SDK's context will be updated with details +about the failure (e.g., error code `invalid-code`). + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload">ContinueWithCodeOptionPayload</a></span>}> +[`ContinueWithCodeOptionPayload`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload) + +An object containing the `code` string entered by the user. + It can also include any `CustomOptions` for extensibility. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the form submission is initiated. + It does not return data directly upon resolution, as a redirect or + page re-render is the common outcome. + +#### Throws + +Throws an error if `payload.code` is not provided or is not a string, + or if the `FormHandler` encounters an unrecoverable issue during submission (e.g., network error). + Validation errors from Auth0 (like an invalid code) are not thrown as JavaScript errors + but are reflected in `this.transaction.errors` after the operation. + +#### Example + +```typescript +// Assuming 'manager' is an instance of LoginEmailVerification +const userInputCode = "123456"; +try { + await manager.continueWithCode({ code: userInputCode }); + // If successful, page redirects. No further client-side action needed here. +} catch (error) { + // This catch is for unexpected errors, not for Auth0 validation errors. + console.error("Failed to submit the verification code:", error); +} +// After the await, always check manager.transaction.errors for server-side validation issues. +if (manager.transaction.errors && manager.transaction.errors.length > 0) { + manager.transaction.errors.forEach(err => { + if (err.code === 'invalid-code') { + // Display "The code you entered is invalid" to the user. + } + }); +} +``` + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/login-email-verification.ts:133](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L133) + +Requests a new verification code to be sent to the user's email address. +This action is typically invoked when the user clicks a "Resend Code" button, perhaps because +they didn't receive the first email, the code expired, or they suspect an issue. +The SDK will POST to the Auth0 `/u/login-email-verification` endpoint with an action indicating +a resend request. + +Upon successful submission of this request, Auth0 attempts to send a new email. +The page may re-render. If there are issues (e.g., too many resend attempts for the same email, +identified by error code `too-many-emails`), `transaction.errors` will be updated. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload">ResendCodeOptionsPayload</a></span>}> +[`ResendCodeOptionsPayload`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload) + +Optional. An object for `CustomOptions` if any + additional parameters need to be sent with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the resend request is initiated. + Like `continueWithCode`, this usually results in a page re-render or state update + rather than direct data in the promise resolution. + +#### Throws + +Throws if the `FormHandler` encounters an unrecoverable issue (e.g., network error). + Server-side errors (like rate limits) are reflected in `this.transaction.errors`. + +#### Example + +```typescript +// Assuming 'manager' is an instance of LoginEmailVerification +try { + await manager.resendCode(); + // Optionally, update UI to inform the user a new code has been sent. + alert("A new verification code has been dispatched to your email."); +} catch (error) { + console.error("Failed to request a new code:", error); +} +// After the await, check manager.transaction.errors for server-side issues. +if (manager.transaction.errors && manager.transaction.errors.length > 0) { + manager.transaction.errors.forEach(err => { + if (err.code === 'too-many-emails') { + // Display "You have requested too many emails. Please wait a few minutes." + } + }); +} +``` + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [interfaces/screens/login-email-verification.ts:139](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L139) + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions.mdx new file mode 100644 index 000000000..260ae6a0b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "LoginEnrollOptions" +--- + +Defined in: [interfaces/screens/mfa-login-options.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L19) + +Options for continuing with a selected MFA factor + + +<RequestExample> +```ts +export interface LoginEnrollOptions { + /** The action indicating which factor to use for login */ + action: MfaLoginFactorType; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='action' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaLoginFactorType">MfaLoginFactorType</a></span>}> +{/*> **action**: [`MfaLoginFactorType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaLoginFactorType)*/} + +Defined in: [interfaces/screens/mfa-login-options.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L21) + +The action indicating which factor to use for login +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.mdx new file mode 100644 index 000000000..ec4f6dbfd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.mdx @@ -0,0 +1,204 @@ +--- +title: "LoginIdMembers" +--- + +Defined in: [interfaces/screens/login-id.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L57) + + +<RequestExample> +```ts +export interface LoginIdMembers extends BaseMembers { + screen: ScreenMembersOnLoginId; + transaction: TransactionMembersOnLoginId; + login(payload: LoginOptions): Promise<void>; + federatedLogin(payload: FederatedLoginOptions): Promise<void>; + passkeyLogin(payload?: CustomOptions): Promise<void>; + pickCountryCode(payload?: CustomOptions): Promise<void>; + getLoginIdentifiers(): IdentifierType[] | null; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId">ScreenMembersOnLoginId</a></span>}> +{/*> **screen**: [`ScreenMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId)*/} + +Defined in: [interfaces/screens/login-id.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L58) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId">TransactionMembersOnLoginId</a></span>}> +{/*> **transaction**: [`TransactionMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId)*/} + +Defined in: [interfaces/screens/login-id.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L59) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='federatedLogin' type='Promise<void>'> +{/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/login-id.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L61) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions">FederatedLoginOptions</a></span>}> +[`FederatedLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='getLoginIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> +{/*> **getLoginIdentifiers**(): [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} + +Defined in: [interfaces/screens/login-id.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L64) + +#### Returns + +[`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null` + +</ParamField> + +<ParamField body='login' type='Promise<void>'> +{/*> **login**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/login-id.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L60) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions">LoginOptions</a></span>}> +[`LoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='passkeyLogin' type='Promise<void>'> +{/*> **passkeyLogin**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/login-id.ts:62](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L62) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pickCountryCode' type='Promise<void>'> +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/login-id.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L63) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.mdx new file mode 100644 index 000000000..1442e1fe2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.mdx @@ -0,0 +1,223 @@ +--- +title: "LoginMembers" +--- + +Defined in: [interfaces/screens/login.ts:80](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L80) + +Login screen members interface extending base members + + +<RequestExample> +```ts +export interface LoginMembers extends BaseMembers { + screen: ScreenMembersOnLogin; + transaction: TransactionMembersOnLogin; + /** + * Performs login with username/password + * @param payload The login options + */ + login(payload: LoginOptions): Promise<void>; + /** + * Performs login with social provider + * @param payload The social login options + */ + federatedLogin(payload: FederatedLoginOptions): Promise<void>; + /** + * Picks country code for phone number input + * @param payload Optional custom options + */ + pickCountryCode(payload?: CustomOptions): Promise<void>; + /** + * Gets the active identifier types for the login screen + * @returns An array of active identifier types or null if none are active + * @utilityFeature + */ + getLoginIdentifiers(): IdentifierType[] | null; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin">ScreenMembersOnLogin</a></span>}> +{/*> **screen**: [`ScreenMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin)*/} + +Defined in: [interfaces/screens/login.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L81) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin">TransactionMembersOnLogin</a></span>}> +{/*> **transaction**: [`TransactionMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin)*/} + +Defined in: [interfaces/screens/login.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L82) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='federatedLogin' type='Promise<void>'> +{/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/login.ts:92](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L92) + +Performs login with social provider + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions">FederatedLoginPayloadOptions</a></span>}> +[`FederatedLoginPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions) + +The social login options +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='getLoginIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> +{/*> **getLoginIdentifiers**(): [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} + +Defined in: [interfaces/screens/login.ts:103](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L103) + +**`Utility Feature`** + +Gets the active identifier types for the login screen + +#### Returns + +[`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null` + +An array of active identifier types or null if none are active + +</ParamField> + +<ParamField body='login' type='Promise<void>'> +{/*> **login**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/login.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L87) + +Performs login with username/password + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions">LoginPayloadOptions</a></span>}> +[`LoginPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions) + +The login options +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pickCountryCode' type='Promise<void>'> +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/login.ts:97](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L97) + +Picks country code for phone number input + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions.mdx new file mode 100644 index 000000000..b4ca922da --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "LoginOptions" +--- + +Defined in: [interfaces/screens/login-id.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L46) + + +<RequestExample> +```ts +export interface LoginOptions { + username: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='captcha?' type='string'> +{/*> `optional` **captcha**: `string`*/} + +Defined in: [interfaces/screens/login-id.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L48) + +</ParamField> + +<ParamField body='username' type='string'> +{/*> **username**: `string`*/} + +Defined in: [interfaces/screens/login-id.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L47) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.mdx new file mode 100644 index 000000000..8bd2debd9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.mdx @@ -0,0 +1,156 @@ +--- +title: "LoginPasswordMembers" +--- + +Defined in: [interfaces/screens/login-password.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L53) + + +<RequestExample> +```ts +export interface LoginPasswordMembers extends BaseMembers { + screen: ScreenMembersOnLoginPassword; + transaction: TransactionMembersOnLoginPassword; + login(payload: LoginPasswordOptions): Promise<void>; + federatedLogin(payload: FederatedLoginOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword">ScreenMembersOnLoginPassword</a></span>}> +{/*> **screen**: [`ScreenMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword)*/} + +Defined in: [interfaces/screens/login-password.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L54) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword">TransactionMembersOnLoginPassword</a></span>}> +{/*> **transaction**: [`TransactionMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword)*/} + +Defined in: [interfaces/screens/login-password.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L55) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='federatedLogin' type='Promise<void>'> +{/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/login-password.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L57) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions">FederatedLoginPasswordOptions</a></span>}> +[`FederatedLoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='login' type='Promise<void>'> +{/*> **login**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/login-password.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L56) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions">LoginPasswordOptions</a></span>}> +[`LoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions.mdx new file mode 100644 index 000000000..4f3b325d4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions.mdx @@ -0,0 +1,43 @@ +--- +title: "LoginPasswordOptions" +--- + +Defined in: [interfaces/screens/login-password.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L41) + + +<RequestExample> +```ts +export interface LoginPasswordOptions { + username: string; + password: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='captcha?' type='string'> +{/*> `optional` **captcha**: `string`*/} + +Defined in: [interfaces/screens/login-password.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L44) + +</ParamField> + +<ParamField body='password' type='string'> +{/*> **password**: `string`*/} + +Defined in: [interfaces/screens/login-password.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L43) + +</ParamField> + +<ParamField body='username' type='string'> +{/*> **username**: `string`*/} + +Defined in: [interfaces/screens/login-password.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L42) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.mdx new file mode 100644 index 000000000..9db562f2c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.mdx @@ -0,0 +1,174 @@ +--- +title: "LoginPasswordlessEmailCodeMembers" +--- + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L27) + + +<RequestExample> +```ts +export interface LoginPasswordlessEmailCodeMembers extends BaseMembers { + screen: ScreenMembersOnLoginPasswordlessEmailCode; + transaction: TransactionMembersOnLoginPasswordlessEmailCode; + submitCode(payload: SubmitCodeOptions): Promise<void>; + resendCode(payload?: CustomOptions): Promise<void>; + resendManager(options?: StartResendOptions): ResendControl; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode">ScreenMembersOnLoginPasswordlessEmailCode</a></span>}> +{/*> **screen**: [`ScreenMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode)*/} + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L28) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode">TransactionMembersOnLoginPasswordlessEmailCode</a></span>}> +{/*> **transaction**: [`TransactionMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode)*/} + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L29) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L31) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L32) + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +</ParamField> + +<ParamField body='submitCode' type='Promise<void>'> +{/*> **submitCode**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L30) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions">SubmitCodeOptions</a></span>}> +[`SubmitCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.mdx new file mode 100644 index 000000000..4d195e7a6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.mdx @@ -0,0 +1,182 @@ +--- +title: "LoginPasswordlessSmsOtpMembers" +--- + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L35) + + +<RequestExample> +```ts +export interface LoginPasswordlessSmsOtpMembers extends BaseMembers { + screen: ScreenMembersOnLoginPasswordlessSmsOtp; + transaction: TransactionMembersOnLoginPasswordlessSmsOtp; + submitOTP(payload: SubmitOTPOptions): Promise<void>; + resendOTP(payload?: CustomOptions): Promise<void>; + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp">ScreenMembersOnLoginPasswordlessSmsOtp</a></span>}> +{/*> **screen**: [`ScreenMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp)*/} + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L36) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp">TransactionMembersOnLoginPasswordlessSmsOtp</a></span>}> +{/*> **transaction**: [`TransactionMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp)*/} + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L37) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L44) + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +</ParamField> + +<ParamField body='resendOTP' type='Promise<void>'> +{/*> **resendOTP**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L39) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='submitOTP' type='Promise<void>'> +{/*> **submitOTP**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L38) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions">SubmitOTPOptions</a></span>}> +[`SubmitOTPOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions.mdx new file mode 100644 index 000000000..90d32ffb3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions.mdx @@ -0,0 +1,57 @@ +--- +title: "LoginPayloadOptions" +--- + +Defined in: [interfaces/screens/login.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L56) + +Options for performing login operations + + +<RequestExample> +```ts +export interface LoginOptions { + /** The username/email to login with */ + username: string; + /** The password for authentication */ + password: string; + /** Optional captcha value if required */ + captcha?: string; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='captcha?' type='string'> +{/*> `optional` **captcha**: `string`*/} + +Defined in: [interfaces/screens/login.ts:62](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L62) + +Optional captcha value if required + +</ParamField> + +<ParamField body='password' type='string'> +{/*> **password**: `string`*/} + +Defined in: [interfaces/screens/login.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L60) + +The password for authentication + +</ParamField> + +<ParamField body='username' type='string'> +{/*> **username**: `string`*/} + +Defined in: [interfaces/screens/login.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L58) + +The username/email to login with +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.mdx new file mode 100644 index 000000000..e28b9981c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.mdx @@ -0,0 +1,118 @@ +--- +title: "LogoutAbortedMembers" +--- + +Defined in: [interfaces/screens/logout-aborted.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/logout-aborted.ts#L6) + +Interface defining the available methods and properties for the logout-aborted screen + + +<RequestExample> +```ts +export interface LogoutAbortedMembers extends BaseMembers {} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.mdx new file mode 100644 index 000000000..3007fdfdd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.mdx @@ -0,0 +1,118 @@ +--- +title: "LogoutCompleteMembers" +--- + +Defined in: [interfaces/screens/logout-complete.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/logout-complete.ts#L6) + +Interface defining the available methods and properties for the logout-complete screen + + +<RequestExample> +```ts +export interface LogoutCompleteMembers extends BaseMembers {} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.mdx new file mode 100644 index 000000000..4ba4a082f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.mdx @@ -0,0 +1,146 @@ +--- +title: "LogoutMembers" +--- + +Defined in: [interfaces/screens/logout.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/logout.ts#L15) + +Interface defining the available methods and properties for the logout screen + + +<RequestExample> +```ts +export interface LogoutMembers extends BaseMembers { + /** + * Confirms the logout action (accept or deny) + * @param payload The options containing the action to perform + */ + confirmLogout(payload: ConfirmLogoutOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='confirmLogout' type='Promise<void>'> +{/*> **confirmLogout**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/logout.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/logout.ts#L20) + +Confirms the logout action (accept or deny) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions">ConfirmLogoutOptions</a></span>}> +[`ConfirmLogoutOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions) + +The options containing the action to perform +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.mdx new file mode 100644 index 000000000..7b8c7c169 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.mdx @@ -0,0 +1,146 @@ +--- +title: "MfaBeginEnrollOptionsMembers" +--- + +Defined in: [interfaces/screens/mfa-begin-enroll-options.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts#L17) + +MFA Begin Enroll Options screen members interface + + +<RequestExample> +```ts +export interface MfaBeginEnrollOptionsMembers extends BaseMembers { + /** + * Continues the enrollment process with the selected factor + * @param payload The enrollment options including the selected factor + */ + enroll(payload: MfaEnrollOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='enroll' type='Promise<void>'> +{/*> **enroll**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-begin-enroll-options.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts#L22) + +Continues the enrollment process with the selected factor + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions">MfaEnrollOptions</a></span>}> +[`MfaEnrollOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions) + +The enrollment options including the selected factor +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.mdx new file mode 100644 index 000000000..8b996bc5e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.mdx @@ -0,0 +1,173 @@ +--- +title: "MfaCountryCodesMembers" +--- + +Defined in: [interfaces/screens/mfa-country-codes.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L30) + +Interface defining the available methods and properties for the mfa-country-codes screen + + +<RequestExample> +```ts +export interface MfaCountryCodesMembers extends BaseMembers { + screen: ScreenMembersOnMfaCountryCodes; + /** + * Selects a country code from the available options + * @param payload The options containing the country code selection action + */ + selectCountryCode(payload: SelectCountryCodeOptions): Promise<void>; + /** + * Navigates back to the previous screen + * @param payload Optional custom options to include with the request + */ + goBack(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes">ScreenMembersOnMfaCountryCodes</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaCountryCodes`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes)*/} + +Defined in: [interfaces/screens/mfa-country-codes.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L31) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='goBack' type='Promise<void>'> +{/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-country-codes.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L41) + +Navigates back to the previous screen + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='selectCountryCode' type='Promise<void>'> +{/*> **selectCountryCode**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-country-codes.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L36) + +Selects a country code from the available options + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions">SelectCountryCodeOptions</a></span>}> +[`SelectCountryCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions) + +The options containing the country code selection action +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx new file mode 100644 index 000000000..28a72f491 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx @@ -0,0 +1,158 @@ +--- +title: "MfaDetectBrowserCapabilitiesMembers" +--- + +Defined in: [interfaces/screens/mfa-detect-browser-capabilities.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-detect-browser-capabilities.ts#L7) + +Interface defining the available methods and properties for the mfa-detect-browser-capabilities screen + + +<RequestExample> +```ts +export interface MfaDetectBrowserCapabilitiesMembers extends BaseMembers { + /** + * Picks an authenticator based on browser capabilities + * @param payload The options containing browser capability flags + * @example + * ```typescript + * const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); + * await mfaDetectBrowserCapabilities.detectCapabilities(); + * ``` + */ + detectCapabilities(payload: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='detectCapabilities' type='Promise<void>'> +{/*> **detectCapabilities**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-detect-browser-capabilities.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-detect-browser-capabilities.ts#L17) + +Picks an authenticator based on browser capabilities + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +The options containing browser capability flags +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); +await mfaDetectBrowserCapabilities.detectCapabilities(); +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.mdx new file mode 100644 index 000000000..372c15aca --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.mdx @@ -0,0 +1,257 @@ +--- +title: "MfaEmailChallengeMembers" +--- + +Defined in: [interfaces/screens/mfa-email-challenge.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L57) + +Interface defining the available methods and properties for the mfa-email-challenge screen + + +<RequestExample> +```ts +export interface MfaEmailChallengeMembers extends BaseMembers { + screen: ScreenMembersOnMfaEmailChallenge; + untrustedData: UntrustedDataMembersOnMfaEmailChallenge; + + /** + * Continues with the email challenge using the provided code + * @param payload The options containing the code and rememberDevice flag + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Resends the email code + * @param payload Optional custom options to include with the request + */ + resendCode(payload?: ResendCodeOptions): Promise<void>; + + /** + * Allows the user to try another MFA method + * @param payload Optional custom options to include with the request + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; + + /** + * Submits the action to pick a different Email configuration, if available + * @param payload Optional custom options to include with the request + */ + pickEmail(payload?: CustomOptions): Promise<void>; + + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge">ScreenMembersOnMfaEmailChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge)*/} + +Defined in: [interfaces/screens/mfa-email-challenge.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L58) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge">UntrustedDataMembersOnMfaEmailChallenge</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge)*/} + +Defined in: [interfaces/screens/mfa-email-challenge.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L59) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-email-challenge.ts:65](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L65) + +Continues with the email challenge using the provided code + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions">ContinuePayloadOptions</a></span>}> +[`ContinuePayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions) + +The options containing the code and rememberDevice flag +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pickEmail' type='Promise<void>'> +{/*> **pickEmail**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-email-challenge.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L83) + +Submits the action to pick a different Email configuration, if available + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-email-challenge.ts:71](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L71) + +Resends the email code + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions">ResendCodePayloadOptions</a></span>}> +[`ResendCodePayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [interfaces/screens/mfa-email-challenge.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L89) + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-email-challenge.ts:77](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L77) + +Allows the user to try another MFA method + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions">TryAnotherMethodPayloadOptions</a></span>}> +[`TryAnotherMethodPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.mdx new file mode 100644 index 000000000..cba2f4110 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.mdx @@ -0,0 +1,173 @@ +--- +title: "MfaEmailListMembers" +--- + +Defined in: [interfaces/screens/mfa-email-list.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L31) + +Interface defining the available methods and properties for the mfa-email-list screen + + +<RequestExample> +```ts +export interface MfaEmailListMembers extends BaseMembers { + screen: ScreenMembersOnMfaEmailList; + /** + * Selects an enrolled email address from the list + * @param payload The options containing the selection action + */ + selectMfaEmail(payload: SelectMfaEmailOptions): Promise<void>; + /** + * Navigates back to the previous screen + * @param payload Optional custom options to include with the request + */ + goBack(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList">ScreenMembersOnMfaEmailList</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaEmailList`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList)*/} + +Defined in: [interfaces/screens/mfa-email-list.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L32) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='goBack' type='Promise<void>'> +{/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-email-list.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L42) + +Navigates back to the previous screen + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='selectMfaEmail' type='Promise<void>'> +{/*> **selectMfaEmail**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-email-list.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L37) + +Selects an enrolled email address from the list + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions">SelectMfaEmailOptions</a></span>}> +[`SelectMfaEmailOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions) + +The options containing the selection action +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions.mdx new file mode 100644 index 000000000..0e40d0fd3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "MfaEnrollOptions" +--- + +Defined in: [interfaces/screens/mfa-begin-enroll-options.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts#L7) + +Options for continuing with factor enrollment + + +<RequestExample> +```ts +export interface MfaEnrollOptions { + /** The action indicating which factor to enroll */ + action: MfaEnrollFactorType; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='action' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaEnrollFactorType">MfaEnrollFactorType</a></span>}> +{/*> **action**: [`MfaEnrollFactorType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaEnrollFactorType)*/} + +Defined in: [interfaces/screens/mfa-begin-enroll-options.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts#L9) + +The action indicating which factor to enroll +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.mdx new file mode 100644 index 000000000..676696598 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.mdx @@ -0,0 +1,131 @@ +--- +title: "MfaEnrollResultMembers" +--- + +Defined in: [interfaces/screens/mfa-enroll-result.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts#L45) + +MfaEnrollResultMembers + + +<RequestExample> +```ts +export interface MfaEnrollResultMembers extends BaseMembers { + /** + * Provides access to the specific properties and data of the MFA Enroll Result screen, + * including the enrollment `status` (via `screen.data.status`). + * @type {ScreenMembersOnMfaEnrollResult} + */ + screen: ScreenMembersOnMfaEnrollResult; + + // No specific operations (methods) are typically defined for this screen as it's informational. + // The user might be automatically redirected or provided a button to continue, + // which would usually be a simple navigation handled by the page template or a default action. +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult">ScreenMembersOnMfaEnrollResult</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaEnrollResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult)*/} + +Defined in: [interfaces/screens/mfa-enroll-result.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts#L51) + +Screen-specific data, including enrollment status. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.mdx new file mode 100644 index 000000000..45a908453 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.mdx @@ -0,0 +1,201 @@ +--- +title: "MfaLoginOptionsMembers" +--- + +Defined in: [interfaces/screens/mfa-login-options.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L29) + +Interface defining the available methods and properties for the mfa-login-options screen + + +<RequestExample> +```ts +export interface MfaLoginOptionsMembers extends BaseMembers { + screen: ScreenMembersOnMfaLoginOptions; + /** + * Continues the login process with the selected MFA factor + * @param payload The options containing the selected factor + * @example + * ```typescript + * const mfaLoginOptions = new MfaLoginOptions(); + * await mfaLoginOptions.enroll({ + * action: 'push-notification' + * }); + * ``` + */ + enroll(payload: LoginEnrollOptions): Promise<void>; + /** + * Returns to the previous screen in the authentication flow + * @param payload Optional custom options + * @example + * ```typescript + * const mfaLoginOptions = new MfaLoginOptions(); + * await mfaLoginOptions.returnToPrevious(); + * ``` + */ + returnToPrevious(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions">ScreenMembersOnMfaLoginOptions</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions)*/} + +Defined in: [interfaces/screens/mfa-login-options.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L30) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='enroll' type='Promise<void>'> +{/*> **enroll**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-login-options.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L42) + +Continues the login process with the selected MFA factor + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions">LoginEnrollOptions</a></span>}> +[`LoginEnrollOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions) + +The options containing the selected factor +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +const mfaLoginOptions = new MfaLoginOptions(); +await mfaLoginOptions.enroll({ + action: 'push-notification' +}); +``` + +</ParamField> + +<ParamField body='returnToPrevious' type='Promise<void>'> +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-login-options.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L52) + +Returns to the previous screen in the authentication flow + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +const mfaLoginOptions = new MfaLoginOptions(); +await mfaLoginOptions.returnToPrevious(); +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.mdx new file mode 100644 index 000000000..0ae236bd9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.mdx @@ -0,0 +1,176 @@ +--- +title: "MfaOtpChallengeMembers" +--- + +Defined in: [interfaces/screens/mfa-otp-challenge.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L46) + +Interface defining the available methods and properties for the mfa-otp-challenge screen + + +<RequestExample> +```ts +export interface MfaOtpChallengeMembers extends BaseMembers { + screen: ScreenMembersOnMfaOtpChallenge; + untrustedData: UntrustedDataMembersOnMfaOtpChallenge; + + /** + * Continues with the OTP challenge using the provided code + * @param payload The options containing the code and rememberDevice flag + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Allows the user to try another MFA method + * @param payload Optional custom options to include with the request + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge">ScreenMembersOnMfaOtpChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge)*/} + +Defined in: [interfaces/screens/mfa-otp-challenge.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L47) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge">UntrustedDataMembersOnMfaOtpChallenge</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge)*/} + +Defined in: [interfaces/screens/mfa-otp-challenge.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L48) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-otp-challenge.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L54) + +Continues with the OTP challenge using the provided code + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions">ContinueOTPOptions</a></span>}> +[`ContinueOTPOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions) + +The options containing the code and rememberDevice flag +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-otp-challenge.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L60) + +Allows the user to try another MFA method + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions">TryAnotherMethodMfaOtpChallengeOptions</a></span>}> +[`TryAnotherMethodMfaOtpChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions.mdx new file mode 100644 index 000000000..33582f3c1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions.mdx @@ -0,0 +1,40 @@ +--- +title: "MfaOtpContinueOptions" +--- + +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L7) + +Options for continuing with the MFA OTP enrollment code. + + +<RequestExample> +```ts +export interface ContinueOptions { + /** + * The OTP code entered by the user. + */ + code: string; + + /** + * Any additional custom options. + */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options. + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L11) + +The OTP code entered by the user. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.mdx new file mode 100644 index 000000000..a81398f28 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.mdx @@ -0,0 +1,180 @@ +--- +title: "MfaOtpEnrollmentCodeMembers" +--- + +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L44) + +Interface defining the available methods and properties for the mfa-otp-enrollment-code screen. + + +<RequestExample> +```ts +export interface MfaOtpEnrollmentCodeMembers extends BaseMembers { + /** + * The screen properties for the mfa-otp-enrollment-code screen. + */ + screen: ScreenMembersOnMfaOtpEnrollmentCode; + + /** + * Continues the MFA OTP enrollment process by submitting the OTP code. + * @param payload The options containing the OTP code. + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Allows the user to try another MFA method. + * @param payload Optional custom options to include with the request. + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode">ScreenMembersOnMfaOtpEnrollmentCode</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaOtpEnrollmentCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode)*/} + +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L48) + +The screen properties for the mfa-otp-enrollment-code screen. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L54) + +Continues the MFA OTP enrollment process by submitting the OTP code. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions">MfaOtpContinueOptions</a></span>}> +[`MfaOtpContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions) + +The options containing the OTP code. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L60) + +Allows the user to try another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions">MfaOtpTryAnotherMethodOptions</a></span>}> +[`MfaOtpTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx new file mode 100644 index 000000000..f9585f784 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx @@ -0,0 +1,32 @@ +--- +title: "MfaOtpEnrollmentQrContinueOptions" +--- + +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L18) + +Interface for the payload of the continue method + + +<RequestExample> +```ts +export interface ContinueOptions extends CustomOptions { + code: string; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L19) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.mdx new file mode 100644 index 000000000..33c8adc10 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.mdx @@ -0,0 +1,202 @@ +--- +title: "MfaOtpEnrollmentQrMembers" +--- + +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L25) + +Interface defining the available methods and properties for the mfa-otp-enrollment-qr screen + + +<RequestExample> +```ts +export interface MfaOtpEnrollmentQrMembers extends BaseMembers { + screen: ScreenMembersOnMfaOtpEnrollmentQr; + + /** + * Toggles the view. + * @param payload Optional custom options to include with the request + */ + toggleView(payload?: CustomOptions): Promise<void>; + + /** + * Continues with the default action. + * @param payload Payload containing code and optional custom options + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Allows trying another authentication method + * @param payload Optional custom options to include with the request + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr">ScreenMembersOnMfaOtpEnrollmentQr</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaOtpEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr)*/} + +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L26) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L38) + +Continues with the default action. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions">MfaOtpEnrollmentQrContinueOptions</a></span>}> +[`MfaOtpEnrollmentQrContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions) + +Payload containing code and optional custom options +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='toggleView' type='Promise<void>'> +{/*> **toggleView**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L32) + +Toggles the view. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L44) + +Allows trying another authentication method + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..3efc48aae --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions.mdx @@ -0,0 +1,25 @@ +--- +title: "MfaOtpTryAnotherMethodOptions" +--- + +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L22) + +Options for trying another MFA method. + + +<RequestExample> +```ts +export interface TryAnotherMethodOptions { + /** + * Any additional custom options. + */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options. \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions.mdx new file mode 100644 index 000000000..7352f8e2b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions.mdx @@ -0,0 +1,50 @@ +--- +title: "MfaPhoneChallengeContinueOptions" +--- + +Defined in: [interfaces/screens/mfa-phone-challenge.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L32) + +ContinueOptions +Defines the options required to continue the MFA phone challenge process. +This typically involves selecting the method (SMS or Voice) to receive the verification code. + + +<RequestExample> +```ts +export interface ContinueOptions extends CustomOptions { + /** + * The type of challenge to perform. + * 'sms': Send the code via text message. + * 'voice': Send the code via a voice call. + * @default 'sms' + */ + type: 'sms' | 'voice'; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='type' type='"sms"'> +{/*> **type**: `"sms"` \| `"voice"`*/} + +Defined in: [interfaces/screens/mfa-phone-challenge.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L39) + +The type of challenge to perform. +'sms': Send the code via text message. +'voice': Send the code via a voice call. + +#### Default + +```ts +'sms' +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.mdx new file mode 100644 index 000000000..65849b37c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.mdx @@ -0,0 +1,302 @@ +--- +title: "MfaPhoneChallengeMembers" +--- + +Defined in: [interfaces/screens/mfa-phone-challenge.ts:62](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L62) + +MfaPhoneChallengeMembers + + +<RequestExample> +```ts +export interface MfaPhoneChallengeMembers extends BaseMembers { + /** + * @property {ScreenMembersOnMfaPhoneChallenge} screen - Specific screen information for the MFA Phone Challenge. + */ + screen: ScreenMembersOnMfaPhoneChallenge; + + /** + * continue + * Submits the choice of MFA delivery method (SMS or Voice) to proceed with the challenge. + * This will trigger sending the verification code to the user's phone. + * + * @param {ContinueOptions} payload - The options specifying the delivery type ('sms' or 'voice'). + * @returns {Promise<void>} A promise that resolves when the action is submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + * + * const mfaPhoneChallenge = new MfaPhoneChallenge(); + * + * // To send the code via SMS + * await mfaPhoneChallenge.continue({ type: 'sms' }); + * + * // To send the code via Voice Call + * await mfaPhoneChallenge.continue({ type: 'voice' }); + * ``` + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * pickPhone + * Initiates the action to pick a different phone number. + * This typically redirects the user to a screen where they can select from multiple enrolled phone numbers, if applicable. + * + * @param {PickPhoneOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the action is submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + * + * const mfaPhoneChallenge = new MfaPhoneChallenge(); + * await mfaPhoneChallenge.pickPhone(); + * ``` + */ + pickPhone(payload?: PickPhoneOptions): Promise<void>; + + /** + * tryAnotherMethod + * Initiates the action to select a different MFA factor/authenticator. + * This redirects the user to a screen where they can choose an alternative MFA method (e.g., OTP app, recovery code). + * + * @param {PickAuthenticatorOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the action is submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + * + * const mfaPhoneChallenge = new MfaPhoneChallenge(); + * await mfaPhoneChallenge.tryAnotherMethod(); + * ``` + */ + tryAnotherMethod(payload?: PickAuthenticatorOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge">ScreenMembersOnMfaPhoneChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge)*/} + +Defined in: [interfaces/screens/mfa-phone-challenge.ts:66](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L66) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-phone-challenge.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L89) + +continue +Submits the choice of MFA delivery method (SMS or Voice) to proceed with the challenge. +This will trigger sending the verification code to the user's phone. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions">MfaPhoneChallengeContinueOptions</a></span>}> +[`MfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions) + +The options specifying the delivery type ('sms' or 'voice'). +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is submitted. + +#### Throws + +Throws an error if the submission fails. + +#### Example + +```typescript +import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + +const mfaPhoneChallenge = new MfaPhoneChallenge(); + +// To send the code via SMS +await mfaPhoneChallenge.continue({ type: 'sms' }); + +// To send the code via Voice Call +await mfaPhoneChallenge.continue({ type: 'voice' }); +``` + +</ParamField> + +<ParamField body='pickPhone' type='Promise<void>'> +{/*> **pickPhone**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-phone-challenge.ts:107](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L107) + +pickPhone +Initiates the action to pick a different phone number. +This typically redirects the user to a screen where they can select from multiple enrolled phone numbers, if applicable. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions">MfaPhoneChallengePickPhoneOptions</a></span>}> +[`MfaPhoneChallengePickPhoneOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is submitted. + +#### Throws + +Throws an error if the submission fails. + +#### Example + +```typescript +import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + +const mfaPhoneChallenge = new MfaPhoneChallenge(); +await mfaPhoneChallenge.pickPhone(); +``` + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-phone-challenge.ts:125](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L125) + +tryAnotherMethod +Initiates the action to select a different MFA factor/authenticator. +This redirects the user to a screen where they can choose an alternative MFA method (e.g., OTP app, recovery code). + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions">MfaPhoneChallengePickAuthenticatorOptions</a></span>}> +[`MfaPhoneChallengePickAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is submitted. + +#### Throws + +Throws an error if the submission fails. + +#### Example + +```typescript +import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + +const mfaPhoneChallenge = new MfaPhoneChallenge(); +await mfaPhoneChallenge.tryAnotherMethod(); +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx new file mode 100644 index 000000000..80e4ef03b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx @@ -0,0 +1,24 @@ +--- +title: "MfaPhoneChallengePickAuthenticatorOptions" +--- + +Defined in: [interfaces/screens/mfa-phone-challenge.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L55) + +PickAuthenticatorOptions +Defines the options for the 'pick-authenticator' action. +This allows the user to choose a different MFA method if available. + + +<RequestExample> +```ts +export interface PickAuthenticatorOptions extends CustomOptions {} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions.mdx new file mode 100644 index 000000000..7416374f5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions.mdx @@ -0,0 +1,25 @@ +--- +title: "MfaPhoneChallengePickPhoneOptions" +--- + +Defined in: [interfaces/screens/mfa-phone-challenge.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L48) + +PickPhoneOptions +Defines the options for the 'pick-phone' action. +Although the interface only shows one phone number, this action might be used +in scenarios where the server needs to redirect to a phone selection screen. + + +<RequestExample> +```ts +export interface PickPhoneOptions extends CustomOptions {} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions.mdx new file mode 100644 index 000000000..4311d89c8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions.mdx @@ -0,0 +1,42 @@ +--- +title: "MfaPhoneEnrollmentContinueOptions" +--- + +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L14) + +Options for continuing with the MFA phone enrollment. + +Extends `CustomOptions` to allow passing custom options alongside phone and type. + + +<RequestExample> +```ts +export interface ContinueOptions extends CustomOptions { + phone: string; + type: 'sms' | 'voice'; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='phone' type='string'> +{/*> **phone**: `string`*/} + +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L15) + +</ParamField> + +<ParamField body='type' type='"sms"'> +{/*> **type**: `"sms"` \| `"voice"`*/} + +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L16) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.mdx new file mode 100644 index 000000000..f4f8a12e6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.mdx @@ -0,0 +1,204 @@ +--- +title: "MfaPhoneEnrollmentMembers" +--- + +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L19) + + +<RequestExample> +```ts +export interface MfaPhoneEnrollmentMembers extends BaseMembers { + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + transaction: TransactionMembers; + + /** + * Selects the country code for the phone number. + * @param payload Optional custom options to include with the request. + */ + pickCountryCode(payload?: CustomOptions): Promise<void>; + + /** + * Continues the enrollment process with the provided phone number and type (SMS or voice). + * @param payload The phone number, type, and optional custom options. + */ + continueEnrollment(payload: ContinueOptions): Promise<void>; + + /** + * Allows the user to try another MFA method. + * @param payload Optional custom options to include with the request. + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L20) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L21) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L22) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L23) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L24) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continueEnrollment' type='Promise<void>'> +{/*> **continueEnrollment**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L36) + +Continues the enrollment process with the provided phone number and type (SMS or voice). + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions">MfaPhoneEnrollmentContinueOptions</a></span>}> +[`MfaPhoneEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions) + +The phone number, type, and optional custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pickCountryCode' type='Promise<void>'> +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L30) + +Selects the country code for the phone number. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L42) + +Allows the user to try another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.mdx new file mode 100644 index 000000000..3f48348cb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.mdx @@ -0,0 +1,260 @@ +--- +title: "MfaPushChallengePushMembers" +--- + +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L39) + +Interface defining the available methods and properties for the mfa-push-challenge-push screen + + +<RequestExample> +```ts +export interface MfaPushChallengePushMembers extends BaseMembers { + screen: ScreenMembersOnMfaPushChallengePush; + untrustedData: UntrustedDataMembersOnMfaPushChallengePush; + + /** + * Continues with the push notification challenge + * @param payload Optional custom options to include with the request + */ + continue(payload?: WithRememberOptions): Promise<void>; + + /** + * Resends the push notification + * @param payload Optional custom options to include with the request + */ + resendPushNotification(payload?: WithRememberOptions): Promise<void>; + + /** + * Switches to entering the verification code manually + * @param payload Optional custom options to include with the request + */ + enterCodeManually(payload?: CustomOptions): Promise<void>; + + /** + * Allows trying another authentication method + * @param payload Optional custom options to include with the request + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + + /** + * Manages polling for MFA push challenge status + * @param options Configuration options for polling of type {@link MfaPollingOptions} + * @returns An object to control the polling process + */ + pollingManager(options: MfaPollingOptions): MfaPushPollingControl; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush">ScreenMembersOnMfaPushChallengePush</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush)*/} + +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L40) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush">UntrustedDataMembersOnMfaPushChallengePush</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush)*/} + +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L41) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L47) + +Continues with the push notification challenge + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions">WithRememberOptions</a></span>}> +[`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='enterCodeManually' type='Promise<void>'> +{/*> **enterCodeManually**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L59) + +Switches to entering the verification code manually + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pollingManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> +{/*> **pollingManager**(`options`): [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl)*/} + +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:72](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L72) + +Manages polling for MFA push challenge status + +<Expandable title="Parameters"> +<ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions">MfaPollingOptions</a></span>}> +[`MfaPollingOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions) + +Configuration options for polling of type [MfaPollingOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions) +</ParamField> +</Expandable> + +#### Returns + +[`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) + +An object to control the polling process + +</ParamField> + +<ParamField body='resendPushNotification' type='Promise<void>'> +{/*> **resendPushNotification**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L53) + +Resends the push notification + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions">WithRememberOptions</a></span>}> +[`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:65](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L65) + +Allows trying another authentication method + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.mdx new file mode 100644 index 000000000..7110aa79f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.mdx @@ -0,0 +1,167 @@ +--- +title: "MfaPushEnrollmentQrMembers" +--- + +Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L24) + +Interface defining the available methods and properties for the mfa-push-enrollment-qr screen + + +<RequestExample> +```ts +export interface MfaPushEnrollmentQrMembers extends BaseMembers { + screen: ScreenMembersOnMfaPushEnrollmentQr; + /** + * Navigates to the authenticator selection screen. + * @param payload Optional custom options to include with the request + */ + pickAuthenticator(payload?: CustomOptions): Promise<void>; + + pollingManager(options: MfaPollingOptions): MfaPushPollingControl; + +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr">ScreenMembersOnMfaPushEnrollmentQr</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaPushEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr)*/} + +Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L25) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='pickAuthenticator' type='Promise<void>'> +{/*> **pickAuthenticator**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L30) + +Navigates to the authenticator selection screen. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pollingManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> +{/*> **pollingManager**(`options`): [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl)*/} + +Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L32) + +<Expandable title="Parameters"> +<ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions">MfaPollingOptions</a></span>}> +[`MfaPollingOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions) +</ParamField> +</Expandable> + +#### Returns + +[`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.mdx new file mode 100644 index 000000000..d2fb5678f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.mdx @@ -0,0 +1,172 @@ +--- +title: "MfaPushListMembers" +--- + +Defined in: [interfaces/screens/mfa-push-list.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L19) + +Interface defining the available methods and properties for the mfa-push-list screen + + +<RequestExample> +```ts +export interface MfaPushListMembers extends BaseMembers { + /** + * Selects a registered device from the list to initiate MFA push. + * @param payload The options containing the device index. + */ + selectMfaPushDevice(payload: SelectMfaPushDeviceOptions): Promise<void>; + /** + * Navigates back to the previous screen. + * @param payload Optional custom options to include with the request. + */ + goBack(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='goBack' type='Promise<void>'> +{/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-push-list.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L29) + +Navigates back to the previous screen. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='selectMfaPushDevice' type='Promise<void>'> +{/*> **selectMfaPushDevice**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-push-list.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L24) + +Selects a registered device from the list to initiate MFA push. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions">SelectMfaPushDeviceOptions</a></span>}> +[`SelectMfaPushDeviceOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions) + +The options containing the device index. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl.mdx new file mode 100644 index 000000000..e55d2ba7d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl.mdx @@ -0,0 +1,139 @@ +--- +title: "MfaPushPollingControl" +--- + +Defined in: [interfaces/utils/polling-control.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L53) + +Control interface for managing an MFA push-notification polling session. + +This interface provides imperative methods to start, stop, and inspect the status of a +long-running polling loop that checks whether an MFA push challenge has been +approved. + + +<RequestExample> +```ts +export interface MfaPushPollingControl { + /** + * Stops the polling process immediately. + * + * - Cancels any scheduled timer or pending request. + * - Once stopped, `isRunning()` returns `false`. + * - Safe to call multiple times; subsequent calls have no effect. + * + * @example + * ```ts + * const control = mfaPushChallengePush.pollingManager({ intervalMs: 5000 }); + * control.startPolling(); + * + * // Later, if the user cancels: + * control.stopPolling(); + * ``` + */ + stopPolling: () => void; + + /** + * Starts or resumes the polling process. + * + * - If polling is already active, calling this again has no effect. + * - If previously stopped, calling this restarts the polling loop. + * + * @example + * ```ts + * control.startPolling(); // Begin checking the MFA push challenge + * ``` + */ + startPolling: () => void; + + /** + * Indicates whether the polling process is currently running. + * + * - Returns `true` if polling is active and not cancelled. + * - Returns `false` if polling has been stopped or has completed. + * + * @example + * ```ts + * if (control.isRunning()) { + * console.log('Polling in progress...'); + * } else { + * console.log('Polling is stopped or completed.'); + * } + * ``` + */ + isRunning: () => boolean; +} +``` +</RequestExample> + +## Properties + +<ParamField body='Returns' type='unknown'>{/*> **isRunning**: () => `boolean`*/} + +Defined in: [interfaces/utils/polling-control.ts:100](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L100) + +Indicates whether the polling process is currently running. + +- Returns `true` if polling is active and not cancelled. +- Returns `false` if polling has been stopped or has completed. + +< +`boolean` + +#### Example + +```ts +if (control.isRunning()) { + console.log('Polling in progress...'); +} else { + console.log('Polling is stopped or completed.'); +} +``` + + +</ParamField> + +<ParamField body='Returns' type='unknown'>{/*> **startPolling**: () => `void`*/} + +Defined in: [interfaces/utils/polling-control.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L83) + +Starts or resumes the polling process. + +- If polling is already active, calling this again has no effect. +- If previously stopped, calling this restarts the polling loop. + +< +`void` + +#### Example + +```ts +control.startPolling(); // Begin checking the MFA push challenge +``` + + +</ParamField> + +<ParamField body='Returns' type='unknown'>{/*> **stopPolling**: () => `void`*/} + +Defined in: [interfaces/utils/polling-control.ts:70](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L70) + +Stops the polling process immediately. + +- Cancels any scheduled timer or pending request. +- Once stopped, `isRunning()` returns `false`. +- Safe to call multiple times; subsequent calls have no effect. + +< +`void` + +#### Example + +```ts +const control = mfaPushChallengePush.pollingManager({ intervalMs: 5000 }); +control.startPolling(); + +// Later, if the user cancels: +control.stopPolling(); +``` + +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.mdx new file mode 100644 index 000000000..95699fa8b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.mdx @@ -0,0 +1,155 @@ +--- +title: "MfaPushWelcomeMembers" +--- + +Defined in: [interfaces/screens/mfa-push-welcome.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L19) + + +<RequestExample> +```ts +export interface MfaPushWelcomeMembers extends BaseMembers { + screen: ScreenMembersOnMfaPushWelcome; + enroll(payload?: CustomOptions): Promise<void>; + pickAuthenticator(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome">ScreenMembersOnMfaPushWelcome</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaPushWelcome`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome)*/} + +Defined in: [interfaces/screens/mfa-push-welcome.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L20) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='enroll' type='Promise<void>'> +{/*> **enroll**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-push-welcome.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L21) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pickAuthenticator' type='Promise<void>'> +{/*> **pickAuthenticator**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-push-welcome.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L22) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx new file mode 100644 index 000000000..19c411986 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx @@ -0,0 +1,32 @@ +--- +title: "MfaRecoveryCodeChallengeContinueOptions" +--- + +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L12) + +Options for continuing with the MFA Recovery Code Challenge. + + +<RequestExample> +```ts +export interface ContinueOptions extends CustomOptions { + code: string; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L13) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.mdx new file mode 100644 index 000000000..6488b3958 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.mdx @@ -0,0 +1,185 @@ +--- +title: "MfaRecoveryCodeChallengeMembers" +--- + +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L19) + +Interface describing the members of the Mfa Recovery Code Challenge screen. + + +<RequestExample> +```ts +export interface MfaRecoveryCodeChallengeMembers extends BaseMembers { + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + transaction: TransactionMembers; + + /** + * Continues with the provided recovery code. + * @param payload - The continue options containing the recovery code and optional custom options. + * @returns A promise that resolves when the continuation is successful. + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Navigates to the screen where the user can pick another MFA method. + * @param payload Optional payload. + * @returns A promise that resolves when the navigation is complete. + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L20) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L21) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L22) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L23) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L24) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L31) + +Continues with the provided recovery code. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions">MfaRecoveryCodeChallengeContinueOptions</a></span>}> +[`MfaRecoveryCodeChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions) + +The continue options containing the recovery code and optional custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the continuation is successful. + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L38) + +Navigates to the screen where the user can pick another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the navigation is complete. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx new file mode 100644 index 000000000..229a5b0ee --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx @@ -0,0 +1,25 @@ +--- +title: "MfaRecoveryCodeChallengeNewCodeContinueOptions" +--- + +Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L32) + +ContinueOptions + + +<RequestExample> +```ts +export interface ContinueOptions extends CustomOptions { + // No specific properties required beyond CustomOptions. + // The 'saved' parameter is handled internally by the continue method. +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx new file mode 100644 index 000000000..90dab4298 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx @@ -0,0 +1,202 @@ +--- +title: "MfaRecoveryCodeChallengeNewCodeMembers" +--- + +Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L44) + +MfaRecoveryCodeChallengeNewCodeMembers + + +<RequestExample> +```ts +export interface MfaRecoveryCodeChallengeNewCodeMembers extends BaseMembers { + /** + * Access to the specific properties and data of the 'mfa-recovery-code-challenge-new-code' screen. + * Includes the `textCode` which is the recovery code to be displayed. + * @type {ScreenMembersOnMfaRecoveryCodeChallengeNewCode} + */ + screen: ScreenMembersOnMfaRecoveryCodeChallengeNewCode; + + /** + * Confirms that the user has saved the new recovery code and continues the authentication flow. + * This method should be called after the user indicates they have securely stored the displayed recovery code. + * It sends a confirmation to the Auth0 server to proceed to the next step. + * + * @param {ContinueOptions} [payload] - Optional custom data to include with the request. + * @returns {Promise<void>} A promise that resolves when the confirmation is successfully submitted. + * @throws {Error} Throws an error if the submission fails (e.g., network issue, invalid state). + * + * @example + * ```typescript + * import MfaRecoveryCodeChallengeNewCode from '@auth0/auth0-acul-js/mfa-recovery-code-challenge-new-code'; + * + * const screenManager = new MfaRecoveryCodeChallengeNewCode(); + * + * // Assuming the user has checked a box confirming they saved the code + * try { + * await screenManager.continue(); + * // Redirects to the next screen on success + * } catch (error) { + * console.error("Failed to confirm recovery code saved:", error); + * // Handle error, e.g., display a message from screenManager.transaction.errors + * } + * ``` + */ + continue(payload?: ContinueOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode">ScreenMembersOnMfaRecoveryCodeChallengeNewCode</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode)*/} + +Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L50) + +Access to the specific properties and data of the 'mfa-recovery-code-challenge-new-code' screen. +Includes the `textCode` which is the recovery code to be displayed. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:77](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L77) + +Confirms that the user has saved the new recovery code and continues the authentication flow. +This method should be called after the user indicates they have securely stored the displayed recovery code. +It sends a confirmation to the Auth0 server to proceed to the next step. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions">MfaRecoveryCodeChallengeNewCodeContinueOptions</a></span>}> +[`MfaRecoveryCodeChallengeNewCodeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions) + +Optional custom data to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the confirmation is successfully submitted. + +#### Throws + +Throws an error if the submission fails (e.g., network issue, invalid state). + +#### Example + +```typescript +import MfaRecoveryCodeChallengeNewCode from '@auth0/auth0-acul-js/mfa-recovery-code-challenge-new-code'; + +const screenManager = new MfaRecoveryCodeChallengeNewCode(); + +// Assuming the user has checked a box confirming they saved the code +try { + await screenManager.continue(); + // Redirects to the next screen on success +} catch (error) { + console.error("Failed to confirm recovery code saved:", error); + // Handle error, e.g., display a message from screenManager.transaction.errors +} +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx new file mode 100644 index 000000000..10d14ad99 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx @@ -0,0 +1,30 @@ +--- +title: "MfaRecoveryCodeEnrollmentContinueOptions" +--- + +Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L17) + + +<RequestExample> +```ts +export interface MfaRecoveryCodeEnrollmentContinueOptions extends CustomOptions { + isCodeCopied: boolean; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='isCodeCopied' type='boolean'> +{/*> **isCodeCopied**: `boolean`*/} + +Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L18) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx new file mode 100644 index 000000000..f303fd35b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx @@ -0,0 +1,159 @@ +--- +title: "MfaRecoveryCodeEnrollmentMembers" +--- + +Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L24) + +Interface describing the members of the Mfa Recovery Code Enrollment screen. + + +<RequestExample> +```ts +export interface MfaRecoveryCodeEnrollmentMembers extends BaseMembers { + screen: ScreenMembersOnMfaRecoveryCodeEnrollment; + + /** + * Declares that the user saved the recovery code. + * This action is triggered when the user declares that they have saved the recovery code. + * It redirects to the next screen in the authentication flow. + * + * @param {object} payload - An object containing any custom options. + * + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. + * Rejects with an error if the submission fails. + */ + continue(payload: MfaRecoveryCodeEnrollmentContinueOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment">ScreenMembersOnMfaRecoveryCodeEnrollment</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaRecoveryCodeEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment)*/} + +Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L25) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L37) + +Declares that the user saved the recovery code. +This action is triggered when the user declares that they have saved the recovery code. +It redirects to the next screen in the authentication flow. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions">MfaRecoveryCodeEnrollmentContinueOptions</a></span>}> +[`MfaRecoveryCodeEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions) + +An object containing any custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted. +Rejects with an error if the submission fails. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.mdx new file mode 100644 index 000000000..d3dafa03a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.mdx @@ -0,0 +1,236 @@ +--- +title: "MfaSmsChallengeMembers" +--- + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L33) + + +<RequestExample> +```ts +export interface MfaSmsChallengeMembers extends BaseMembers { + screen: ScreenMembersOnMfaSmsChallenge; + untrustedData: UntrustedDataMembersOnMfaSmsChallenge; + continueMfaSmsChallenge(payload: MfaSmsChallengeOptions): Promise<void>; + pickSms(payload?: CustomOptions): Promise<void>; + resendCode(payload?: CustomOptions): Promise<void>; + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + getACall(payload?: CustomOptions): Promise<void>; + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge">ScreenMembersOnMfaSmsChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge)*/} + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L34) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge">UntrustedDataMembersOnMfaSmsChallenge</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge)*/} + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L35) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continueMfaSmsChallenge' type='Promise<void>'> +{/*> **continueMfaSmsChallenge**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L36) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions">MfaSmsChallengeOptions</a></span>}> +[`MfaSmsChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='getACall' type='Promise<void>'> +{/*> **getACall**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L40) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pickSms' type='Promise<void>'> +{/*> **pickSms**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L37) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L38) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L45) + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L39) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions.mdx new file mode 100644 index 000000000..00944066c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "MfaSmsChallengeOptions" +--- + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L7) + + +<RequestExample> +```ts +export interface MfaSmsChallengeOptions { + code: string; + rememberDevice?: boolean; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L8) + +</ParamField> + +<ParamField body='rememberDevice?' type='boolean'> +{/*> `optional` **rememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L9) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.mdx new file mode 100644 index 000000000..26b0be685 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.mdx @@ -0,0 +1,179 @@ +--- +title: "MfaSmsEnrollmentMembers" +--- + +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L17) + + +<RequestExample> +```ts +export interface MfaSmsEnrollmentMembers extends BaseMembers { + screen: ScreenMembersOnMfaSmsEnrollment; + pickCountryCode(payload?: CustomOptions): Promise<void>; + continueEnrollment(payload: { phone: string; captcha?: string }): Promise<void>; + tryAnotherMethod(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment">ScreenMembersOnMfaSmsEnrollment</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaSmsEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment)*/} + +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L18) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continueEnrollment' type='Promise<void>'> +{/*> **continueEnrollment**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L20) + +<Expandable title="Parameters"> +<ParamField body='payload' type='string'> +###### captcha? + +`string` + +###### phone + +`string` +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pickCountryCode' type='Promise<void>'> +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L19) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L21) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions.mdx new file mode 100644 index 000000000..369755a91 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "MfaSmsEnrollmentOptions" +--- + +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:5](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L5) + + +<RequestExample> +```ts +export interface MfaSmsEnrollmentOptions { + phone?: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='captcha?' type='string'> +{/*> `optional` **captcha**: `string`*/} + +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L7) + +</ParamField> + +<ParamField body='phone?' type='string'> +{/*> `optional` **phone**: `string`*/} + +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L6) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.mdx new file mode 100644 index 000000000..2b4d44b51 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.mdx @@ -0,0 +1,180 @@ +--- +title: "MfaSmsListMembers" +--- + +Defined in: [interfaces/screens/mfa-sms-list.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts#L22) + +MfaSmsListMembers +Interface defining the members and methods for the MfaSmsList class. + + +<RequestExample> +```ts +export interface MfaSmsListMembers extends BaseMembers { + /** + * Selects a phone number from the list of enrolled phone numbers. + * @param {MfaSmsListOptions} [payload] - Optional payload for the action. + * @returns {Promise<void>} + * @throws {Error} If the index is out of bounds. + */ + selectPhoneNumber(payload?: MfaSmsListOptions): Promise<void>; + /** + * Navigates back to the previous screen. + * @param {MfaSmsListOptions} [payload] - Optional payload for the action. + * @returns {Promise<void>} + */ + backAction(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='backAction' type='Promise<void>'> +{/*> **backAction**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-sms-list.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts#L35) + +Navigates back to the previous screen. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload for the action. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='selectPhoneNumber' type='Promise<void>'> +{/*> **selectPhoneNumber**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-sms-list.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts#L29) + +Selects a phone number from the list of enrolled phone numbers. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions">MfaSmsListOptions</a></span>}> +[`MfaSmsListOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions) + +Optional payload for the action. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +If the index is out of bounds. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions.mdx new file mode 100644 index 000000000..adcc6eea2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions.mdx @@ -0,0 +1,40 @@ +--- +title: "MfaSmsListOptions" +--- + +Defined in: [interfaces/screens/mfa-sms-list.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts#L8) + +MfaSmsListOptions +Options for performing actions on the mfa-sms-list screen. + + +<RequestExample> +```ts +export interface MfaSmsListOptions { + /** + * @param {number} index - The index of the phone number to select. + */ + index: number; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='index' type='number'> +{/*> **index**: `number`*/} + +Defined in: [interfaces/screens/mfa-sms-list.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts#L12) + +#### Param + +The index of the phone number to select. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions.mdx new file mode 100644 index 000000000..013a07a16 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions.mdx @@ -0,0 +1,54 @@ +--- +title: "MfaVoiceChallengeContinueOptions" +--- + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L10) + +Options for submitting the voice challenge code. + + +<RequestExample> +```ts +export interface MfaVoiceChallengeContinueOptions { + /** + * The verification code received via voice call. + */ + code: string; + + /** + * Optional flag to remember the device for 30 days, skipping future MFA challenges. + */ + rememberDevice?: boolean; + + /** + * Additional custom options to pass with the request. + */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Additional custom options to pass with the request. + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L14) + +The verification code received via voice call. + +</ParamField> + +<ParamField body='rememberDevice?' type='boolean'> +{/*> `optional` **rememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L19) + +Optional flag to remember the device for 30 days, skipping future MFA challenges. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.mdx new file mode 100644 index 000000000..84ff4d88f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.mdx @@ -0,0 +1,381 @@ +--- +title: "MfaVoiceChallengeMembers" +--- + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L55) + +Interface defining all members and operations available on the MFA Voice Challenge screen. + + +<RequestExample> +```ts +export interface MfaVoiceChallengeMembers extends BaseMembers { + /** + * Screen-specific properties and data. + */ + screen: ScreenMembersOnMfaVoiceChallenge; + + untrustedData: UntrustedDataMembersOnMfaVoiceChallenge; + + /** + * Submits the voice verification code to validate the MFA challenge. + * + * @param payload - Object containing the verification code and optional parameters + * @returns Promise that resolves when the code is successfully validated + * + * @example + * ```typescript + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * mfaVoiceChallenge.continue({ + * code: '123456', + * rememberDevice: true + * }); + * ``` + */ + continue(payload: MfaVoiceChallengeContinueOptions): Promise<void>; + + /** + * Navigates to the screen for selecting a different phone number. + * + * @param payload - Optional custom parameters + * @returns Promise that resolves when navigation is complete + * + * @example + * ```typescript + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * mfaVoiceChallenge.pickPhone(); + * ``` + */ + pickPhone(payload?: CustomOptions): Promise<void>; + + /** + * Switches to SMS verification method instead of voice call. + * + * @param payload - Optional custom parameters + * @returns Promise that resolves when switching is complete + * + * @example + * ```typescript + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * mfaVoiceChallenge.switchToSms(); + * ``` + */ + switchToSms(payload?: CustomOptions): Promise<void>; + + /** + * Requests a new voice call with a verification code. + * + * @param payload - Optional custom parameters + * @returns Promise that resolves when the new code is sent + * + * @example + * ```typescript + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * mfaVoiceChallenge.resendCode(); + * ``` + */ + resendCode(payload?: CustomOptions): Promise<void>; + + /** + * Navigates to the screen for selecting an alternative MFA method. + * + * @param payload - Optional custom parameters + * @returns Promise that resolves when navigation is complete + * + * @example + * ```typescript + * const mfaVoiceChallenge = new MfaVoiceChallenge(); + * mfaVoiceChallenge.tryAnotherMethod(); + * ``` + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge">ScreenMembersOnMfaVoiceChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge)*/} + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L59) + +Screen-specific properties and data. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge">UntrustedDataMembersOnMfaVoiceChallenge</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge)*/} + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L61) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:78](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L78) + +Submits the voice verification code to validate the MFA challenge. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions">MfaVoiceChallengeContinueOptions</a></span>}> +[`MfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions) + +Object containing the verification code and optional parameters +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +Promise that resolves when the code is successfully validated + +#### Example + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.continue({ + code: '123456', + rememberDevice: true +}); +``` + +</ParamField> + +<ParamField body='pickPhone' type='Promise<void>'> +{/*> **pickPhone**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:92](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L92) + +Navigates to the screen for selecting a different phone number. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +Promise that resolves when navigation is complete + +#### Example + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.pickPhone(); +``` + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:120](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L120) + +Requests a new voice call with a verification code. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +Promise that resolves when the new code is sent + +#### Example + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.resendCode(); +``` + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:140](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L140) + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +</ParamField> + +<ParamField body='switchToSms' type='Promise<void>'> +{/*> **switchToSms**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:106](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L106) + +Switches to SMS verification method instead of voice call. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +Promise that resolves when switching is complete + +#### Example + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.switchToSms(); +``` + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:134](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L134) + +Navigates to the screen for selecting an alternative MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +Promise that resolves when navigation is complete + +#### Example + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.tryAnotherMethod(); +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions.mdx new file mode 100644 index 000000000..eb238ab6e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions.mdx @@ -0,0 +1,32 @@ +--- +title: "MfaVoiceEnrollmentContinueOptions" +--- + +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L12) + +Payload for continuing the MFA Voice Enrollment flow. + + +<RequestExample> +```ts +export interface ContinueOptions extends CustomOptions { + phone: string; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='phone' type='string'> +{/*> **phone**: `string`*/} + +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L13) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.mdx new file mode 100644 index 000000000..82448f373 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.mdx @@ -0,0 +1,215 @@ +--- +title: "MfaVoiceEnrollmentMembers" +--- + +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L19) + +Interface describing the members of the Mfa Voice Enrollment screen. + + +<RequestExample> +```ts +export interface MfaVoiceEnrollmentMembers extends BaseMembers { + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + transaction: TransactionMembers; + + /** + * Continues with the voice enrollment process. + * @param payload - The phone number and optional custom options. + * @returns Promise that resolves when enrollment continues. + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Allows trying another authentication method. + * @param payload - Optional custom options. + * @returns Promise that resolves when the user switches method. + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + + /** + * Allows picking a country code for the phone number. + * @param payload - Optional custom options. + * @returns Promise that resolves when the country code is selected. + */ + selectPhoneCountryCode(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L20) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L21) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L22) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L23) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L24) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L31) + +Continues with the voice enrollment process. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions">MfaVoiceEnrollmentContinueOptions</a></span>}> +[`MfaVoiceEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions) + +The phone number and optional custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +Promise that resolves when enrollment continues. + +</ParamField> + +<ParamField body='selectPhoneCountryCode' type='Promise<void>'> +{/*> **selectPhoneCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L45) + +Allows picking a country code for the phone number. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +Promise that resolves when the country code is selected. + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L38) + +Allows trying another authentication method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +Promise that resolves when the user switches method. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx new file mode 100644 index 000000000..0f6a3d538 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx @@ -0,0 +1,44 @@ +--- +title: "MfaWebAuthnChangeKeyNicknameContinueOptions" +--- + +Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L43) + +ContinueOptions + + +<RequestExample> +```ts +export interface ContinueOptions extends CustomOptions { + /** + * The new nickname that the user wants to assign to their WebAuthn security key. + * This value will be sent to the server for an update. + * The server will validate this nickname (e.g., for length, allowed characters). + * @type {string} + * @example "Primary YubiKey" + * @example "Home Office Key" + */ + nickname: string; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='nickname' type='string'> +{/*> **nickname**: `string`*/} + +Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L52) + +The new nickname for the WebAuthn security key. + This is the value entered by the user in the input field. + It must adhere to length and character constraints defined by the server. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx new file mode 100644 index 000000000..77866f86b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx @@ -0,0 +1,235 @@ +--- +title: "MfaWebAuthnChangeKeyNicknameMembers" +--- + +Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:70](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L70) + +MfaWebAuthnChangeKeyNicknameMembers + + +<RequestExample> +```ts +export interface MfaWebAuthnChangeKeyNicknameMembers extends BaseMembers { + /** + * The screen object with MFA WebAuthn Change Key Nickname specific data structure. + */ + screen: ScreenMembersOnMfaWebAuthnChangeKeyNickname; + + /** + * Submits the new nickname for the WebAuthn security key. + * This action corresponds to the user entering a new nickname and clicking a "Save" or "Continue" button. + * The SDK will POST this new nickname to the Auth0 `/u/mfa-webauthn-change-key-nickname` endpoint. + * + * If the new nickname is valid and the update is successful, Auth0 will typically redirect the user + * to the next appropriate screen (e.g., back to MFA factor management or a success confirmation). + * If the nickname is invalid (e.g., empty, too long, too short), Auth0 will re-render the + * 'mfa-webauthn-change-key-nickname' screen, and the `transaction.errors` array in the SDK's + * context will be updated with details about the validation failure. + * + * @param {ContinueOptions} payload - An object containing the `nickname` (string) entered by the user. + * It can also include any `CustomOptions` for extensibility. + * @returns {Promise<void>} A promise that resolves when the form submission is initiated. + * It does not return data directly upon resolution, as a redirect or + * page re-render is the common outcome. + * @throws {Error} Throws an error if `payload.nickname` is not provided or is not a string, + * or if the `FormHandler` encounters an unrecoverable issue during submission (e.g., network error). + * Validation errors from Auth0 (like an invalid nickname) are not thrown as JavaScript errors + * but are reflected in `this.transaction.errors` after the operation. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnChangeKeyNickname + * const newNickname = "My Favorite YubiKey"; // Value from user input + * try { + * await sdk.continueWithNewNickname({ nickname: newNickname }); + * // If successful, page redirects. + * } catch (error) { + * // This catch is for unexpected errors during the SDK call itself. + * console.error("Failed to submit the new nickname:", error); + * } + * // After the await, always check sdk.transaction.errors for server-side validation issues. + * if (sdk.transaction.errors && sdk.transaction.errors.length > 0) { + * sdk.transaction.errors.forEach(err => { + * if (err.field === 'nickname') { + * // Display err.message related to the nickname input field. + * // e.g., "Name is too short", "Name is required" + * } + * }); + * } + * ``` + */ + continueWithNewNickname(payload: ContinueOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname">ScreenMembersOnMfaWebAuthnChangeKeyNickname</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname)*/} + +Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:74](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L74) + +The screen object with MFA WebAuthn Change Key Nickname specific data structure. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continueWithNewNickname' type='Promise<void>'> +{/*> **continueWithNewNickname**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:119](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L119) + +Submits the new nickname for the WebAuthn security key. +This action corresponds to the user entering a new nickname and clicking a "Save" or "Continue" button. +The SDK will POST this new nickname to the Auth0 `/u/mfa-webauthn-change-key-nickname` endpoint. + +If the new nickname is valid and the update is successful, Auth0 will typically redirect the user +to the next appropriate screen (e.g., back to MFA factor management or a success confirmation). +If the nickname is invalid (e.g., empty, too long, too short), Auth0 will re-render the +'mfa-webauthn-change-key-nickname' screen, and the `transaction.errors` array in the SDK's +context will be updated with details about the validation failure. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions">MfaWebAuthnChangeKeyNicknameContinueOptions</a></span>}> +[`MfaWebAuthnChangeKeyNicknameContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions) + +An object containing the `nickname` (string) entered by the user. + It can also include any `CustomOptions` for extensibility. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the form submission is initiated. + It does not return data directly upon resolution, as a redirect or + page re-render is the common outcome. + +#### Throws + +Throws an error if `payload.nickname` is not provided or is not a string, + or if the `FormHandler` encounters an unrecoverable issue during submission (e.g., network error). + Validation errors from Auth0 (like an invalid nickname) are not thrown as JavaScript errors + but are reflected in `this.transaction.errors` after the operation. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnChangeKeyNickname +const newNickname = "My Favorite YubiKey"; // Value from user input +try { + await sdk.continueWithNewNickname({ nickname: newNickname }); + // If successful, page redirects. +} catch (error) { + // This catch is for unexpected errors during the SDK call itself. + console.error("Failed to submit the new nickname:", error); +} +// After the await, always check sdk.transaction.errors for server-side validation issues. +if (sdk.transaction.errors && sdk.transaction.errors.length > 0) { + sdk.transaction.errors.forEach(err => { + if (err.field === 'nickname') { + // Display err.message related to the nickname input field. + // e.g., "Name is too short", "Name is required" + } + }); +} +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx new file mode 100644 index 000000000..e4e87bfea --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx @@ -0,0 +1,196 @@ +--- +title: "MfaWebAuthnEnrollmentSuccessMembers" +--- + +Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L58) + +MfaWebAuthnEnrollmentSuccessMembers + + +<RequestExample> +```ts +export interface MfaWebAuthnEnrollmentSuccessMembers extends BaseMembers { + /** + * Access to the specific properties and data of the 'mfa-webauthn-enrollment-success' screen. + * Includes the `nickname` of the enrolled authenticator and its `webauthnType`. + * @type {ScreenMembersOnMfaWebAuthnEnrollmentSuccess} + */ + screen: ScreenMembersOnMfaWebAuthnEnrollmentSuccess; + + /** + * Allows the user to continue the authentication flow after successful WebAuthn enrollment. + * This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` endpoint with `action: "default"`. + * + * @param {ContinueOptions} [payload] - Optional. An object for `CustomOptions` if any + * additional parameters need to be sent with the request. + * @returns {Promise<void>} A promise that resolves when the continue action is successfully submitted. + * On success, the browser will typically be redirected to the next step in the flow. + * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnEnrollmentSuccess + * try { + * await sdk.continue(); + * // User is redirected to the next step. + * } catch (error) { + * console.error("Failed to continue after WebAuthn enrollment:", error); + * // Handle error, potentially by inspecting sdk.transaction.errors if the page re-renders with an error. + * } + * ``` + */ + continue(payload?: ContinueOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess">ScreenMembersOnMfaWebAuthnEnrollmentSuccess</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess)*/} + +Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L64) + +Access to the specific properties and data of the 'mfa-webauthn-enrollment-success' screen. +Includes the `nickname` of the enrolled authenticator and its `webauthnType`. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L88) + +Allows the user to continue the authentication flow after successful WebAuthn enrollment. +This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` endpoint with `action: "default"`. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions">WebAuthnEnrollSuccessContinueOptions</a></span>}> +[`WebAuthnEnrollSuccessContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions) + +Optional. An object for `CustomOptions` if any + additional parameters need to be sent with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the continue action is successfully submitted. + On success, the browser will typically be redirected to the next step in the flow. + +#### Throws + +Throws an error if the form submission fails (e.g., network issue, invalid state). + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnEnrollmentSuccess +try { + await sdk.continue(); + // User is redirected to the next step. +} catch (error) { + console.error("Failed to continue after WebAuthn enrollment:", error); + // Handle error, potentially by inspecting sdk.transaction.errors if the page re-renders with an error. +} +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.mdx new file mode 100644 index 000000000..fc0980e3a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.mdx @@ -0,0 +1,326 @@ +--- +title: "MfaWebAuthnErrorMembers" +--- + +Defined in: [interfaces/screens/mfa-webauthn-error.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L46) + +MfaWebAuthnErrorMembers + + +<RequestExample> +```ts +export interface MfaWebAuthnErrorMembers extends BaseMembers { + /** + * The screen object with MFA WebAuthn Error specific data structure. + */ + screen: ScreenMembersOnMfaWebAuthnError; + + /** + * Allows the user to attempt the previous WebAuthn operation again. + * This typically redirects the user back to the screen where the WebAuthn operation was initiated. + * + * @param {CustomOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnError + * await sdk.tryAgain(); + * ``` + */ + tryAgain(payload?: CustomOptions): Promise<void>; + + /** + * Allows the user to opt for password-based authentication as an alternative, if configured. + * This is typically available if the primary authentication or a previous step involved a password. + * + * @param {CustomOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnError + * await sdk.usePassword(); + * ``` + */ + usePassword(payload?: CustomOptions): Promise<void>; + + /** + * Allows the user to select a different MFA method if other factors are enrolled or available. + * This navigates the user to an authenticator selection screen. + * + * @param {CustomOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnError + * await sdk.tryAnotherMethod(); + * ``` + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + + /** + * Allows the user to refuse adding a device or completing the WebAuthn step, effectively declining the current WebAuthn flow. + * This action is typically used in enrollment scenarios where the user decides not to proceed. + * + * @param {CustomOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnError + * await sdk.noThanks(); + * ``` + */ + noThanks(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError">ScreenMembersOnMfaWebAuthnError</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaWebAuthnError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError)*/} + +Defined in: [interfaces/screens/mfa-webauthn-error.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L50) + +The screen object with MFA WebAuthn Error specific data structure. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='noThanks' type='Promise<void>'> +{/*> **noThanks**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-error.ts:110](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L110) + +Allows the user to refuse adding a device or completing the WebAuthn step, effectively declining the current WebAuthn flow. +This action is typically used in enrollment scenarios where the user decides not to proceed. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted. + +#### Throws + +Throws an error if the submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.noThanks(); +``` + +</ParamField> + +<ParamField body='tryAgain' type='Promise<void>'> +{/*> **tryAgain**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-error.ts:65](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L65) + +Allows the user to attempt the previous WebAuthn operation again. +This typically redirects the user back to the screen where the WebAuthn operation was initiated. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted. + +#### Throws + +Throws an error if the submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.tryAgain(); +``` + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-error.ts:95](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L95) + +Allows the user to select a different MFA method if other factors are enrolled or available. +This navigates the user to an authenticator selection screen. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted. + +#### Throws + +Throws an error if the submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.tryAnotherMethod(); +``` + +</ParamField> + +<ParamField body='usePassword' type='Promise<void>'> +{/*> **usePassword**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-error.ts:80](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L80) + +Allows the user to opt for password-based authentication as an alternative, if configured. +This is typically available if the primary authentication or a previous step involved a password. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted. + +#### Throws + +Throws an error if the submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.usePassword(); +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx new file mode 100644 index 000000000..7146b923e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx @@ -0,0 +1,183 @@ +--- +title: "MfaWebAuthnNotAvailableErrorMembers" +--- + +Defined in: [interfaces/screens/mfa-webauthn-not-available-error.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-not-available-error.ts#L14) + +MfaWebAuthnNotAvailableErrorMembers + + +<RequestExample> +```ts +export interface MfaWebAuthnNotAvailableErrorMembers extends BaseMembers { + /** + * Allows the user to select a different MFA method because WebAuthn is not available. + * This action navigates the user to an authenticator selection screen where they can choose + * from other available/enrolled MFA factors. + * + * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. + * @returns {Promise<void>} A promise that resolves upon successful submission of the 'pick-authenticator' action. + * @throws {Error} Throws an error if the form submission fails (e.g., network issues, server-side validation errors). + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnNotAvailableError + * try { + * await sdk.tryAnotherMethod(); + * // On success, Auth0 handles redirection to the authenticator selection screen. + * } catch (error) { + * console.error('Failed to switch to another MFA method:', error); + * // Potentially update UI to inform the user of the failure. + * } + * ``` + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-not-available-error.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-not-available-error.ts#L35) + +Allows the user to select a different MFA method because WebAuthn is not available. +This action navigates the user to an authenticator selection screen where they can choose +from other available/enrolled MFA factors. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters to be sent with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves upon successful submission of the 'pick-authenticator' action. + +#### Throws + +Throws an error if the form submission fails (e.g., network issues, server-side validation errors). + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnNotAvailableError +try { + await sdk.tryAnotherMethod(); + // On success, Auth0 handles redirection to the authenticator selection screen. +} catch (error) { + console.error('Failed to switch to another MFA method:', error); + // Potentially update UI to inform the user of the failure. +} +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx new file mode 100644 index 000000000..fa85a6986 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx @@ -0,0 +1,354 @@ +--- +title: "MfaWebAuthnPlatformChallengeMembers" +--- + +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:80](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L80) + +MfaWebAuthnPlatformChallengeMembers + + +<RequestExample> +```ts +export interface MfaWebAuthnPlatformChallengeMembers extends BaseMembers { + /** + * Screen-specific properties and data, including WebAuthn challenge options and remember device preference. + * @type {ScreenMembersOnMfaWebAuthnPlatformChallenge} + */ + screen: ScreenMembersOnMfaWebAuthnPlatformChallenge; + + /** + * Initiates the WebAuthn platform authenticator challenge. + * This method internally calls `navigator.credentials.get()` using the challenge options + * provided in `screen.publicKey`. + * If successful, it submits the resulting credential to Auth0 with `action: "default"`. + * + * If `navigator.credentials.get()` fails (e.g., user cancellation, timeout, or other WebAuthn API errors), + * it's recommended to call `reportBrowserError` with the error details. + * + * @param {VerifyPlatformAuthenticatorOptions} [options] - Optional parameters for the verification process, + * such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. + * @returns {Promise<void>} A promise that resolves when the verification attempt is submitted. + * A successful operation typically results in a redirect. + * @throws {Error} Throws an error if `screen.publicKey` is missing, + * if `navigator.credentials.get()` fails with an unexpected error not handled by `getPasskeyCredentials`, + * or if the form submission to Auth0 fails. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformChallenge + * try { + * const remember = sdk.screen.showRememberDevice && userCheckedRememberDeviceBox; + * await sdk.verify({ rememberDevice: remember }); + * // On success, Auth0 handles redirection. + * } catch (error) { + * console.error("Platform authenticator verification failed:", error); + * // If it's a WebAuthn API error, report it + * if (error.name && error.message) { // Basic check for DOMException like error + * await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + * } + * // Check sdk.transaction.errors for server-side validation messages if the page reloads. + * } + * ``` + */ + verify(options?: VerifyPlatformAuthenticatorOptions): Promise<void>; + + /** + * Reports a specific WebAuthn API error (from `navigator.credentials.get()`) to Auth0. + * This method should be used when `verify()` (or a manual `navigator.credentials.get()` call) fails due to + * a browser-side WebAuthn issue (e.g., user cancellation `NotAllowedError`, timeout). + * It submits the error details with `action: "showError::{errorDetailsJsonString}"` and an empty `response`. + * + * @param {ReportBrowserErrorOptions} options - Contains the `error` object (with `name` and `message` + * from the WebAuthn API DOMException) and any other custom options. + * @returns {Promise<void>} A promise that resolves when the error report is submitted. + * @throws {Error} Throws an error if the form submission fails (e.g., network error, invalid state). + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformChallenge + * // And webAuthnDomException is an error object from a failed navigator.credentials.get() call. + * try { + * await sdk.reportBrowserError({ + * error: { name: webAuthnDomException.name, message: webAuthnDomException.message } + * }); + * // Auth0 will process this error and may re-render the page or redirect. + * } catch (submitError) { + * console.error("Failed to report WebAuthn browser error:", submitError); + * } + * ``` + */ + reportBrowserError(options: ReportBrowserErrorOptions): Promise<void>; + + /** + * Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. + * This action submits `action: "pick-authenticator"` to Auth0, which should navigate + * the user to an MFA factor selection screen. + * + * @param {TryAnotherMethodOptions} [options] - Optional custom parameters to be sent with the request. + * @returns {Promise<void>} A promise that resolves when the 'pick-authenticator' action is submitted. + * @throws {Error} Throws an error if the form submission fails. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformChallenge + * try { + * await sdk.tryAnotherMethod(); + * // On success, Auth0 handles redirection to MFA selection. + * } catch (error) { + * console.error("Failed to switch MFA method:", error); + * } + * ``` + */ + tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge">ScreenMembersOnMfaWebAuthnPlatformChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge)*/} + +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L85) + +Screen-specific properties and data, including WebAuthn challenge options and remember device preference. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='reportBrowserError' type='Promise<void>'> +{/*> **reportBrowserError**(`options`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:148](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L148) + +Reports a specific WebAuthn API error (from `navigator.credentials.get()`) to Auth0. +This method should be used when `verify()` (or a manual `navigator.credentials.get()` call) fails due to +a browser-side WebAuthn issue (e.g., user cancellation `NotAllowedError`, timeout). +It submits the error details with `action: "showError::{errorDetailsJsonString}"` and an empty `response`. + +<Expandable title="Parameters"> +<ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions">MfaWebAuthnPlatformChallengeReportErrorOptions</a></span>}> +[`MfaWebAuthnPlatformChallengeReportErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions) + +Contains the `error` object (with `name` and `message` +from the WebAuthn API DOMException) and any other custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the error report is submitted. + +#### Throws + +Throws an error if the form submission fails (e.g., network error, invalid state). + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformChallenge +// And webAuthnDomException is an error object from a failed navigator.credentials.get() call. +try { + await sdk.reportBrowserError({ + error: { name: webAuthnDomException.name, message: webAuthnDomException.message } + }); + // Auth0 will process this error and may re-render the page or redirect. +} catch (submitError) { + console.error("Failed to report WebAuthn browser error:", submitError); +} +``` + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L170) + +Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. +This action submits `action: "pick-authenticator"` to Auth0, which should navigate +the user to an MFA factor selection screen. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions">MfaWebAuthnPlatformChallengeTryAnotherMethodOptions</a></span>}> +[`MfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions) + +Optional custom parameters to be sent with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the 'pick-authenticator' action is submitted. + +#### Throws + +Throws an error if the form submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformChallenge +try { + await sdk.tryAnotherMethod(); + // On success, Auth0 handles redirection to MFA selection. +} catch (error) { + console.error("Failed to switch MFA method:", error); +} +``` + +</ParamField> + +<ParamField body='verify' type='Promise<void>'> +{/*> **verify**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:121](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L121) + +Initiates the WebAuthn platform authenticator challenge. +This method internally calls `navigator.credentials.get()` using the challenge options +provided in `screen.publicKey`. +If successful, it submits the resulting credential to Auth0 with `action: "default"`. + +If `navigator.credentials.get()` fails (e.g., user cancellation, timeout, or other WebAuthn API errors), +it's recommended to call `reportBrowserError` with the error details. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions">VerifyPlatformAuthenticatorOptions</a></span>}> +[`VerifyPlatformAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions) + +Optional parameters for the verification process, +such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the verification attempt is submitted. + A successful operation typically results in a redirect. + +#### Throws + +Throws an error if `screen.publicKey` is missing, + if `navigator.credentials.get()` fails with an unexpected error not handled by `getPasskeyCredentials`, + or if the form submission to Auth0 fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformChallenge +try { + const remember = sdk.screen.showRememberDevice && userCheckedRememberDeviceBox; + await sdk.verify({ rememberDevice: remember }); + // On success, Auth0 handles redirection. +} catch (error) { + console.error("Platform authenticator verification failed:", error); + // If it's a WebAuthn API error, report it + if (error.name && error.message) { // Basic check for DOMException like error + await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + } + // Check sdk.transaction.errors for server-side validation messages if the page reloads. +} +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx new file mode 100644 index 000000000..0e79a05b1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx @@ -0,0 +1,31 @@ +--- +title: "MfaWebAuthnPlatformChallengeReportErrorOptions" +--- + +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L56) + +ReportBrowserErrorOptions + + +<RequestExample> +```ts +export interface ReportBrowserErrorOptions { + /** + * The error object received from the WebAuthn API (`navigator.credentials.get()`) failure. + * This should include at least `name` and `message` properties of the DOMException. + * @type {WebAuthnErrorDetails} + */ + error: WebAuthnErrorDetails; +} +``` +</RequestExample> + +## Properties + +<ParamField body='error' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>}> +{/*> **error**: [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails)*/} + +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:62](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L62) + +The error object from the WebAuthn API (`navigator.credentials.get()`) to be reported. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..b66a65ee1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,22 @@ +--- +title: "MfaWebAuthnPlatformChallengeTryAnotherMethodOptions" +--- + +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:72](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L72) + +TryAnotherMethodOptions + + +<RequestExample> +```ts +export interface TryAnotherMethodOptions extends CustomOptions {} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx new file mode 100644 index 000000000..6966a04d1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx @@ -0,0 +1,334 @@ +--- +title: "MfaWebAuthnPlatformEnrollmentMembers" +--- + +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L55) + +MfaWebAuthnPlatformEnrollmentMembers + + +<RequestExample> +```ts +export interface MfaWebAuthnPlatformEnrollmentMembers extends BaseMembers { + /** + * The screen object with MFA WebAuthn Platform Enrollment specific data structure. + */ + screen: ScreenMembersOnMfaWebAuthnPlatformEnrollment; + + /** + * Initiates the WebAuthn platform credential creation process using the public key options + * available on `this.screen.publicKey` and submits the resulting credential to the server. + * This method internally calls `createPasskeyCredentials` (which wraps `navigator.credentials.create()`). + * + * @param {SubmitPasskeyCredentialOptions} [payload] - Optional custom parameters to be sent to the server + * along with the created credential. + * @returns {Promise<void>} A promise that resolves when the credential is successfully created and submitted. + * @throws {Error} Throws an error if `this.screen.publicKey` is not available, if `createPasskeyCredentials` fails + * (e.g., user cancellation, hardware issues), or if the submission to the server fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment + * try { + * if (!sdk.screen.publicKey) { // Check if options are available + * throw new Error("Public key creation options are not available on the screen context."); + * } + * await sdk.submitPasskeyCredential(); // No need to pass publicKey explicitly + * // On success, Auth0 handles redirection. + * } catch (error) { + * console.error('Passkey enrollment failed:', error); + * // Handle error, potentially by calling reportBrowserError if it's a WebAuthn API error + * if (error.name && error.message) { // Check if it looks like a WebAuthn error + * await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + * } + * } + * ``` + */ + submitPasskeyCredential(payload?: SubmitPasskeyCredentialOptions): Promise<void>; + + /** + * Reports a browser-side error encountered during the WebAuthn `navigator.credentials.create()` operation. + * This method sends the error details to the server. + * + * @param {ReportBrowserErrorOptions} payload - The browser error details and any custom options. + * @returns {Promise<void>} A promise that resolves when the error report is successfully submitted. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment + * // In the catch block of an attempted passkey creation (e.g. from submitPasskeyCredential): + * } catch (webAuthnError) { + * if (webAuthnError.name) { // Check if it's likely a WebAuthn API error + * await sdk.reportBrowserError({ error: { name: webAuthnError.name, message: webAuthnError.message } }); + * } + * // Update UI to show error message to the user + * } +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment">ScreenMembersOnMfaWebAuthnPlatformEnrollment</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment)*/} + +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L59) + +The screen object with MFA WebAuthn Platform Enrollment specific data structure. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='refuseEnrollmentOnThisDevice' type='Promise<void>'> +{/*> **refuseEnrollmentOnThisDevice**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:140](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L140) + +Allows the user to refuse WebAuthn platform enrollment on the current device. +This action indicates the user does not want to use a platform authenticator on this specific device. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the refusal action is successfully submitted. + +#### Throws + +Throws an error if the submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment +await sdk.refuseEnrollmentOnThisDevice(); +``` + +</ParamField> + +<ParamField body='reportBrowserError' type='Promise<void>'> +{/*> **reportBrowserError**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:110](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L110) + +Reports a browser-side error encountered during the WebAuthn `navigator.credentials.create()` operation. +This method sends the error details to the server. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions">ReportBrowserErrorOptions</a></span>}> +[`ReportBrowserErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions) + +The browser error details and any custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the error report is successfully submitted. + +#### Throws + +Throws an error if the submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment +// In the catch block of an attempted passkey creation (e.g. from submitPasskeyCredential): +} catch (webAuthnError) { + if (webAuthnError.name) { // Check if it's likely a WebAuthn API error + await sdk.reportBrowserError({ error: { name: webAuthnError.name, message: webAuthnError.message } }); + } + // Update UI to show error message to the user +} +``` + +</ParamField> + +<ParamField body='snoozeEnrollment' type='Promise<void>'> +{/*> **snoozeEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:125](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L125) + +Allows the user to snooze or postpone the WebAuthn platform enrollment. +This action typically means the user will be reminded to enroll at a later time. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the snooze action is successfully submitted. + +#### Throws + +Throws an error if the submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment +await sdk.snoozeEnrollment(); +``` + +</ParamField> + +<ParamField body='submitPasskeyCredential' type='Promise<void>'> +{/*> **submitPasskeyCredential**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L89) + +Initiates the WebAuthn platform credential creation process using the public key options +available on `this.screen.publicKey` and submits the resulting credential to the server. +This method internally calls `createPasskeyCredentials` (which wraps `navigator.credentials.create()`). + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions">SubmitPasskeyCredentialOptions</a></span>}> +[`SubmitPasskeyCredentialOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions) + +Optional custom parameters to be sent to the server +along with the created credential. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the credential is successfully created and submitted. + +#### Throws + +Throws an error if `this.screen.publicKey` is not available, if `createPasskeyCredentials` fails +(e.g., user cancellation, hardware issues), or if the submission to the server fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment +try { + if (!sdk.screen.publicKey) { // Check if options are available + throw new Error("Public key creation options are not available on the screen context."); + } + await sdk.submitPasskeyCredential(); // No need to pass publicKey explicitly + // On success, Auth0 handles redirection. +} catch (error) { + console.error('Passkey enrollment failed:', error); + // Handle error, potentially by calling reportBrowserError if it's a WebAuthn API error + if (error.name && error.message) { // Check if it looks like a WebAuthn error + await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + } +} +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx new file mode 100644 index 000000000..45df59f79 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx @@ -0,0 +1,340 @@ +--- +title: "MfaWebAuthnRoamingChallengeMembers" +--- + +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L60) + +MfaWebAuthnRoamingChallengeMembers + + +<RequestExample> +```ts +export interface MfaWebAuthnRoamingChallengeMembers extends BaseMembers { + /** + * Screen-specific properties and data, including WebAuthn challenge options. + * @type {ScreenMembersOnMfaWebAuthnRoamingChallenge} + */ + screen: ScreenMembersOnMfaWebAuthnRoamingChallenge; + + /** + * Initiates the WebAuthn challenge by calling `navigator.credentials.get()` with the + * options provided in `screen.data.publicKeyChallengeOptions`. + * If successful, it submits the resulting credential to Auth0 with `action: "default"`. + * If `navigator.credentials.get()` fails with a known WebAuthn API error (like `NotAllowedError`), + * this method will internally call `reportWebAuthnError` to inform Auth0. + * + * @param {VerifySecurityKeyOptions} [options] - Optional parameters for the verification process, + * such as `rememberDevice` and other custom options. + * @returns {Promise<void>} A promise that resolves when the verification attempt is submitted. + * It does not directly return data as a successful operation typically results in a redirect. + * @throws {Error} Throws an error if `screen.data.publicKeyChallengeOptions` is missing, + * if `navigator.credentials.get()` fails with an unexpected error, + * or if the form submission to Auth0 fails. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge + * try { + * await sdk.verify({ rememberDevice: true }); + * // On success, Auth0 handles redirection. + * } catch (error) { + * console.error("Security key verification failed:", error); + * // Check sdk.transaction.errors for server-side validation messages if the page reloads. + * } + * ``` + */ + verify(options?: VerifySecurityKeyOptions): Promise<void>; + + /** + * Reports a specific WebAuthn API error to Auth0. + * This method should be used if `navigator.credentials.get()` fails in a way that + * `verify()` doesn't automatically handle, or if the developer wants to explicitly + * report an error before trying another action. + * It submits the error details with `action: "showError::{errorDetails}"`. + * + * @param {ReportWebAuthnErrorOptions} options - Contains the `error` object with `name` and `message` + * from the WebAuthn API, and any other custom options. + * @returns {Promise<void>} A promise that resolves when the error report is submitted. + * @throws {Error} Throws an error if the form submission fails. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge + * // And webAuthnError is an error object from a failed navigator.credentials.get() call. + * try { + * await sdk.reportWebAuthnError({ + * error: { name: webAuthnError.name, message: webAuthnError.message } + * }); + * } catch (submitError) { + * console.error("Failed to report WebAuthn error:", submitError); + * } + * ``` + */ + reportWebAuthnError(options: ReportWebAuthnErrorOptions): Promise<void>; + + /** + * Allows the user to opt-out of the WebAuthn challenge and select a different MFA method. + * This action submits `action: "pick-authenticator"` to Auth0, which should navigate + * the user to an MFA factor selection screen. + * + * @param {TryAnotherMethodOptions} [options] - Optional custom parameters for the request. + * @returns {Promise<void>} A promise that resolves when the action is submitted. + * @throws {Error} Throws an error if the form submission fails. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge + * try { + * await sdk.tryAnotherMethod(); + * // On success, Auth0 handles redirection to MFA selection. + * } catch (error) { + * console.error("Failed to switch MFA method:", error); + * } + * ``` + */ + tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge">ScreenMembersOnMfaWebAuthnRoamingChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge)*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:65](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L65) + +Screen-specific properties and data, including WebAuthn challenge options. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='reportWebAuthnError' type='Promise<void>'> +{/*> **reportWebAuthnError**(`options`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:121](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L121) + +Reports a specific WebAuthn API error to Auth0. +This method should be used if `navigator.credentials.get()` fails in a way that +`verify()` doesn't automatically handle, or if the developer wants to explicitly +report an error before trying another action. +It submits the error details with `action: "showError::{errorDetails}"`. + +<Expandable title="Parameters"> +<ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions">MfaWebAuthnRoamingChallengeReportErrorOptions</a></span>}> +[`MfaWebAuthnRoamingChallengeReportErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions) + +Contains the `error` object with `name` and `message` +from the WebAuthn API, and any other custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the error report is submitted. + +#### Throws + +Throws an error if the form submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge +// And webAuthnError is an error object from a failed navigator.credentials.get() call. +try { + await sdk.reportWebAuthnError({ + error: { name: webAuthnError.name, message: webAuthnError.message } + }); +} catch (submitError) { + console.error("Failed to report WebAuthn error:", submitError); +} +``` + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:143](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L143) + +Allows the user to opt-out of the WebAuthn challenge and select a different MFA method. +This action submits `action: "pick-authenticator"` to Auth0, which should navigate +the user to an MFA factor selection screen. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions">MfaWebAuthnRoamingChallengeTryAnotherMethodOptions</a></span>}> +[`MfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions) + +Optional custom parameters for the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is submitted. + +#### Throws + +Throws an error if the form submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge +try { + await sdk.tryAnotherMethod(); + // On success, Auth0 handles redirection to MFA selection. +} catch (error) { + console.error("Failed to switch MFA method:", error); +} +``` + +</ParamField> + +<ParamField body='verify' type='Promise<void>'> +{/*> **verify**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:94](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L94) + +Initiates the WebAuthn challenge by calling `navigator.credentials.get()` with the +options provided in `screen.data.publicKeyChallengeOptions`. +If successful, it submits the resulting credential to Auth0 with `action: "default"`. +If `navigator.credentials.get()` fails with a known WebAuthn API error (like `NotAllowedError`), +this method will internally call `reportWebAuthnError` to inform Auth0. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions">VerifySecurityKeyOptions</a></span>}> +[`VerifySecurityKeyOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions) + +Optional parameters for the verification process, +such as `rememberDevice` and other custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the verification attempt is submitted. + It does not directly return data as a successful operation typically results in a redirect. + +#### Throws + +Throws an error if `screen.data.publicKeyChallengeOptions` is missing, + if `navigator.credentials.get()` fails with an unexpected error, + or if the form submission to Auth0 fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge +try { + await sdk.verify({ rememberDevice: true }); + // On success, Auth0 handles redirection. +} catch (error) { + console.error("Security key verification failed:", error); + // Check sdk.transaction.errors for server-side validation messages if the page reloads. +} +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx new file mode 100644 index 000000000..47d3ac971 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx @@ -0,0 +1,26 @@ +--- +title: "MfaWebAuthnRoamingChallengeReportErrorOptions" +--- + +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L42) + +ReportWebAuthnErrorOptions + + +<RequestExample> +```ts +export interface ReportWebAuthnErrorOptions { + error: WebAuthnErrorDetails; +} +``` +</RequestExample> + +## Properties + +<ParamField body='error' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>}> +{/*> **error**: [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails)*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L43) + +The error object from the WebAuthn API to be reported. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..3fd6f2d9b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,22 @@ +--- +title: "MfaWebAuthnRoamingChallengeTryAnotherMethodOptions" +--- + +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L52) + +TryAnotherMethodOptions + + +<RequestExample> +```ts +export interface TryAnotherMethodOptions extends CustomOptions {} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx new file mode 100644 index 000000000..bed09ed10 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx @@ -0,0 +1,295 @@ +--- +title: "MfaWebAuthnRoamingEnrollmentMembers" +--- + +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L36) + +Interface defining the available methods and properties for the mfa-webauthn-roaming-enrollment screen. + + +<RequestExample> +```ts +export interface MfaWebAuthnRoamingEnrollmentMembers extends BaseMembers { + screen: ScreenMembersOnMfaWebAuthnRoamingEnrollment; + /** + * Initiates the WebAuthn credential creation and submits the result to the server. + * This corresponds to the user interacting with the FIDO Security Keys prompt. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + * + * const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); + * try { + * // This will trigger the browser's WebAuthn prompt + * const credential = await navigator.credentials.create({ publicKey: webauthnEnrollment.screen.data.passkey.public_key }); + * // You would typically serialize the credential response here + * const response = JSON.stringify(credential); + * await webauthnEnrollment.enroll({ response }); + * } catch (error) { + * console.error('WebAuthn enrollment failed:', error); + * // Handle the error, e.g., show an error message to the user or submit the error details + * // await webauthnEnrollment.showError({ error: { name: error.name, message: error.message } }); + * } + * ``` + */ + enroll(payload: CustomOptions): Promise<void>; + /** + * Submits details about a WebAuthn browser error to the server. + * This is used when the browser's WebAuthn API encounters an error. + * @param payload The options containing the error details. + * @example + * ```typescript + * import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + * + * const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); + * // Example error handler for the browser's WebAuthn API call + * const handleError = async (error: any) => { + * console.error('WebAuthn error:', error); + * await webauthnEnrollment.showError({ + * error: { + * name: error.name, + * message: error.message, + * // Include other relevant error properties if available + * }, + * }); + * }; + * // ... use handleError in your WebAuthn API call's catch block + * ``` + */ + showError(payload: ShowErrorOptions): Promise<void>; + /** + * Allows the user to try another MFA method. + * This corresponds to the "Try Another Method" button. + * @param payload Optional custom options to include with the request. + * @example + * ```typescript + * import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + * + * const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); + * await webauthnEnrollment.tryAnotherMethod(); + * ``` + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment">ScreenMembersOnMfaWebAuthnRoamingEnrollment</a></span>}> +{/*> **screen**: [`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment)*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L37) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='enroll' type='Promise<void>'> +{/*> **enroll**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L60) + +Initiates the WebAuthn credential creation and submits the result to the server. +This corresponds to the user interacting with the FIDO Security Keys prompt. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + +const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); +try { + // This will trigger the browser's WebAuthn prompt + const credential = await navigator.credentials.create({ publicKey: webauthnEnrollment.screen.data.passkey.public_key }); + // You would typically serialize the credential response here + const response = JSON.stringify(credential); + await webauthnEnrollment.enroll({ response }); +} catch (error) { + console.error('WebAuthn enrollment failed:', error); + // Handle the error, e.g., show an error message to the user or submit the error details + // await webauthnEnrollment.showError({ error: { name: error.name, message: error.message } }); +} +``` + +</ParamField> + +<ParamField body='showError' type='Promise<void>'> +{/*> **showError**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L84) + +Submits details about a WebAuthn browser error to the server. +This is used when the browser's WebAuthn API encounters an error. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions">ShowErrorOptions</a></span>}> +[`ShowErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions) + +The options containing the error details. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + +const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); +// Example error handler for the browser's WebAuthn API call +const handleError = async (error: any) => { + console.error('WebAuthn error:', error); + await webauthnEnrollment.showError({ + error: { + name: error.name, + message: error.message, + // Include other relevant error properties if available + }, + }); +}; +// ... use handleError in your WebAuthn API call's catch block +``` + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:97](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L97) + +Allows the user to try another MFA method. +This corresponds to the "Try Another Method" button. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions">MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions</a></span>}> +[`MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +#### Example + +```typescript +import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + +const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); +await webauthnEnrollment.tryAnotherMethod(); +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..1c9ff95bc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx @@ -0,0 +1,25 @@ +--- +title: "MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions" +--- + +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L27) + +Options for trying another MFA method. + + +<RequestExample> +```ts +export interface TryAnotherMethodOptions { + /** + * Any additional custom options. + */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options. \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers.mdx new file mode 100644 index 000000000..625585c62 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers.mdx @@ -0,0 +1,62 @@ +--- +title: "OrganizationMembers" +--- + +Defined in: [interfaces/models/organization.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L26) + + +<RequestExample> +```ts +export interface OrganizationMembers { + id: string | null; + name: string | null; + usage: string | null; + displayName: string | null; + branding: Branding | null; + metadata: { [key: string]: string } | null; +} +``` +</RequestExample> + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding">Branding</a></span>}> +{/*> **branding**: [`Branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding) \| `null`*/} + +Defined in: [interfaces/models/organization.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L31) + +</ParamField> + +<ParamField body='displayName' type='string'> +{/*> **displayName**: `string` \| `null`*/} + +Defined in: [interfaces/models/organization.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L30) + +</ParamField> + +<ParamField body='id' type='string'> +{/*> **id**: `string` \| `null`*/} + +Defined in: [interfaces/models/organization.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L27) + +</ParamField> + +<ParamField body='metadata' type='key'> +{/*> **metadata**: \{\[`key`: `string`\]: `string`; \} \| `null`*/} + +Defined in: [interfaces/models/organization.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L32) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string` \| `null`*/} + +Defined in: [interfaces/models/organization.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L28) + +</ParamField> + +<ParamField body='usage' type='string'> +{/*> **usage**: `string` \| `null`*/} + +Defined in: [interfaces/models/organization.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L29) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.mdx new file mode 100644 index 000000000..d7ed3dc92 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.mdx @@ -0,0 +1,179 @@ +--- +title: "OrganizationPickerMembers" +--- + +Defined in: [interfaces/screens/organization-picker.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L12) + +Interface defining the available methods and properties for the organization-picker screen + + +<RequestExample> +```ts +export interface OrganizationPickerMembers extends BaseMembers { + /** + * Selects an organization for the user. + * @param payload The options containing the organization ID. + */ + selectOrganization(payload: { organization: string; state: string }): Promise<void>; + + /** + * Skips the organization selection, proceeding with the user's personal account. + * @param payload Optional custom options to include with the request. + */ + skipOrganizationSelection(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='selectOrganization' type='Promise<void>'> +{/*> **selectOrganization**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/organization-picker.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L17) + +Selects an organization for the user. + +<Expandable title="Parameters"> +<ParamField body='payload' type='string'> +The options containing the organization ID. + +###### organization + +`string` + +###### state + +`string` +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='skipOrganizationSelection' type='Promise<void>'> +{/*> **skipOrganizationSelection**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/organization-picker.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L23) + +Skips the organization selection, proceeding with the user's personal account. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.mdx new file mode 100644 index 000000000..713f1194e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.mdx @@ -0,0 +1,152 @@ +--- +title: "OrganizationSelectionMembers" +--- + +Defined in: [interfaces/screens/organization-selection.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L38) + +Interface defining the available methods and properties for the organization-selection screen. + + +<RequestExample> +```ts +export interface OrganizationSelectionMembers extends BaseMembers { + /** + * The screen properties. + */ + screen: ScreenMembersOnOrganizationSelection; + /** + * Continues with the selected organization name. + * @param payload The options containing the organization name. + */ + continueWithOrganizationName(payload: ContinueWithOrganizationNameOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection">ScreenMembersOnOrganizationSelection</a></span>}> +{/*> **screen**: [`ScreenMembersOnOrganizationSelection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection)*/} + +Defined in: [interfaces/screens/organization-selection.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L42) + +The screen properties. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continueWithOrganizationName' type='Promise<void>'> +{/*> **continueWithOrganizationName**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/organization-selection.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L47) + +Continues with the selected organization name. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions">ContinueWithOrganizationNameOptions</a></span>}> +[`ContinueWithOrganizationNameOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions) + +The options containing the organization name. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Organizations.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Organizations.mdx new file mode 100644 index 000000000..a82efe1ca --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Organizations.mdx @@ -0,0 +1,46 @@ +--- +title: "Organizations" +--- + +Defined in: [interfaces/models/user.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L32) + + +<RequestExample> +```ts +export interface Organizations { + organizationId: string | undefined; + organizationName: string | undefined; + displayName: string | undefined; + branding: Branding; +} +``` +</RequestExample> + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding">Branding</a></span>}> +{/*> **branding**: [`Branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding)*/} + +Defined in: [interfaces/models/user.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L36) + +</ParamField> + +<ParamField body='displayName' type='string'> +{/*> **displayName**: `string` \| `undefined`*/} + +Defined in: [interfaces/models/user.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L35) + +</ParamField> + +<ParamField body='organizationId' type='string'> +{/*> **organizationId**: `string` \| `undefined`*/} + +Defined in: [interfaces/models/user.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L33) + +</ParamField> + +<ParamField body='organizationName' type='string'> +{/*> **organizationName**: `string` \| `undefined`*/} + +Defined in: [interfaces/models/user.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L34) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions.mdx new file mode 100644 index 000000000..6ef93b0f3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "OtpCodeOptions" +--- + +Defined in: [interfaces/screens/email-otp-challenge.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L14) + + +<RequestExample> +```ts +export interface OtpCodeOptions extends CustomOptions { + /** + * The OTP code that the user enters to submit. + */ + code: string; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/email-otp-challenge.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L18) + +The OTP code that the user enters to submit. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate.mdx new file mode 100644 index 000000000..57a7fd883 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate.mdx @@ -0,0 +1,95 @@ +--- +title: "PasskeyCreate" +--- + +Defined in: [interfaces/models/screen.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L23) + + +<RequestExample> +```ts +export interface PasskeyCreate { + public_key: { + user: { + id: string; + name: string; + displayName: string; + }; + rp: { + id: string; + name: string; + }; + challenge: string; + pubKeyCredParams: [ + { + type: string; + alg: number; + }, + ]; + authenticatorSelection: { + residentKey: string; + userVerification: string; + authenticatorAttachment?: string; + }; + }; +} +``` +</RequestExample> + +## Properties + +<ParamField body='public_key' type='object'> +{/*> **public_key**: `object`*/} + +Defined in: [interfaces/models/screen.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L24) + +<Expandable title="Properties"> +<ParamField body='authenticatorSelection' type='object'> +{/*> **authenticatorSelection**: `object`*/} + +<Expandable title="Properties"> +<ParamField body='authenticatorSelection.authenticatorAttachment?' type='string'> +{/*> `optional` **authenticatorAttachment**: `string`*/} +</ParamField> +<ParamField body='authenticatorSelection.residentKey' type='string'> +{/*> **residentKey**: `string`*/} +</ParamField> +<ParamField body='authenticatorSelection.userVerification' type='string'> +{/*> **userVerification**: `string`*/} +</ParamField> +</Expandable> +</ParamField> +<ParamField body='challenge' type='object'> +{/*> **challenge**: `string`*/} +</ParamField> +<ParamField body='pubKeyCredParams' type='object'> +{/*> **pubKeyCredParams**: `[{ alg: number; type: string; }]`*/} +</ParamField> +<ParamField body='rp' type='object'> +{/*> **rp**: `object`*/} + +<Expandable title="Properties"> +<ParamField body='rp.id' type='string'> +{/*> **id**: `string`*/} +</ParamField> +<ParamField body='rp.name' type='string'> +{/*> **name**: `string`*/} +</ParamField> +</Expandable> +</ParamField> +<ParamField body='user' type='object'> +{/*> **user**: `object`*/} + +<Expandable title="Properties"> +<ParamField body='user.displayName' type='string'> +{/*> **displayName**: `string`*/} +</ParamField> +<ParamField body='user.id' type='string'> +{/*> **id**: `string`*/} +</ParamField> +<ParamField body='user.name' type='string'> +{/*> **name**: `string`*/} +</ParamField> +</Expandable> +</ParamField> +</Expandable> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreateResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreateResponse.mdx new file mode 100644 index 000000000..915c208f0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreateResponse.mdx @@ -0,0 +1,54 @@ +--- +title: "PasskeyCreateResponse" +--- + +Defined in: [interfaces/utils/passkeys.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L21) + + +<RequestExample> +```ts +export interface PasskeyCreateResponse { + id: string; + rawId: string | null; + type: string; + authenticatorAttachment: string | null; + response: CredentialResponse; +} +``` +</RequestExample> + +## Properties + +<ParamField body='authenticatorAttachment' type='string'> +{/*> **authenticatorAttachment**: `string` \| `null`*/} + +Defined in: [interfaces/utils/passkeys.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L25) + +</ParamField> + +<ParamField body='id' type='string'> +{/*> **id**: `string`*/} + +Defined in: [interfaces/utils/passkeys.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L22) + +</ParamField> + +<ParamField body='rawId' type='string'> +{/*> **rawId**: `string` \| `null`*/} + +Defined in: [interfaces/utils/passkeys.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L23) + +</ParamField> + +<ParamField body='response' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse">CredentialResponse</a></span>}> +{/*> **response**: [`CredentialResponse`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse)*/} + +Defined in: [interfaces/utils/passkeys.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L26) + +</ParamField> + +<ParamField body='type' type='string'> +{/*> **type**: `string`*/} + +Defined in: [interfaces/utils/passkeys.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L24) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.mdx new file mode 100644 index 000000000..58c2cdf64 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.mdx @@ -0,0 +1,155 @@ +--- +title: "PasskeyEnrollmentLocalMembers" +--- + +Defined in: [interfaces/screens/passkey-enrollment-local.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L28) + + +<RequestExample> +```ts +export interface PasskeyEnrollmentLocalMembers extends BaseMembers { + screen: ScreenMembersOnPasskeyEnrollmentLocal; + continuePasskeyEnrollment(payload?: CustomOptions): Promise<void>; + abortPasskeyEnrollment(payload: AbortEnrollmentOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal">ScreenMembersOnPasskeyEnrollmentLocal</a></span>}> +{/*> **screen**: [`ScreenMembersOnPasskeyEnrollmentLocal`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal)*/} + +Defined in: [interfaces/screens/passkey-enrollment-local.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L29) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='abortPasskeyEnrollment' type='Promise<void>'> +{/*> **abortPasskeyEnrollment**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/passkey-enrollment-local.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L31) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions">AbortEnrollmentOptions</a></span>}> +[`AbortEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='continuePasskeyEnrollment' type='Promise<void>'> +{/*> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/passkey-enrollment-local.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L30) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.mdx new file mode 100644 index 000000000..4181c7371 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.mdx @@ -0,0 +1,155 @@ +--- +title: "PasskeyEnrollmentMembers" +--- + +Defined in: [interfaces/screens/passkey-enrollment.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L25) + + +<RequestExample> +```ts +export interface PasskeyEnrollmentMembers extends BaseMembers { + screen: ScreenMembersOnPasskeyEnrollment; + continuePasskeyEnrollment(payload?: CustomOptions): Promise<void>; + abortPasskeyEnrollment(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment">ScreenMembersOnPasskeyEnrollment</a></span>}> +{/*> **screen**: [`ScreenMembersOnPasskeyEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment)*/} + +Defined in: [interfaces/screens/passkey-enrollment.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L26) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='abortPasskeyEnrollment' type='Promise<void>'> +{/*> **abortPasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/passkey-enrollment.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L28) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='continuePasskeyEnrollment' type='Promise<void>'> +{/*> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/passkey-enrollment.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L27) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule.mdx new file mode 100644 index 000000000..dd433c060 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule.mdx @@ -0,0 +1,78 @@ +--- +title: "PasswordComplexityRule" +--- + +Defined in: [interfaces/models/transaction.ts:136](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L136) + + +<RequestExample> +```ts +export interface PasswordComplexityRule { + code: string; + label: string; + status: 'valid' | 'error'; + isValid: boolean; + args?: { + count: number; + total?: number; + example?: string; + }; + items?: PasswordComplexityRule[]; +} +``` +</RequestExample> + +## Properties + +<ParamField body='args?' type='object'> +{/*> `optional` **args**: `object`*/} + +Defined in: [interfaces/models/transaction.ts:141](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L141) + +#### count + +{/*> **count**: `number`*/} + +#### example? + +{/*> `optional` **example**: `string`*/} + +#### total? + +{/*> `optional` **total**: `number`*/} + +</ParamField> + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:137](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L137) + +</ParamField> + +<ParamField body='isValid' type='boolean'> +{/*> **isValid**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:140](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L140) + +</ParamField> + +<ParamField body='items?' type='PasswordComplexityRule'> +{/*> `optional` **items**: `PasswordComplexityRule`[]*/} + +Defined in: [interfaces/models/transaction.ts:146](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L146) + +</ParamField> + +<ParamField body='label' type='string'> +{/*> **label**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:138](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L138) + +</ParamField> + +<ParamField body='status' type='"valid"'> +{/*> **status**: `"valid"` \| `"error"`*/} + +Defined in: [interfaces/models/transaction.ts:139](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L139) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy.mdx new file mode 100644 index 000000000..32fe54d2a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy.mdx @@ -0,0 +1,46 @@ +--- +title: "PasswordPolicy" +--- + +Defined in: [interfaces/models/transaction.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L57) + + +<RequestExample> +```ts +export interface PasswordPolicy { + enabled?: boolean; + minLength?: number; + policy: 'none' | 'low' | 'fair' | 'good' | 'excellent'; + passwordSecurityInfo?: PasswordComplexityRule[]; +} +``` +</RequestExample> + +## Properties + +<ParamField body='enabled?' type='boolean'> +{/*> `optional` **enabled**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L58) + +</ParamField> + +<ParamField body='minLength?' type='number'> +{/*> `optional` **minLength**: `number`*/} + +Defined in: [interfaces/models/transaction.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L59) + +</ParamField> + +<ParamField body='passwordSecurityInfo?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule">PasswordComplexityRule</a></span>}> +{/*> `optional` **passwordSecurityInfo**: [`PasswordComplexityRule`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule)[]*/} + +Defined in: [interfaces/models/transaction.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L61) + +</ParamField> + +<ParamField body='policy' type='"none"'> +{/*> **policy**: `"none"` \| `"low"` \| `"fair"` \| `"good"` \| `"excellent"`*/} + +Defined in: [interfaces/models/transaction.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L60) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult.mdx new file mode 100644 index 000000000..dfad198ab --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult.mdx @@ -0,0 +1,53 @@ +--- +title: "PasswordValidationResult" +--- + +Defined in: [interfaces/utils/validate-password.ts:2](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-password.ts#L2) + + +<RequestExample> +```ts +export interface PasswordValidationResult { + /** + * Overall outcome of all password policy checks. + * + * `true` only if every rule in {@link PasswordComplexityRule} has `status` equal to `"valid"`. + */ + isValid: boolean; + + /** + * Array of evaluated password rules. + * + * Each item is a {@link PasswordComplexityRule} whose + * {@link PasswordComplexityRule.status | status} field reflects the + * computed validation result for that rule. + */ + results: PasswordComplexityRule[]; +} +``` +</RequestExample> + +## Properties + +<ParamField body='isValid' type='boolean'> +{/*> **isValid**: `boolean`*/} + +Defined in: [interfaces/utils/validate-password.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-password.ts#L8) + +Overall outcome of all password policy checks. + +`true` only if every rule in [PasswordComplexityRule](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule) has `status` equal to `"valid"`. + +</ParamField> + +<ParamField body='results' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule">PasswordComplexityRule</a></span>}> +{/*> **results**: [`PasswordComplexityRule`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule)[]*/} + +Defined in: [interfaces/utils/validate-password.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-password.ts#L17) + +Array of evaluated password rules. + +Each item is a [PasswordComplexityRule](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule) whose +[status](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule.md#status) field reflects the +computed validation result for that rule. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions.mdx new file mode 100644 index 000000000..72f088d95 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "PhoneChallengeOptions" +--- + +Defined in: [interfaces/screens/phone-identifier-challenge.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L6) + + +<RequestExample> +```ts +export interface PhoneChallengeOptions { + code: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='captcha?' type='string'> +{/*> `optional` **captcha**: `string`*/} + +Defined in: [interfaces/screens/phone-identifier-challenge.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L8) + +</ParamField> + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/phone-identifier-challenge.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L7) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions.mdx new file mode 100644 index 000000000..b41cff20d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "PhoneEnrollmentOptions" +--- + +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L18) + + +<RequestExample> +```ts +export interface PhoneEnrollmentOptions { + type: 'text' | 'voice'; + [key: string]: string | number | boolean; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + +<ParamField body='type' type='"voice"'> +{/*> **type**: `"voice"` \| `"text"`*/} + +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L19) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.mdx new file mode 100644 index 000000000..2bc53c5f4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.mdx @@ -0,0 +1,227 @@ +--- +title: "PhoneIdentifierChallengeMembers" +--- + +Defined in: [interfaces/screens/phone-identifier-challenge.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L36) + + +<RequestExample> +```ts +export interface PhoneIdentifierChallengeMembers extends BaseMembers { + screen: ScreenMembersOnPhoneIdentifierChallenge; + submitPhoneChallenge(payload: PhoneChallengeOptions): Promise<void>; + resendCode(payload?: CustomOptions): Promise<void>; + resendManager(options?: StartResendOptions): ResendControl; + returnToPrevious(payload?: CustomOptions): Promise<void>; + switchToVoice(payload?: CustomOptions): Promise<void>; + switchToText(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge">ScreenMembersOnPhoneIdentifierChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnPhoneIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge)*/} + +Defined in: [interfaces/screens/phone-identifier-challenge.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L37) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/phone-identifier-challenge.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L39) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [interfaces/screens/phone-identifier-challenge.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L40) + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +</ParamField> + +<ParamField body='returnToPrevious' type='Promise<void>'> +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/phone-identifier-challenge.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L41) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='submitPhoneChallenge' type='Promise<void>'> +{/*> **submitPhoneChallenge**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/phone-identifier-challenge.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L38) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions">PhoneChallengeOptions</a></span>}> +[`PhoneChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='switchToText' type='Promise<void>'> +{/*> **switchToText**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/phone-identifier-challenge.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L43) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='switchToVoice' type='Promise<void>'> +{/*> **switchToVoice**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/phone-identifier-challenge.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L42) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.mdx new file mode 100644 index 000000000..6825fa7c5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.mdx @@ -0,0 +1,155 @@ +--- +title: "PhoneIdentifierEnrollmentMembers" +--- + +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L23) + + +<RequestExample> +```ts +export interface PhoneIdentifierEnrollmentMembers extends BaseMembers { + screen: ScreenMembersOnPhoneIdentifierEnrollment; + continuePhoneEnrollment(payload: PhoneEnrollmentOptions): Promise<void>; + returnToPrevious(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment">ScreenMembersOnPhoneIdentifierEnrollment</a></span>}> +{/*> **screen**: [`ScreenMembersOnPhoneIdentifierEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment)*/} + +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L24) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continuePhoneEnrollment' type='Promise<void>'> +{/*> **continuePhoneEnrollment**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L25) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions">PhoneEnrollmentOptions</a></span>}> +[`PhoneEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='returnToPrevious' type='Promise<void>'> +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L26) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix.mdx new file mode 100644 index 000000000..dcf98e9f1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix.mdx @@ -0,0 +1,47 @@ +--- +title: "PhonePrefix" +--- + +Defined in: [interfaces/models/screen.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L49) + + +<RequestExample> +```ts +export interface PhonePrefix { + /** The country name */ + country: string; + /** The country code (e.g. 'US', 'GB') */ + country_code: string; + /** The phone prefix (e.g. '+1', '+44') */ + phone_prefix: string; +} +``` +</RequestExample> + +## Properties + +<ParamField body='country' type='string'> +{/*> **country**: `string`*/} + +Defined in: [interfaces/models/screen.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L51) + +The country name + +</ParamField> + +### country\_code + +> **country\_code**: `string` + +Defined in: [interfaces/models/screen.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L53) + +The country code (e.g. 'US', 'GB') + + +### phone\_prefix + +> **phone\_prefix**: `string` + +Defined in: [interfaces/models/screen.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L55) + +The phone prefix (e.g. '+1', '+44') \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers.mdx new file mode 100644 index 000000000..e4e7ea122 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers.mdx @@ -0,0 +1,22 @@ +--- +title: "PromptMembers" +--- + +Defined in: [interfaces/models/prompt.ts:5](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/prompt.ts#L5) + + +<RequestExample> +```ts +export interface PromptMembers { + name: string; +} +``` +</RequestExample> + +## Properties + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/prompt.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/prompt.ts#L6) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.mdx new file mode 100644 index 000000000..d4c0e588e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.mdx @@ -0,0 +1,176 @@ +--- +title: "RedeemTicketMembers" +--- + +Defined in: [interfaces/screens/redeem-ticket.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L12) + +Interface describing the data available on the Redeem Ticket screen. + + +<RequestExample> +```ts +export interface RedeemTicketMembers extends BaseMembers { + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + transaction: TransactionMembers; + + /** + * Performs the default action on the redeem-ticket screen, which usually involves continuing the flow. + * @param {CustomOptions} [payload] - Optional custom options to include with the request. + * @returns {Promise<void>} A promise that resolves when the action is complete. + * @throws {Error} If the operation fails. + * @example + * ```typescript + * import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; + * + * const redeemTicket = new RedeemTicket(); + * await redeemTicket.continue(); + * ``` + */ + continue(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/screens/redeem-ticket.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L13) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/screens/redeem-ticket.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L14) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/screens/redeem-ticket.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L15) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/screens/redeem-ticket.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L16) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/screens/redeem-ticket.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L17) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/redeem-ticket.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L32) + +Performs the default action on the redeem-ticket screen, which usually involves continuing the flow. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is complete. + +#### Throws + +If the operation fails. + +#### Example + +```typescript +import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; + +const redeemTicket = new RedeemTicket(); +await redeemTicket.continue(); +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions.mdx new file mode 100644 index 000000000..38166dd5c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions.mdx @@ -0,0 +1,40 @@ +--- +title: "ReportBrowserErrorOptions" +--- + +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L37) + +ReportBrowserErrorOptions + + +<RequestExample> +```ts +export interface ReportBrowserErrorOptions { + /** + * @property {object} error - The error object from the WebAuthn API. + * @property {string} error.name - The name of the error (e.g., "NotAllowedError"). + * @property {string} error.message - The detailed error message. + */ + error: { + name: string; + message: string; + }; +} +``` +</RequestExample> + +## Properties + +<ParamField body='error' type='object'> +{/*> **error**: `object`*/} + +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L43) + +#### message + +{/*> **message**: `string`*/} + +#### name + +{/*> **name**: `string`*/} +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions.mdx new file mode 100644 index 000000000..9cc3ab9c5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "ResendCodeOptions" +--- + +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L29) + +Options for resending the email code. + + +<RequestExample> +```ts +export interface ResendCodeOptions { + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload.mdx new file mode 100644 index 000000000..a4723725b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload.mdx @@ -0,0 +1,25 @@ +--- +title: "ResendCodeOptionsPayload" +--- + +Defined in: [interfaces/screens/login-email-verification.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L30) + +ResendCodeOptions +description Options for the `resendCode` method on the Login Email Verification screen. +This operation is used when the user requests a new verification code to be sent to their email, +for instance, if they did not receive the initial code or if it has expired. + + +<RequestExample> +```ts +export interface ResendCodeOptions extends CustomOptions {} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions.mdx new file mode 100644 index 000000000..2185a5454 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "ResendCodePayloadOptions" +--- + +Defined in: [interfaces/screens/mfa-email-challenge.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L41) + +Options for resending the email code + + +<RequestExample> +```ts +export interface ResendCodeOptions { + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl.mdx new file mode 100644 index 000000000..508457b45 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl.mdx @@ -0,0 +1,27 @@ +--- +title: "ResendControl" +--- + +Defined in: [interfaces/utils/resend-control.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L20) + +Control object returned by resendManager method + + +<RequestExample> +```ts +export interface ResendControl { + startResend: () => void; +} +``` +</RequestExample> + +## Properties + +<ParamField body='Returns' type='unknown'>{/*> **startResend**: () => `void`*/} + +Defined in: [interfaces/utils/resend-control.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L21) + +< +`void` + +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.mdx new file mode 100644 index 000000000..d602a8b7a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.mdx @@ -0,0 +1,137 @@ +--- +title: "ResetPasswordEmailMembers" +--- + +Defined in: [interfaces/screens/reset-password-email.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L19) + + +<RequestExample> +```ts +export interface ResetPasswordEmailMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordEmail; + resendEmail(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail">ScreenMembersOnResetPasswordEmail</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordEmail`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail)*/} + +Defined in: [interfaces/screens/reset-password-email.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L20) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='resendEmail' type='Promise<void>'> +{/*> **resendEmail**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-email.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L21) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailOptions.mdx new file mode 100644 index 000000000..6c4a9bb7d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailOptions.mdx @@ -0,0 +1,18 @@ +--- +title: "ResetPasswordEmailOptions" +--- + +Defined in: [interfaces/screens/reset-password-email.ts:5](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L5) + + +<RequestExample> +```ts +export interface ResetPasswordEmailOptions { + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.mdx new file mode 100644 index 000000000..a70328335 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.mdx @@ -0,0 +1,118 @@ +--- +title: "ResetPasswordErrorMembers" +--- + +Defined in: [interfaces/screens/reset-password-error.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts#L14) + + +<RequestExample> +```ts +export interface ResetPasswordErrorMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordError; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError">ScreenMembersOnResetPasswordError</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError)*/} + +Defined in: [interfaces/screens/reset-password-error.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts#L15) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.mdx new file mode 100644 index 000000000..25e736b2f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.mdx @@ -0,0 +1,156 @@ +--- +title: "ResetPasswordMembers" +--- + +Defined in: [interfaces/screens/reset-password.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L22) + + +<RequestExample> +```ts +export interface ResetPasswordMembers extends BaseMembers { + screen: ScreenMembersOnResetPassword; + transaction: TransactionMembersOnResetPassword; + resetPassword(payload: ResetPasswordOptions): Promise<void>; + validatePassword(password: string): PasswordValidationResult; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword">ScreenMembersOnResetPassword</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword)*/} + +Defined in: [interfaces/screens/reset-password.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L23) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword">TransactionMembersOnResetPassword</a></span>}> +{/*> **transaction**: [`TransactionMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword)*/} + +Defined in: [interfaces/screens/reset-password.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L24) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='resetPassword' type='Promise<void>'> +{/*> **resetPassword**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L25) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions">ResetPasswordOptions</a></span>}> +[`ResetPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='validatePassword' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> +{/*> **validatePassword**(`password`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult)*/} + +Defined in: [interfaces/screens/reset-password.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L26) + +<Expandable title="Parameters"> +<ParamField body='password' type='string'> +`string` +</ParamField> +</Expandable> + +#### Returns + +[`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx new file mode 100644 index 000000000..8896af54b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx @@ -0,0 +1,229 @@ +--- +title: "ResetPasswordMfaEmailChallengeMembers" +--- + +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L45) + +Interface defining the available methods and properties for the reset-password-mfa-email-challenge screen + + +<RequestExample> +```ts +export interface ResetPasswordMfaEmailChallengeMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordMfaEmailChallenge; + + /** + * Continues with the email challenge using the provided code. + * @param payload The options containing the code and rememberDevice flag. + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Resends the email code. + * @param payload Optional custom options to include with the request. + */ + resendCode(payload?: ResendCodeOptions): Promise<void>; + + /** + * Allows the user to try another MFA method. + * @param payload Optional custom options to include with the request. + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; + + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge">ScreenMembersOnResetPasswordMfaEmailChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge)*/} + +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L46) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L52) + +Continues with the email challenge using the provided code. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions">ContinueOptions</a></span>}> +[`ContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions) + +The options containing the code and rememberDevice flag. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L58) + +Resends the email code. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions">ResendCodeOptions</a></span>}> +[`ResendCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:70](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L70) + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L64) + +Allows the user to try another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> +[`TryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx new file mode 100644 index 000000000..d562d7e2d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "ResetPasswordMfaOtpChallengeContinueOptions" +--- + +Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L6) + +Options for continuing with the OTP challenge. + + +<RequestExample> +```ts +export interface ContinueOptions { + /** The code entered by the user. */ + code: string; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L8) + +The code entered by the user. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx new file mode 100644 index 000000000..2bad107bf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx @@ -0,0 +1,172 @@ +--- +title: "ResetPasswordMfaOtpChallengeMembers" +--- + +Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L24) + +Interface defining the available methods and properties for the reset-password-mfa-otp-challenge screen + + +<RequestExample> +```ts +export interface ResetPasswordMfaOtpChallengeMembers extends BaseMembers { + /** + * Continues with the OTP challenge using the provided code. + * @param payload The options containing the code. + */ + continue(payload: ContinueOptions): Promise<void>; + /** + * Allows the user to try another MFA method. + * @param payload Optional custom options to include with the request. + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L29) + +Continues with the OTP challenge using the provided code. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions">ResetPasswordMfaOtpChallengeContinueOptions</a></span>}> +[`ResetPasswordMfaOtpChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions) + +The options containing the code. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L34) + +Allows the user to try another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions">ResetPasswordMfaOtpChallengeTryAnotherMethodOptions</a></span>}> +[`ResetPasswordMfaOtpChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..3e39591c2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "ResetPasswordMfaOtpChallengeTryAnotherMethodOptions" +--- + +Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L16) + +Options for trying another method. + + +<RequestExample> +```ts +export interface TryAnotherMethodOptions { + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx new file mode 100644 index 000000000..f28a709ab --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx @@ -0,0 +1,42 @@ +--- +title: "ResetPasswordMfaPhoneChallengeContinueOptions" +--- + +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L32) + +ContinueOptions + + +<RequestExample> +```ts +export interface ContinueOptions extends CustomOptions { + /** + * The delivery method selected by the user for receiving the verification code. + * - `sms`: Send the code via text message. + * - `voice`: Send the code via a voice call. + * @type {'sms' | 'voice'} + */ + type: 'sms' | 'voice'; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='type' type='"sms"'> +{/*> **type**: `"sms"` \| `"voice"`*/} + +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L39) + +The delivery method selected by the user for receiving the verification code. +- `sms`: Send the code via text message. +- `voice`: Send the code via a voice call. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx new file mode 100644 index 000000000..397fe8c09 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx @@ -0,0 +1,289 @@ +--- +title: "ResetPasswordMfaPhoneChallengeMembers" +--- + +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:67](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L67) + +ResetPasswordMfaPhoneChallengeMembers + + +<RequestExample> +```ts +export interface ResetPasswordMfaPhoneChallengeMembers extends BaseMembers { + /** + * Access to client-specific information (e.g., client ID, name). + * @type {ClientMembers} + */ + client: ClientMembers; + + /** + * Access to organization-specific information, if applicable. + * @type {OrganizationMembers} + */ + organization: OrganizationMembers; + + /** + * Access to prompt details (e.g., prompt name). + * @type {PromptMembers} + */ + prompt: PromptMembers; + + /** + * Access to the specific properties and data of the 'reset-password-mfa-phone-challenge' screen. + * @type {ScreenMembersOnResetPasswordMfaPhoneChallenge} + */ + screen: ScreenMembersOnResetPasswordMfaPhoneChallenge; + + /** + * Access to the current transaction details (e.g., state, errors). + * @type {TransactionMembers} + */ + transaction: TransactionMembers; + + /** + * Sends the verification code to the user's phone via the specified method (SMS or Voice). + * This action corresponds to the user clicking the "Send Code via SMS" or "Send Code via Voice Call" button. + * It triggers the Auth0 backend to initiate the code delivery process. + * + * @param {ContinueOptions} payload - The options specifying the delivery type ('sms' or 'voice') and any custom data. + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted to the server. + * @throws {Error} Throws an error if the submission fails (e.g., network issue, invalid state). + * @example + * ```typescript + * import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; + * + * const screen = new ResetPasswordMfaPhoneChallenge(); + * + * // Send code via SMS + * await screen.continue({ type: 'sms' }); + * + * // Send code via Voice Call + * await screen.continue({ type: 'voice' }); + * ``` + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Navigates the user to the screen where they can select an alternative MFA method. + * This action corresponds to the user clicking a "Try Another Method" button. + * + * @param {TryAnotherMethodOptions} payload - The options specifying the current challenge type (`sms` or `voice`) and any custom data. The `type` field is necessary to inform the backend which flow the user is navigating away from. + * @returns {Promise<void>} A promise that resolves when the action is successfully submitted to the server. + * @throws {Error} Throws an error if the submission fails. + * @example + * ```typescript + * import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; + * + * const screen = new ResetPasswordMfaPhoneChallenge(); + * + * // If the user was presented with SMS option initially: + * await screen.tryAnotherMethod({ type: 'sms' }); + * + * // If the user was presented with Voice option initially: + * await screen.tryAnotherMethod({ type: 'voice' }); + * ``` + */ + tryAnotherMethod(payload: TryAnotherMethodOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:72](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L72) + +Access to client-specific information (e.g., client ID, name). + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:78](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L78) + +Access to organization-specific information, if applicable. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L84) + +Access to prompt details (e.g., prompt name). + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge">ScreenMembersOnResetPasswordMfaPhoneChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge)*/} + +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:90](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L90) + +Access to the specific properties and data of the 'reset-password-mfa-phone-challenge' screen. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:96](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L96) + +Access to the current transaction details (e.g., state, errors). + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:119](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L119) + +Sends the verification code to the user's phone via the specified method (SMS or Voice). +This action corresponds to the user clicking the "Send Code via SMS" or "Send Code via Voice Call" button. +It triggers the Auth0 backend to initiate the code delivery process. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions">ResetPasswordMfaPhoneChallengeContinueOptions</a></span>}> +[`ResetPasswordMfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions) + +The options specifying the delivery type ('sms' or 'voice') and any custom data. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted to the server. + +#### Throws + +Throws an error if the submission fails (e.g., network issue, invalid state). + +#### Example + +```typescript +import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; + +const screen = new ResetPasswordMfaPhoneChallenge(); + +// Send code via SMS +await screen.continue({ type: 'sms' }); + +// Send code via Voice Call +await screen.continue({ type: 'voice' }); +``` + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:141](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L141) + +Navigates the user to the screen where they can select an alternative MFA method. +This action corresponds to the user clicking a "Try Another Method" button. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions">ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions</a></span>}> +[`ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions) + +The options specifying the current challenge type (`sms` or `voice`) and any custom data. The `type` field is necessary to inform the backend which flow the user is navigating away from. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted to the server. + +#### Throws + +Throws an error if the submission fails. + +#### Example + +```typescript +import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; + +const screen = new ResetPasswordMfaPhoneChallenge(); + +// If the user was presented with SMS option initially: +await screen.tryAnotherMethod({ type: 'sms' }); + +// If the user was presented with Voice option initially: +await screen.tryAnotherMethod({ type: 'voice' }); +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..1598949bc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,44 @@ +--- +title: "ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions" +--- + +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L49) + +TryAnotherMethodOptions + + +<RequestExample> +```ts +export interface TryAnotherMethodOptions extends CustomOptions { + /** + * The delivery method that was initially presented or selected on the current screen. + * This is required by the API endpoint to correctly process the 'pick-authenticator' action. + * - `sms`: Indicates the current screen was for SMS challenge. + * - `voice`: Indicates the current screen was for Voice challenge. + * @type {'sms' | 'voice'} + */ + type: 'sms' | 'voice'; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='type' type='"sms"'> +{/*> **type**: `"sms"` \| `"voice"`*/} + +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L57) + +The delivery method that was initially presented or selected on the current screen. +This is required by the API endpoint to correctly process the 'pick-authenticator' action. +- `sms`: Indicates the current screen was for SMS challenge. +- `voice`: Indicates the current screen was for Voice challenge. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx new file mode 100644 index 000000000..8d111f28e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx @@ -0,0 +1,256 @@ +--- +title: "ResetPasswordMfaPushChallengePushMembers" +--- + +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L23) + +Interface defining the available methods and properties for the reset-password-mfa-push-challenge-push screen + + +<RequestExample> +```ts +export interface ResetPasswordMfaPushChallengePushMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordMfaPushChallengePush; + + /** + * Continues with the push notification challenge + * @param payload Optional custom options to include with the request + */ + continue(payload?: CustomOptions): Promise<void>; + + /** + * Resends the push notification + * @param payload Optional custom options to include with the request + */ + resendPushNotification(payload?: CustomOptions): Promise<void>; + + /** + * Switches to entering the verification code manually + * @param payload Optional custom options to include with the request + */ + enterCodeManually(payload?: CustomOptions): Promise<void>; + + /** + * Allows trying another authentication method + * @param payload Optional custom options to include with the request + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + + /** + * Allows polling for the push notification challenge to be approved. + * @param options of type {@link MfaPollingOptions} + */ + pollingManager(options?: MfaPollingOptions): MfaPushPollingControl; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush">ScreenMembersOnResetPasswordMfaPushChallengePush</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush)*/} + +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L24) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L30) + +Continues with the push notification challenge + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='enterCodeManually' type='Promise<void>'> +{/*> **enterCodeManually**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L42) + +Switches to entering the verification code manually + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='pollingManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> +{/*> **pollingManager**(`options?`): [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl)*/} + +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L54) + +Allows polling for the push notification challenge to be approved. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions">MfaPollingOptions</a></span>}> +[`MfaPollingOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions) + +of type [MfaPollingOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions) +</ParamField> +</Expandable> + +#### Returns + +[`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) + +</ParamField> + +<ParamField body='resendPushNotification' type='Promise<void>'> +{/*> **resendPushNotification**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L36) + +Resends the push notification + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L48) + +Allows trying another authentication method + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx new file mode 100644 index 000000000..9f173aa8f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx @@ -0,0 +1,187 @@ +--- +title: "ResetPasswordMfaRecoveryCodeChallengeMembers" +--- + +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L12) + +Interface describing the members of the Mfa Recovery Code Challenge screen. + + +<RequestExample> +```ts +export interface ResetPasswordMfaRecoveryCodeChallengeMembers extends BaseMembers { + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + transaction: TransactionMembers; + + /** + * Continues with the provided recovery code. + * @param {string} code - The recovery code entered by the user. + * @param {CustomOptions} [payload] - Optional payload. + * @returns {Promise<void>} + */ + continue(code: string, payload?: CustomOptions): Promise<void>; + + /** + * Navigates to the screen where the user can pick another MFA method. + * @param {CustomOptions} [payload] - Optional payload. + * @returns {Promise<void>} + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L13) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L14) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L15) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L16) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L17) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`code`, `payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L25) + +Continues with the provided recovery code. + +<Expandable title="Parameters"> +<ParamField body='code' type='string'> +`string` + +The recovery code entered by the user. +</ParamField> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L32) + +Navigates to the screen where the user can pick another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx new file mode 100644 index 000000000..784b9ed09 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx @@ -0,0 +1,217 @@ +--- +title: "ResetPasswordMfaSmsChallengeMembers" +--- + +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L21) + + +<RequestExample> +```ts +export interface ResetPasswordMfaSmsChallengeMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordMfaSmsChallenge; + continueMfaSmsChallenge(payload: MfaSmsChallengeOptions): Promise<void>; + resendCode(payload?: CustomOptions): Promise<void>; + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + getACall(payload?: CustomOptions): Promise<void>; + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge">ScreenMembersOnResetPasswordMfaSmsChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge)*/} + +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L22) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continueMfaSmsChallenge' type='Promise<void>'> +{/*> **continueMfaSmsChallenge**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L23) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions">ResetPasswordMfaSmsChallengeOptions</a></span>}> +[`ResetPasswordMfaSmsChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='getACall' type='Promise<void>'> +{/*> **getACall**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L26) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L24) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L31) + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L25) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx new file mode 100644 index 000000000..3403c1de4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "ResetPasswordMfaSmsChallengeOptions" +--- + +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L6) + + +<RequestExample> +```ts +export interface MfaSmsChallengeOptions { + code: string; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L7) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx new file mode 100644 index 000000000..433791645 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx @@ -0,0 +1,37 @@ +--- +title: "ResetPasswordMfaVoiceChallengeContinueOptions" +--- + +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L26) + +Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers. + + +<RequestExample> +```ts +export interface ContinueOptions extends CustomOptions { + /** + * The OTP code entered by the user. + */ + code: string; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L30) + +The OTP code entered by the user. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx new file mode 100644 index 000000000..ea22432ef --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx @@ -0,0 +1,285 @@ +--- +title: "ResetPasswordMfaVoiceChallengeMembers" +--- + +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L36) + +Interface defining the available methods and properties for the reset-password-mfa-voice-challenge screen. + + +<RequestExample> +```ts +export interface ResetPasswordMfaVoiceChallengeMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordMfaVoiceChallenge; + + /** + * Continues with the voice challenge using the provided code. + * + * @param payload - The options containing the code. + * @returns A promise that resolves when the challenge is submitted. + * + * @example + * ```ts + * const reset = new ResetPasswordMfaVoiceChallenge(); + * await reset.continue({ code: '123456' }); + * ``` + */ + continue(payload: ContinueOptions): Promise<void>; + + /** + * Switches to SMS verification. + * + * @param payload - Optional custom options to include with the request. + * @returns A promise that resolves when the action completes. + */ + switchToSms(payload?: CustomOptions): Promise<void>; + + /** + * Re-sends the code via voice call. + * + * @param payload - Optional custom options to include with the request. + * @returns A promise that resolves when the code is resent. + */ + resendCode(payload?: CustomOptions): Promise<void>; + + /** + * Allows the user to try another MFA method. + * + * @param payload - Optional custom options to include with the request. + * @returns A promise that resolves when the request is submitted. + */ + tryAnotherMethod(payload?: CustomOptions): Promise<void>; + + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge">ScreenMembersOnResetPasswordMfaVoiceChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge)*/} + +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L37) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continue' type='Promise<void>'> +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L51) + +Continues with the voice challenge using the provided code. + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions">ResetPasswordMfaVoiceChallengeContinueOptions</a></span>}> +[`ResetPasswordMfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions) + +The options containing the code. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the challenge is submitted. + +#### Example + +```ts +const reset = new ResetPasswordMfaVoiceChallenge(); +await reset.continue({ code: '123456' }); +``` + +</ParamField> + +<ParamField body='resendCode' type='Promise<void>'> +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:67](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L67) + +Re-sends the code via voice call. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the code is resent. + +</ParamField> + +<ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> +{/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} + +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L81) + +Gets resend functionality with timeout management for this screen + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality +</ParamField> +</Expandable> + +#### Returns + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +</ParamField> + +<ParamField body='switchToSms' type='Promise<void>'> +{/*> **switchToSms**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L59) + +Switches to SMS verification. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the action completes. + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:75](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L75) + +Allows the user to try another MFA method. + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the request is submitted. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx new file mode 100644 index 000000000..44537c0be --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx @@ -0,0 +1,41 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions" +--- + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L58) + +ContinueWithPasskeyOptions + + +<RequestExample> +```ts +export interface ContinueWithPasskeyOptions extends CustomOptions { + /** + * Optional. If true, and if `screen.showRememberDevice` is also true, + * this signals the server to remember this browser for MFA for a defined period. + * @type {boolean | undefined} + */ + rememberDevice?: boolean; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='rememberDevice?' type='boolean'> +{/*> `optional` **rememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L64) + +Optional. If `true` and `screen.showRememberDevice` is also `true`, + this indicates the user has opted to remember the current browser, + potentially skipping MFA for a period. Corresponds to the `rememberBrowser` form field. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx new file mode 100644 index 000000000..476ff01ad --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx @@ -0,0 +1,348 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallengeMembers" +--- + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:115](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L115) + +ResetPasswordMfaWebAuthnPlatformChallengeMembers + + +<RequestExample> +```ts +export interface ResetPasswordMfaWebAuthnPlatformChallengeMembers extends BaseMembers { + /** + * Access to the specific properties and data of the 'reset-password-mfa-webauthn-platform-challenge' screen. + * @type {ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge} + */ + screen: ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge; + + /** + * Initiates the WebAuthn platform authenticator challenge by calling `navigator.credentials.get()` + * using the challenge options provided in `screen.publicKey`. + * If successful, it submits the resulting credential assertion to Auth0 with `action: "default"`. + * + * @param {ContinueWithPasskeyOptions} [options] - Optional parameters for the verification process, + * such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. + * @returns {Promise<void>} A promise that resolves when the verification attempt is submitted. + * A successful operation typically results in a redirect. + * @throws {Error} Throws an error if `screen.publicKey` is missing, + * if `navigator.credentials.get()` fails (e.g., user cancellation `NotAllowedError`), + * or if the form submission to Auth0 fails. If `navigator.credentials.get()` fails + * with a `DOMException`, it's recommended to catch that error and call `reportBrowserError`. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge + * try { + * await sdk.continueWithPasskey({ + * rememberDevice: true // if user checked the box and sdk.screen.showRememberDevice is true + * }); + * // On success, Auth0 handles redirection. + * } catch (error) { + * console.error("Platform authenticator verification failed:", error); + * // If it's a WebAuthn API error (DOMException), report it + * if (error instanceof DOMException && error.name && error.message) { + * await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + * } + * // Check sdk.transaction.errors for server-side validation messages if the page reloads. + * } + * ``` + */ + continueWithPasskey(options?: ContinueWithPasskeyOptions): Promise<void>; + + /** + * Reports a browser-side error that occurred during the `navigator.credentials.get()` API call. + * This is used to inform Auth0 about issues like user cancellation, timeout, or unsupported hardware. + * It submits the error details with `action: "showError::{errorDetailsJsonString}"`. + * + * @param {ReportBrowserErrorOptions} options - Contains the `error` object (with `name` and `message` + * from the WebAuthn API DOMException) and any custom options. + * @returns {Promise<void>} A promise that resolves when the error report is submitted. + * @throws {Error} If the form submission fails (e.g., network error). + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge + * // and 'webAuthnError' is a DOMException from a failed navigator.credentials.get() call. + * try { + * await sdk.reportBrowserError({ + * error: { name: webAuthnError.name, message: webAuthnError.message } + * }); + * // Auth0 may re-render the page or redirect based on the error. + * } catch (submitError) { + * console.error("Failed to report WebAuthn browser error:", submitError); + * } + * ``` + */ + reportBrowserError(options: ReportBrowserErrorOptions): Promise<void>; + + /** + * Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. + * This action submits `action: "pick-authenticator"` to Auth0, which should navigate + * the user to an MFA factor selection screen for the password reset flow. + * + * @param {TryAnotherMethodOptions} [options] - Optional. Any custom parameters to be sent with the request. + * @returns {Promise<void>} A promise that resolves when the 'pick-authenticator' action is submitted. + * @throws {Error} If the form submission fails. + * + * @example + * ```typescript + * // Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge + * try { + * await sdk.tryAnotherMethod(); + * // On success, Auth0 handles redirection to MFA selection. + * } catch (error) { + * console.error("Failed to switch MFA method:", error); + * } + * ``` + */ + tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge">ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge)*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:120](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L120) + +Access to the specific properties and data of the 'reset-password-mfa-webauthn-platform-challenge' screen. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='continueWithPasskey' type='Promise<void>'> +{/*> **continueWithPasskey**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:154](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L154) + +Initiates the WebAuthn platform authenticator challenge by calling `navigator.credentials.get()` +using the challenge options provided in `screen.publicKey`. +If successful, it submits the resulting credential assertion to Auth0 with `action: "default"`. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions">ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions</a></span>}> +[`ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions) + +Optional parameters for the verification process, +such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the verification attempt is submitted. + A successful operation typically results in a redirect. + +#### Throws + +Throws an error if `screen.publicKey` is missing, + if `navigator.credentials.get()` fails (e.g., user cancellation `NotAllowedError`), + or if the form submission to Auth0 fails. If `navigator.credentials.get()` fails + with a `DOMException`, it's recommended to catch that error and call `reportBrowserError`. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge +try { + await sdk.continueWithPasskey({ + rememberDevice: true // if user checked the box and sdk.screen.showRememberDevice is true + }); + // On success, Auth0 handles redirection. +} catch (error) { + console.error("Platform authenticator verification failed:", error); + // If it's a WebAuthn API error (DOMException), report it + if (error instanceof DOMException && error.name && error.message) { + await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + } + // Check sdk.transaction.errors for server-side validation messages if the page reloads. +} +``` + +</ParamField> + +<ParamField body='reportBrowserError' type='Promise<void>'> +{/*> **reportBrowserError**(`options`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:180](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L180) + +Reports a browser-side error that occurred during the `navigator.credentials.get()` API call. +This is used to inform Auth0 about issues like user cancellation, timeout, or unsupported hardware. +It submits the error details with `action: "showError::{errorDetailsJsonString}"`. + +<Expandable title="Parameters"> +<ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions">ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions</a></span>}> +[`ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions) + +Contains the `error` object (with `name` and `message` + from the WebAuthn API DOMException) and any custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the error report is submitted. + +#### Throws + +If the form submission fails (e.g., network error). + +#### Example + +```typescript +// Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge +// and 'webAuthnError' is a DOMException from a failed navigator.credentials.get() call. +try { + await sdk.reportBrowserError({ + error: { name: webAuthnError.name, message: webAuthnError.message } + }); + // Auth0 may re-render the page or redirect based on the error. +} catch (submitError) { + console.error("Failed to report WebAuthn browser error:", submitError); +} +``` + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:202](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L202) + +Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. +This action submits `action: "pick-authenticator"` to Auth0, which should navigate +the user to an MFA factor selection screen for the password reset flow. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions">ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions</a></span>}> +[`ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions) + +Optional. Any custom parameters to be sent with the request. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the 'pick-authenticator' action is submitted. + +#### Throws + +If the form submission fails. + +#### Example + +```typescript +// Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge +try { + await sdk.tryAnotherMethod(); + // On success, Auth0 handles redirection to MFA selection. +} catch (error) { + console.error("Failed to switch MFA method:", error); +} +``` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx new file mode 100644 index 000000000..a659c8728 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx @@ -0,0 +1,33 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions" +--- + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:77](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L77) + +ReportBrowserErrorOptions + + +<RequestExample> +```ts +export interface ReportBrowserErrorOptions { + /** + * The error object from the WebAuthn API. This typically is a `DOMException`. + * The SDK expects an object with at least `name` and `message` properties. + * @type {WebAuthnErrorDetails} + * @example { name: "NotAllowedError", message: "The operation was cancelled by the user." } + */ + error: WebAuthnErrorDetails; +} +``` +</RequestExample> + +## Properties + +<ParamField body='error' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>}> +{/*> **error**: [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails)*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L84) + +The error object from the WebAuthn API (`navigator.credentials.get()`) + to be reported. Must include `name` and `message`. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..335b31fb4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,25 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions" +--- + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:94](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L94) + +TryAnotherMethodOptions + + +<RequestExample> +```ts +export interface TryAnotherMethodOptions extends CustomOptions { + // Currently, no specific properties beyond CustomOptions are defined for this action. + // This interface is here for future extensibility. +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx new file mode 100644 index 000000000..666a2e627 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx @@ -0,0 +1,274 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallengeMembers" +--- + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:145](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L145) + +ResetPasswordMfaWebAuthnRoamingChallengeMembers + + +<RequestExample> +```ts +export interface ResetPasswordMfaWebAuthnRoamingChallengeMembers extends BaseMembers { + + /** + * Access to the specific properties and data of the `reset-password-mfa-webauthn-roaming-challenge` screen, + * including WebAuthn `publicKey` challenge options and the `showRememberDevice` flag. + * @type {ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge} + */ + screen: ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge; + + /** + * Initiates the WebAuthn assertion process (security key challenge). + * This method will internally call `navigator.credentials.get()` using the challenge + * provided in `screen.publicKey`. + * On successful interaction with the security key, it submits the resulting + * `PublicKeyCredential` to Auth0 with `action: "default"`. + * + * @param {UseSecurityKeyOptions} [options] - Optional. Parameters for the operation, + * such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. + * The `response` field (the WebAuthn credential) is handled internally by the SDK. + * @returns {Promise<void>} A promise that resolves when the verification attempt is submitted. + * A successful operation typically results in a redirect by Auth0. + * @throws {Error} Throws an error if `screen.publicKey` is missing, if `navigator.credentials.get()` + * fails (e.g., user cancellation, no authenticator found), or if the form submission to Auth0 fails. + * It's recommended to catch these errors and potentially use `showError()` to report WebAuthn API specific issues. + */ + useSecurityKey(options?: UseSecurityKeyOptions): Promise<void>; + + /** + * Reports a client-side WebAuthn API error (from `navigator.credentials.get()`) to Auth0. + * This method should be used when `useSecurityKey()` (or a manual `navigator.credentials.get()` call) + * fails due to a browser-side WebAuthn issue (e.g., `NotAllowedError` if the user cancels the prompt, + * `NotFoundError` if no matching authenticator is found, or a timeout). + * It submits the error details with `action: "showError::{errorDetailsJsonString}"` and an empty `response`. + * + * @param {ShowErrorOptions} options - Contains the `error` object (with `name` and `message` + * from the WebAuthn API DOMException), an optional `rememberDevice` flag, and any other custom options. + * @returns {Promise<void>} A promise that resolves when the error report is submitted. + * Auth0 may re-render the page with error information or redirect. + * @throws {Error} Throws an error if the form submission fails (e.g., network error, invalid state). + */ + showError(options: ShowErrorOptions): Promise<void>; + + /** + * Allows the user to opt-out of the WebAuthn roaming challenge and select a different MFA method. + * This action submits `action: "pick-authenticator"` to Auth0, which should navigate + * the user to an MFA factor selection screen. + * + * @param {TryAnotherMethodOptions} [options] - Optional. Parameters for the operation, + * such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. + * @returns {Promise<void>} A promise that resolves when the 'pick-authenticator' action is submitted. + * @throws {Error} Throws an error if the form submission fails. + */ + tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void>; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge">ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge)*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:152](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L152) + +Access to the specific properties and data of the `reset-password-mfa-webauthn-roaming-challenge` screen, +including WebAuthn `publicKey` challenge options and the `showRememberDevice` flag. + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='showError' type='Promise<void>'> +{/*> **showError**(`options`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:185](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L185) + +Reports a client-side WebAuthn API error (from `navigator.credentials.get()`) to Auth0. +This method should be used when `useSecurityKey()` (or a manual `navigator.credentials.get()` call) +fails due to a browser-side WebAuthn issue (e.g., `NotAllowedError` if the user cancels the prompt, +`NotFoundError` if no matching authenticator is found, or a timeout). +It submits the error details with `action: "showError::{errorDetailsJsonString}"` and an empty `response`. + +<Expandable title="Parameters"> +<ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions">ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions</a></span>}> +[`ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions) + +Contains the `error` object (with `name` and `message` +from the WebAuthn API DOMException), an optional `rememberDevice` flag, and any other custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the error report is submitted. +Auth0 may re-render the page with error information or redirect. + +#### Throws + +Throws an error if the form submission fails (e.g., network error, invalid state). + +</ParamField> + +<ParamField body='tryAnotherMethod' type='Promise<void>'> +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:197](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L197) + +Allows the user to opt-out of the WebAuthn roaming challenge and select a different MFA method. +This action submits `action: "pick-authenticator"` to Auth0, which should navigate +the user to an MFA factor selection screen. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions">ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions</a></span>}> +[`ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions) + +Optional. Parameters for the operation, +such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the 'pick-authenticator' action is submitted. + +#### Throws + +Throws an error if the form submission fails. + +</ParamField> + +<ParamField body='useSecurityKey' type='Promise<void>'> +{/*> **useSecurityKey**(`options?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L170) + +Initiates the WebAuthn assertion process (security key challenge). +This method will internally call `navigator.credentials.get()` using the challenge +provided in `screen.publicKey`. +On successful interaction with the security key, it submits the resulting +`PublicKeyCredential` to Auth0 with `action: "default"`. + +<Expandable title="Parameters"> +<ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions">ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions</a></span>}> +[`ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions) + +Optional. Parameters for the operation, +such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. +The `response` field (the WebAuthn credential) is handled internally by the SDK. +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves when the verification attempt is submitted. +A successful operation typically results in a redirect by Auth0. + +#### Throws + +Throws an error if `screen.publicKey` is missing, if `navigator.credentials.get()` +fails (e.g., user cancellation, no authenticator found), or if the form submission to Auth0 fails. +It's recommended to catch these errors and potentially use `showError()` to report WebAuthn API specific issues. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx new file mode 100644 index 000000000..e27553148 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx @@ -0,0 +1,51 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions" +--- + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:96](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L96) + +ShowErrorOptions + + +<RequestExample> +```ts +export interface ShowErrorOptions { + /** + * The error object captured from a failed `navigator.credentials.get()` call. + * This should include at least `name` and `message` properties of the DOMException. + * @type {WebAuthnErrorDetails} + * @example { name: "NotAllowedError", message: "The operation was aborted by the user." } + */ + error: WebAuthnErrorDetails; + + /** + * Optional. If `true`, and if the screen context (`screen.showRememberDevice`) + * indicates that remembering the device is an option, this signals the user's + * intent to remember this browser/device. + * @type {boolean | undefined} + */ + rememberDevice?: boolean; +} +``` +</RequestExample> + +## Properties + +<ParamField body='error' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>}> +{/*> **error**: [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails)*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:103](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L103) + +The error object from the WebAuthn API (`navigator.credentials.get()`) +containing `name` and `message` of the DOMException. + +</ParamField> + +<ParamField body='rememberDevice?' type='boolean'> +{/*> `optional` **rememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:111](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L111) + +Optional. If `true` and `screen.showRememberDevice` is also `true`, +the SDK will include `rememberBrowser=true` in the form submission. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx new file mode 100644 index 000000000..5116cd4ef --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,41 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions" +--- + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:123](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L123) + +TryAnotherMethodOptions + + +<RequestExample> +```ts +export interface TryAnotherMethodOptions extends CustomOptions { + /** + * Optional. If `true`, and if the screen context (`screen.showRememberDevice`) + * indicates that remembering the device is an option, this signals the user's + * intent to remember this browser/device. + * @type {boolean | undefined} + */ + rememberDevice?: boolean; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='rememberDevice?' type='boolean'> +{/*> `optional` **rememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:130](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L130) + +Optional. If `true` and `screen.showRememberDevice` is also `true`, +the SDK will include `rememberBrowser=true` in the form submission. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx new file mode 100644 index 000000000..27ff215c6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx @@ -0,0 +1,43 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions" +--- + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:74](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L74) + +UseSecurityKeyOptions + + +<RequestExample> +```ts +export interface UseSecurityKeyOptions extends CustomOptions { + /** + * Optional. If `true`, and if the screen context (`screen.showRememberDevice`) + * indicates that remembering the device is an option, this signals the user's + * intent to remember this browser/device for future authentications. + * The SDK will submit `rememberBrowser=true` in this case. + * @type {boolean | undefined} + */ + rememberDevice?: boolean; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='rememberDevice?' type='boolean'> +{/*> `optional` **rememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L82) + +Optional. If `true` and `screen.showRememberDevice` is also `true`, +the SDK will include `rememberBrowser=true` in the form submission, indicating the user's +choice to remember this device. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions.mdx new file mode 100644 index 000000000..826f40a41 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "ResetPasswordOptions" +--- + +Defined in: [interfaces/screens/reset-password.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L6) + + +<RequestExample> +```ts +export interface ResetPasswordOptions { + 'password-reset': string; + 're-enter-password': string; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +### password-reset + +> **password-reset**: `string` + +Defined in: [interfaces/screens/reset-password.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L7) + + +### re-enter-password + +> **re-enter-password**: `string` + +Defined in: [interfaces/screens/reset-password.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L8) \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.mdx new file mode 100644 index 000000000..b604d2673 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.mdx @@ -0,0 +1,168 @@ +--- +title: "ResetPasswordRequestMembers" +--- + +Defined in: [interfaces/screens/reset-password-request.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L27) + + +<RequestExample> +```ts +export interface ResetPasswordRequestMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordRequest; + transaction: TransactionMembersOnResetPasswordRequest; + resetPassword(payload: ResetPasswordRequestOptions): Promise<void>; + backToLogin(payload?: CustomOptions): Promise<void>; + getLoginIdentifiers(): IdentifierType[] | null; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest">ScreenMembersOnResetPasswordRequest</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest)*/} + +Defined in: [interfaces/screens/reset-password-request.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L28) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest">TransactionMembersOnResetPasswordRequest</a></span>}> +{/*> **transaction**: [`TransactionMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest)*/} + +Defined in: [interfaces/screens/reset-password-request.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L29) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='backToLogin' type='Promise<void>'> +{/*> **backToLogin**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-request.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L31) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='getLoginIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> +{/*> **getLoginIdentifiers**(): [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} + +Defined in: [interfaces/screens/reset-password-request.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L32) + +#### Returns + +[`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null` + +</ParamField> + +<ParamField body='resetPassword' type='Promise<void>'> +{/*> **resetPassword**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/reset-password-request.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L30) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions">ResetPasswordRequestOptions</a></span>}> +[`ResetPasswordRequestOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions.mdx new file mode 100644 index 000000000..0d9959303 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "ResetPasswordRequestOptions" +--- + +Defined in: [interfaces/screens/reset-password-request.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L7) + + +<RequestExample> +```ts +export interface ResetPasswordRequestOptions { + username: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='captcha?' type='string'> +{/*> `optional` **captcha**: `string`*/} + +Defined in: [interfaces/screens/reset-password-request.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L9) + +</ParamField> + +<ParamField body='username' type='string'> +{/*> **username**: `string`*/} + +Defined in: [interfaces/screens/reset-password-request.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L8) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.mdx new file mode 100644 index 000000000..374b5912a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.mdx @@ -0,0 +1,118 @@ +--- +title: "ResetPasswordSuccessMembers" +--- + +Defined in: [interfaces/screens/reset-password-success.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-success.ts#L14) + + +<RequestExample> +```ts +export interface ResetPasswordSuccessMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordSuccess; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess">ScreenMembersOnResetPasswordSuccess</a></span>}> +{/*> **screen**: [`ScreenMembersOnResetPasswordSuccess`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess)*/} + +Defined in: [interfaces/screens/reset-password-success.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-success.ts#L15) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope.mdx new file mode 100644 index 000000000..0349883ef --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope.mdx @@ -0,0 +1,30 @@ +--- +title: "Scope" +--- + +Defined in: [interfaces/models/screen.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L58) + + +<RequestExample> +```ts +export interface Scope { + value: string; + description?: string; +} +``` +</RequestExample> + +## Properties + +<ParamField body='description?' type='string'> +{/*> `optional` **description**: `string`*/} + +Defined in: [interfaces/models/screen.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L60) + +</ParamField> + +<ParamField body='value' type='string'> +{/*> **value**: `string`*/} + +Defined in: [interfaces/models/screen.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L59) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.mdx new file mode 100644 index 000000000..9fb9b495e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.mdx @@ -0,0 +1,145 @@ +--- +title: "ScreenMembers" +--- + +Defined in: [interfaces/models/screen.ts:80](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L80) + + +<RequestExample> +```ts +export interface ScreenMembers { + name: string; + captchaImage: string | null; + captchaSiteKey: string | null; + captchaProvider: string | null; + isCaptchaAvailable: boolean; + data: Record<string, string | boolean | string[] | Record<string, string[]> | Array<PhonePrefix> | PasskeyCreate> | null; + links: Record<string, string> | null; + texts: Record<string, string> | null; + captcha: CaptchaContext | null; +} +``` +</RequestExample> + +## Extended by + +- [`ScreenMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId) +- [`ScreenMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword) +- [`ScreenMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode) +- [`ScreenMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp) +- [`ScreenMembersOnPasskeyEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment) +- [`ScreenMembersOnPasskeyEnrollmentLocal`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal) +- [`ScreenMembersOnEmailIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge) +- [`ScreenMembersOnPhoneIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge) +- [`ScreenMembersOnPhoneIdentifierEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment) +- [`ScreenMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId) +- [`ScreenMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword) +- [`ScreenMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup) +- [`ScreenMembersOnResetPasswordEmail`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail) +- [`ScreenMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest) +- [`ScreenMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword) +- [`ScreenMembersOnResetPasswordError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError) +- [`ScreenMembersOnResetPasswordSuccess`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess) +- [`ScreenMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin) +- [`ScreenMembersOnMfaPushEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr) +- [`ScreenMembersOnMfaPushWelcome`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome) +- [`ScreenMembersOnMfaEnrollResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult) +- [`ScreenMembersOnMfaSmsEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment) +- [`ScreenMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge) +- [`ScreenMembersOnMfaCountryCodes`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes) +- [`ScreenMembersOnResetPasswordMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush) +- [`ScreenMembersOnResetPasswordMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge) +- [`ScreenMembersOnResetPasswordMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge) +- [`ScreenMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge) +- [`ScreenMembersOnMfaEmailList`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList) +- [`ScreenMembersOnMfaLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions) +- [`ScreenMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush) +- [`ScreenMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge) +- [`ScreenMembersOnMfaOtpEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr) +- [`ScreenMembersOnMfaOtpEnrollmentCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode) +- [`ScreenMembersOnOrganizationSelection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection) +- [`ScreenMembersOnAcceptInvitation`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation) +- [`ScreenMembersOnCustomizedConsent`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent) +- [`ScreenMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge) +- [`ScreenMembersOnResetPasswordMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge) +- [`ScreenMembersOnDeviceCodeConfirmation`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation) +- [`ScreenMembersOnMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge) +- [`ScreenMembersOnMfaRecoveryCodeEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment) +- [`ScreenMembersOnResetPasswordMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge) +- [`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode) +- [`ScreenMembersOnEmailOTPChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge) +- [`ScreenMembersOnEmailVerificationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult) +- [`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment) +- [`ScreenMembersOnMfaWebAuthnError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError) +- [`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment) +- [`ScreenMembersOnMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge) +- [`ScreenMembersOnMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge) +- [`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess) +- [`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname) +- [`ScreenMembersOnConsent`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent) +- [`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge) +- [`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation.mdx new file mode 100644 index 000000000..7395ec357 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation.mdx @@ -0,0 +1,121 @@ +--- +title: "ScreenMembersOnAcceptInvitation" +--- + +Defined in: [interfaces/screens/accept-invitation.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L9) + + +<RequestExample> +```ts +export interface ScreenMembersOnAcceptInvitation extends ScreenMembers { + data: { + inviter: string; + email: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='email'> +{/*> **data**: \{ `email`: `string`; `inviter`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/accept-invitation.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L10) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent.mdx new file mode 100644 index 000000000..05ca0078b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent.mdx @@ -0,0 +1,137 @@ +--- +title: "ScreenMembersOnConsent" +--- + +Defined in: [interfaces/screens/consent.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/consent.ts#L20) + +ScreenMembersOnConsent + + +<RequestExample> +```ts +export interface ScreenMembersOnConsent extends ScreenMembers { + scopes: Scope[]; + hideScopes: boolean; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +Screen-specific data. + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='hideScopes' type='boolean'> +{/*> **hideScopes**: `boolean`*/} + +Defined in: [interfaces/screens/consent.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/consent.ts#L22) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='scopes' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope">Scope</a></span>}> +{/*> **scopes**: [`Scope`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope)[]*/} + +Defined in: [interfaces/screens/consent.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/consent.ts#L21) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent.mdx new file mode 100644 index 000000000..87c81a676 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent.mdx @@ -0,0 +1,160 @@ +--- +title: "ScreenMembersOnCustomizedConsent" +--- + +Defined in: [interfaces/screens/customized-consent.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L19) + +ScreenMembersOnCustomizedConsent + + +<RequestExample> +```ts +export interface ScreenMembersOnCustomizedConsent extends ScreenMembers { + /** + * An array of `Scope` objects detailing each permission (scope) being requested. + * These are typically high-level permissions like 'read:profile' or 'openid'. + * This list should be displayed to the user for their review. + */ + scopes: Scope[]; + + /** + * An array of `AuthorizationDetail` objects. + * Each object provides granular details about specific data or + * actions the application wants to perform, potentially related to + * Rich Authorization Requests (RAR) or other fine-grained permission models. + * This list should be displayed to the user for their review. + */ + authorizationDetails: AuthorizationDetail[]; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='authorizationDetails' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail">AuthorizationDetail</a></span>}> +{/*> **authorizationDetails**: [`AuthorizationDetail`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail)[]*/} + +Defined in: [interfaces/screens/customized-consent.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L34) + +An array of `AuthorizationDetail` objects. +Each object provides granular details about specific data or +actions the application wants to perform, potentially related to +Rich Authorization Requests (RAR) or other fine-grained permission models. +This list should be displayed to the user for their review. + +</ParamField> + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +Screen-specific data. + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='scopes' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope">Scope</a></span>}> +{/*> **scopes**: [`Scope`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope)[]*/} + +Defined in: [interfaces/screens/customized-consent.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L25) + +An array of `Scope` objects detailing each permission (scope) being requested. +These are typically high-level permissions like 'read:profile' or 'openid'. +This list should be displayed to the user for their review. + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx new file mode 100644 index 000000000..20d3584f5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx @@ -0,0 +1,122 @@ +--- +title: "ScreenMembersOnDeviceCodeConfirmation" +--- + +Defined in: [interfaces/screens/device-code-confirmation.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L8) + +Interface describing the data available on the Device Code Confirmation screen. + + +<RequestExample> +```ts +export interface ScreenMembersOnDeviceCodeConfirmation extends ScreenMembers { + data: { + textCode: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='textCode'> +{/*> **data**: \{ `textCode`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/device-code-confirmation.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L9) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx new file mode 100644 index 000000000..b46d5370a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx @@ -0,0 +1,122 @@ +--- +title: "ScreenMembersOnEmailIdentifierChallenge" +--- + +Defined in: [interfaces/screens/email-identifier-challenge.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L12) + + +<RequestExample> +```ts +export interface ScreenMembersOnEmailIdentifierChallenge extends ScreenMembers { + data: { + messageType?: string; + email?: string; + resendLimitReached?: boolean; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='email?'> +{/*> **data**: \{ `email?`: `string`; `messageType?`: `string`; `resendLimitReached?`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/email-identifier-challenge.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L13) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge.mdx new file mode 100644 index 000000000..d2d48230b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge.mdx @@ -0,0 +1,121 @@ +--- +title: "ScreenMembersOnEmailOTPChallenge" +--- + +Defined in: [interfaces/screens/email-otp-challenge.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L10) + +Represents the members of the Email OTP Challenge screen. +Extends the base ScreenMembers interface. + + +<RequestExample> +```ts +export interface ScreenMembersOnEmailOTPChallenge extends ScreenMembers { + // Add any specific members for this screen here +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult.mdx new file mode 100644 index 000000000..b16e8519c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult.mdx @@ -0,0 +1,164 @@ +--- +title: "ScreenMembersOnEmailVerificationResult" +--- + +Defined in: [interfaces/screens/email-verification-result.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts#L16) + +ScreenMembersOnEmailVerificationResult + + +<RequestExample> +```ts +export interface ScreenMembersOnEmailVerificationResult extends ScreenMembers { + /** + * Screen-specific data containing the status of the email verification. + * @type {{ status: string; } | null} + */ + data: { + /** + * The status of the email verification process. + * Possible values might include "success", "failure", "already_verified", etc. + * This status should be displayed to the user to inform them of the outcome. + */ + status: string; + } | null; + + /** + * Navigation links available on this screen. + * @type {string | null} + */ + loginLink: string | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='status'> +{/*> **data**: \{ `status`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/email-verification-result.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts#L21) + +Screen-specific data. + +#### Type Declaration + +\{ `status`: `string`; \} + +#### status + +{/*> **status**: `string`*/} + +The status of the email verification process. +Possible values might include "success", "failure", "already_verified", etc. +This status should be displayed to the user to inform them of the outcome. + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +Navigation links available on this screen. + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='loginLink' type='string'> +{/*> **loginLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/email-verification-result.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts#L34) + +Navigation links available on this screen. + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin.mdx new file mode 100644 index 000000000..16ed56133 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin.mdx @@ -0,0 +1,138 @@ +--- +title: "ScreenMembersOnLogin" +--- + +Defined in: [interfaces/screens/login.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L19) + +Extended screen members interface for the login screen + + +<RequestExample> +```ts +export interface ScreenMembersOnLogin extends ScreenMembers { + signupLink: string | null; + resetPasswordLink: string | null; + data: { + username?: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='username?'> +{/*> **data**: \{ `username?`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/login.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L22) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='resetPasswordLink' type='string'> +{/*> **resetPasswordLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/login.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L21) + +</ParamField> + +<ParamField body='signupLink' type='string'> +{/*> **signupLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/login.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L20) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId.mdx new file mode 100644 index 000000000..aec507c75 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId.mdx @@ -0,0 +1,141 @@ +--- +title: "ScreenMembersOnLoginId" +--- + +Defined in: [interfaces/screens/login-id.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L31) + + +<RequestExample> +```ts +export interface ScreenMembersOnLoginId extends ScreenMembers { + signupLink: string | null; + resetPasswordLink: string | null; + publicKey: PasskeyRead['public_key'] | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='publicKey' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential">AllowCredential</a></span>}> +{/*> **publicKey**: \{ `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential)[]; `challenge`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/login-id.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L34) + +</ParamField> + +<ParamField body='resetPasswordLink' type='string'> +{/*> **resetPasswordLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/login-id.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L33) + +</ParamField> + +<ParamField body='signupLink' type='string'> +{/*> **signupLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/login-id.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L32) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword.mdx new file mode 100644 index 000000000..6da0fff81 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword.mdx @@ -0,0 +1,144 @@ +--- +title: "ScreenMembersOnLoginPassword" +--- + +Defined in: [interfaces/screens/login-password.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L14) + + +<RequestExample> +```ts +export interface ScreenMembersOnLoginPassword extends ScreenMembers { + signupLink: string | null; + resetPasswordLink: string | null; + editIdentifierLink: string | null; + data: { + username: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='username'> +{/*> **data**: \{ `username`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/login-password.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L18) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='editIdentifierLink' type='string'> +{/*> **editIdentifierLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/login-password.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L17) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='resetPasswordLink' type='string'> +{/*> **resetPasswordLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/login-password.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L16) + +</ParamField> + +<ParamField body='signupLink' type='string'> +{/*> **signupLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/login-password.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L15) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx new file mode 100644 index 000000000..d7cb432a6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx @@ -0,0 +1,145 @@ +--- +title: "ScreenMembersOnLoginPasswordlessEmailCode" +--- + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L7) + + +<RequestExample> +```ts +export interface ScreenMembersOnLoginPasswordlessEmailCode extends ScreenMembers { + editIdentifierLink: string | null; + resetPasswordLink: string | null; + signupLink: string | null; + data: { + email?: string; + username?: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='email?'> +{/*> **data**: \{ `email?`: `string`; `username?`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L11) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='editIdentifierLink' type='string'> +{/*> **editIdentifierLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L8) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='resetPasswordLink' type='string'> +{/*> **resetPasswordLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L9) + +</ParamField> + +<ParamField body='signupLink' type='string'> +{/*> **signupLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L10) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx new file mode 100644 index 000000000..4a41ad65f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx @@ -0,0 +1,153 @@ +--- +title: "ScreenMembersOnLoginPasswordlessSmsOtp" +--- + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L14) + + +<RequestExample> +```ts +export interface ScreenMembersOnLoginPasswordlessSmsOtp extends ScreenMembers { + signupLink: string | null; + resetPasswordLink: string | null; + backLink: string | null; + data: { + username: string; + phone_number: string; + }; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='backLink' type='string'> +{/*> **backLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L17) + +</ParamField> + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='object'> +{/*> **data**: `object`*/} + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L18) + +#### phone\_number + +{/*> **phone\_number**: `string`*/} + +#### username + +{/*> **username**: `string`*/} + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='resetPasswordLink' type='string'> +{/*> **resetPasswordLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L16) + +</ParamField> + +<ParamField body='signupLink' type='string'> +{/*> **signupLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L15) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes.mdx new file mode 100644 index 000000000..17db616a0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes.mdx @@ -0,0 +1,135 @@ +--- +title: "ScreenMembersOnMfaCountryCodes" +--- + +Defined in: [interfaces/screens/mfa-country-codes.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L8) + +Interface for screen data specific to mfa-country-codes screen + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaCountryCodes extends ScreenMembers { + data: { + /** List of available phone prefixes */ + phone_prefixes: PhonePrefix[]; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix">PhonePrefix</a></span>}> +{/*> **data**: \{ `phone_prefixes`: [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-country-codes.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L9) + +#### Type Declaration + +\{ `phone_prefixes`: [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]; \} + +#### phone\_prefixes + +{/*> **phone\_prefixes**: [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]*/} + +List of available phone prefixes + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge.mdx new file mode 100644 index 000000000..ad085a54a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge.mdx @@ -0,0 +1,123 @@ +--- +title: "ScreenMembersOnMfaEmailChallenge" +--- + +Defined in: [interfaces/screens/mfa-email-challenge.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L10) + +Interface for the screen data specific to mfa-email-challenge screen + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaEmailChallenge extends ScreenMembers { + data: { + email: string; + showRememberDevice?: boolean; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='email'> +{/*> **data**: \{ `email`: `string`; `showRememberDevice?`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-email-challenge.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L11) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList.mdx new file mode 100644 index 000000000..27b8d5eb7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList.mdx @@ -0,0 +1,135 @@ +--- +title: "ScreenMembersOnMfaEmailList" +--- + +Defined in: [interfaces/screens/mfa-email-list.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L8) + +Interface for the screen data specific to mfa-email-list screen + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaEmailList extends ScreenMembers { + data: { + /** List of enrolled email addresses */ + enrolled_emails: string[]; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='enrolled_emails'> +{/*> **data**: \{ `enrolled_emails`: `string`[]; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-email-list.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L9) + +#### Type Declaration + +\{ `enrolled_emails`: `string`[]; \} + +#### enrolled\_emails + +{/*> **enrolled\_emails**: `string`[]*/} + +List of enrolled email addresses + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult.mdx new file mode 100644 index 000000000..ec2941912 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult.mdx @@ -0,0 +1,148 @@ +--- +title: "ScreenMembersOnMfaEnrollResult" +--- + +Defined in: [interfaces/screens/mfa-enroll-result.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts#L13) + +ScreenMembersOnMfaEnrollResult + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaEnrollResult extends ScreenMembers { + /** + * Screen-specific data containing the status of the MFA enrollment. + * @type {{ status: string; } | null} + */ + data: { + /** + * The status of the MFA enrollment process. + * Possible values might include "success", "failure", or other specific status codes. + * This status can be used to display an appropriate message to the user. + * @type {string} + */ + status: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='status'> +{/*> **data**: \{ `status`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-enroll-result.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts#L18) + +Screen-specific data. + +#### Type Declaration + +\{ `status`: `string`; \} + +#### status + +{/*> **status**: `string`*/} + +The status of the MFA enrollment process. +Possible values might include "success", "failure", or other specific status codes. +This status can be used to display an appropriate message to the user. + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions.mdx new file mode 100644 index 000000000..17b350f1a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions.mdx @@ -0,0 +1,135 @@ +--- +title: "ScreenMembersOnMfaLoginOptions" +--- + +Defined in: [interfaces/screens/mfa-login-options.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L9) + +Interface for the screen data specific to mfa-login-options screen + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaLoginOptions extends ScreenMembers { + data: { + /** List of enrolled MFA factors for the user */ + enrolled_factors: string[]; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='enrolled_factors'> +{/*> **data**: \{ `enrolled_factors`: `string`[]; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-login-options.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L10) + +#### Type Declaration + +\{ `enrolled_factors`: `string`[]; \} + +#### enrolled\_factors + +{/*> **enrolled\_factors**: `string`[]*/} + +List of enrolled MFA factors for the user + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge.mdx new file mode 100644 index 000000000..e2c9ac700 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge.mdx @@ -0,0 +1,122 @@ +--- +title: "ScreenMembersOnMfaOtpChallenge" +--- + +Defined in: [interfaces/screens/mfa-otp-challenge.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L8) + +Interface for the screen data specific to mfa-otp-challenge screen + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaOtpChallenge extends ScreenMembers { + data: { + showRememberDevice?: boolean; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='showRememberDevice?'> +{/*> **data**: \{ `showRememberDevice?`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-otp-challenge.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L9) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx new file mode 100644 index 000000000..5d48ed747 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx @@ -0,0 +1,137 @@ +--- +title: "ScreenMembersOnMfaOtpEnrollmentCode" +--- + +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L32) + +Interface for the screen data specific to the mfa-otp-enrollment-code screen. + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaOtpEnrollmentCode extends ScreenMembers { + data: { + /** + * The text code to display to the user. + */ + text_code: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='text_code'> +{/*> **data**: \{ `text_code`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L33) + +#### Type Declaration + +\{ `text_code`: `string`; \} + +#### text\_code + +{/*> **text\_code**: `string`*/} + +The text code to display to the user. + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx new file mode 100644 index 000000000..3608f597e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx @@ -0,0 +1,122 @@ +--- +title: "ScreenMembersOnMfaOtpEnrollmentQr" +--- + +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L8) + +Interface for the screen data specific to mfa-otp-enrollment-qr screen + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaOtpEnrollmentQr extends ScreenMembers { + data: { + qr_code: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='qr_code'> +{/*> **data**: \{ `qr_code`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L9) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx new file mode 100644 index 000000000..00d31599c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx @@ -0,0 +1,139 @@ +--- +title: "ScreenMembersOnMfaPhoneChallenge" +--- + +Defined in: [interfaces/screens/mfa-phone-challenge.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L16) + +ScreenMembersOnMfaPhoneChallenge + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaPhoneChallenge extends ScreenMembers { + /** + * @property {object | null} data - Screen-specific data. + * @property {string} data.phone_number - The phone number (often masked) associated with this MFA challenge. + */ + data: { + /** The phone number (often masked) associated with this MFA challenge. */ + phoneNumber: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='phoneNumber'> +{/*> **data**: \{ `phoneNumber`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-phone-challenge.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L21) + +#### Type Declaration + +\{ `phoneNumber`: `string`; \} + +#### phoneNumber + +{/*> **phoneNumber**: `string`*/} + +The phone number (often masked) associated with this MFA challenge. + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush.mdx new file mode 100644 index 000000000..2d65e4392 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush.mdx @@ -0,0 +1,143 @@ +--- +title: "ScreenMembersOnMfaPushChallengePush" +--- + +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L13) + +Interface for the screen data specific to mfa-push-challenge-push screen + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaPushChallengePush extends ScreenMembers { + data: { + /** The name of the device receiving the push notification */ + deviceName: string; + /** Whether to show the remember device option */ + showRememberDevice?: boolean; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='deviceName'> +{/*> **data**: \{ `deviceName`: `string`; `showRememberDevice?`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L14) + +#### Type Declaration + +\{ `deviceName`: `string`; `showRememberDevice?`: `boolean`; \} + +#### deviceName + +{/*> **deviceName**: `string`*/} + +The name of the device receiving the push notification + +#### showRememberDevice? + +{/*> `optional` **showRememberDevice**: `boolean`*/} + +Whether to show the remember device option + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx new file mode 100644 index 000000000..fc080748c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx @@ -0,0 +1,124 @@ +--- +title: "ScreenMembersOnMfaPushEnrollmentQr" +--- + +Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L13) + +Interface for the screen data specific to mfa-push-enrollment-qr screen + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaPushEnrollmentQr extends ScreenMembers { + data: { + qrCode: string; + qrUri: string; + showCodeCopy: boolean; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='qrCode'> +{/*> **data**: \{ `qrCode`: `string`; `qrUri`: `string`; `showCodeCopy`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L14) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome.mdx new file mode 100644 index 000000000..c1d7a32f3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome.mdx @@ -0,0 +1,147 @@ +--- +title: "ScreenMembersOnMfaPushWelcome" +--- + +Defined in: [interfaces/screens/mfa-push-welcome.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L9) + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaPushWelcome extends ScreenMembers { + screen: { + name: string; + links: { + ios: string; + android: string; + }; + }; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='screen' type='object'> +{/*> **screen**: `object`*/} + +Defined in: [interfaces/screens/mfa-push-welcome.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L10) + +#### links + +{/*> **links**: `object`*/} + +##### links.android + +{/*> **android**: `string`*/} + +##### links.ios + +{/*> **ios**: `string`*/} + +#### name + +{/*> **name**: `string`*/} + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx new file mode 100644 index 000000000..f175702b1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx @@ -0,0 +1,143 @@ +--- +title: "ScreenMembersOnMfaRecoveryCodeChallengeNewCode" +--- + +Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L11) + +ScreenMembersOnMfaRecoveryCodeChallengeNewCode + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaRecoveryCodeChallengeNewCode extends ScreenMembers { + /** + * @property {object | null} data - Screen-specific data. + * @property {string} data.textCode - The newly generated recovery code that the user must save. + */ + data: { + /** + * The newly generated recovery code to display to the user. + * It is crucial that the user saves this code securely as it will be needed for future logins if other MFA factors are unavailable. + */ + textCode: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='textCode'> +{/*> **data**: \{ `textCode`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L16) + +#### Type Declaration + +\{ `textCode`: `string`; \} + +#### textCode + +{/*> **textCode**: `string`*/} + +The newly generated recovery code to display to the user. +It is crucial that the user saves this code securely as it will be needed for future logins if other MFA factors are unavailable. + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx new file mode 100644 index 000000000..28942f85c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx @@ -0,0 +1,137 @@ +--- +title: "ScreenMembersOnMfaRecoveryCodeEnrollment" +--- + +Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L8) + +Interface describing the data available on the Mfa Recovery Code Enrollment screen. + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaRecoveryCodeEnrollment extends ScreenMembers { + data: { + /** + * The recovery code to display to the user. + */ + textCode: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='textCode'> +{/*> **data**: \{ `textCode`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L9) + +#### Type Declaration + +\{ `textCode`: `string`; \} + +#### textCode + +{/*> **textCode**: `string`*/} + +The recovery code to display to the user. + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge.mdx new file mode 100644 index 000000000..ab4abe8de --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge.mdx @@ -0,0 +1,157 @@ +--- +title: "ScreenMembersOnMfaSmsChallenge" +--- + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L16) + +Interface for the screen data specific to mfa-sms-challenge screen + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaSmsChallenge extends ScreenMembers { + data: { + /** + * The phone number where the SMS was sent + */ + phoneNumber?: string; + /** + * Whether to show the remember device option + */ + showRememberDevice?: boolean; + /** + * Whether to show the link to switch to voice call verification + */ + showLinkVoice?: boolean; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='phoneNumber?'> +{/*> **data**: \{ `phoneNumber?`: `string`; `showLinkVoice?`: `boolean`; `showRememberDevice?`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L17) + +#### Type Declaration + +\{ `phoneNumber?`: `string`; `showLinkVoice?`: `boolean`; `showRememberDevice?`: `boolean`; \} + +#### phoneNumber? + +{/*> `optional` **phoneNumber**: `string`*/} + +The phone number where the SMS was sent + +#### showLinkVoice? + +{/*> `optional` **showLinkVoice**: `boolean`*/} + +Whether to show the link to switch to voice call verification + +#### showRememberDevice? + +{/*> `optional` **showRememberDevice**: `boolean`*/} + +Whether to show the remember device option + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx new file mode 100644 index 000000000..3aacd01cb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx @@ -0,0 +1,120 @@ +--- +title: "ScreenMembersOnMfaSmsEnrollment" +--- + +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L11) + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaSmsEnrollment extends ScreenMembers { + data: { + phone?: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='phone?'> +{/*> **data**: \{ `phone?`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L12) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx new file mode 100644 index 000000000..d1ad91b45 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx @@ -0,0 +1,164 @@ +--- +title: "ScreenMembersOnMfaVoiceChallenge" +--- + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L30) + +Extended screen members interface for the MFA Voice Challenge screen. + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaVoiceChallenge extends ScreenMembers { + /** + * Additional screen data specific to MFA voice challenge. + */ + data: { + /** + * The phone number where the voice code was sent. + */ + phoneNumber?: string; + + /** + * Whether to show the remember device option. + */ + showRememberDevice?: boolean; + + /** + * Whether to show the link to switch to SMS verification. + */ + showLinkSms?: boolean; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='phoneNumber?'> +{/*> **data**: \{ `phoneNumber?`: `string`; `showLinkSms?`: `boolean`; `showRememberDevice?`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L34) + +Additional screen data specific to MFA voice challenge. + +#### Type Declaration + +\{ `phoneNumber?`: `string`; `showLinkSms?`: `boolean`; `showRememberDevice?`: `boolean`; \} + +#### phoneNumber? + +{/*> `optional` **phoneNumber**: `string`*/} + +The phone number where the voice code was sent. + +#### showLinkSms? + +{/*> `optional` **showLinkSms**: `boolean`*/} + +Whether to show the link to switch to SMS verification. + +#### showRememberDevice? + +{/*> `optional` **showRememberDevice**: `boolean`*/} + +Whether to show the remember device option. + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx new file mode 100644 index 000000000..d956481db --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx @@ -0,0 +1,158 @@ +--- +title: "ScreenMembersOnMfaWebAuthnChangeKeyNickname" +--- + +Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L15) + +ScreenMembersOnMfaWebAuthnChangeKeyNickname + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaWebAuthnChangeKeyNickname extends ScreenMembers { + /** + * Screen-specific data containing the current nickname of the WebAuthn key. + * @type {{ nickname: string; } | null} + */ + data: { + /** + * The current nickname of the WebAuthn security key that the user is about to change. + * This value should be displayed to the user for context. + * @type {string} + * @example "My YubiKey" + * @example "Work Security Key" + */ + nickname: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='nickname'> +{/*> **data**: \{ `nickname`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L20) + +Screen-specific data. + +#### Type Declaration + +\{ `nickname`: `string`; \} + +#### nickname + +{/*> **nickname**: `string`*/} + +The current nickname of the WebAuthn security key that the user is about to change. +This value should be displayed to the user for context. + +##### Examples + +```ts +"My YubiKey" +``` + +```ts +"Work Security Key" +``` + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx new file mode 100644 index 000000000..61ca94fa8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx @@ -0,0 +1,173 @@ +--- +title: "ScreenMembersOnMfaWebAuthnEnrollmentSuccess" +--- + +Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L17) + +ScreenMembersOnMfaWebAuthnEnrollmentSuccess + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaWebAuthnEnrollmentSuccess extends ScreenMembers { + /** + * Screen-specific data containing details about the successful WebAuthn enrollment. + * @type {{ nickname: string; webauthnType: WebAuthnType; } | null} + */ + data: { + /** + * The nickname that the user (or system) assigned to the newly enrolled WebAuthn authenticator. + * This helps the user identify the authenticator later. + * @type {string} + * @example "YubiKey 5" + * @example "My Laptop's Touch ID" + */ + nickname: string; + /** + * The type of WebAuthn authenticator that was successfully enrolled. + * - `'webauthn-roaming'`: Indicates a roaming authenticator like a USB security key. + * - `'webauthn-platform'`: Indicates a platform authenticator like Touch ID or Windows Hello. + * @type {WebAuthnType} + */ + webauthnType: WebAuthnType; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType">WebAuthnType</a></span>}> +{/*> **data**: \{ `nickname`: `string`; `webauthnType`: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType); \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L22) + +Screen-specific data. + +#### Type Declaration + +\{ `nickname`: `string`; `webauthnType`: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType); \} + +#### nickname + +{/*> **nickname**: `string`*/} + +The nickname that the user (or system) assigned to the newly enrolled WebAuthn authenticator. +This helps the user identify the authenticator later. + +##### Examples + +```ts +"YubiKey 5" +``` + +```ts +"My Laptop's Touch ID" +``` + +#### webauthnType + +{/*> **webauthnType**: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType)*/} + +The type of WebAuthn authenticator that was successfully enrolled. +- `'webauthn-roaming'`: Indicates a roaming authenticator like a USB security key. +- `'webauthn-platform'`: Indicates a platform authenticator like Touch ID or Windows Hello. + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError.mdx new file mode 100644 index 000000000..3fc73cd32 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError.mdx @@ -0,0 +1,154 @@ +--- +title: "ScreenMembersOnMfaWebAuthnError" +--- + +Defined in: [interfaces/screens/mfa-webauthn-error.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L20) + +ScreenMembersOnMfaWebAuthnError + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaWebAuthnError extends ScreenMembers { + /** + * @property {object | null} data - Screen-specific data detailing the WebAuthn error. + * @property {string} data.errorType - A string code or message describing the nature of the WebAuthn error + * (e.g., "NotAllowedError", "TimeoutError", "InvalidStateError"). + * @property {WebAuthnType} data.webauthnType - Indicates whether the error occurred with a 'webauthn-roaming' + * or 'webauthn-platform' authenticator. + */ + data: { + /** + * A code or message describing the WebAuthn error. + */ + errorType: string; + /** + * The type of WebAuthn authenticator involved. + */ + webauthnType: WebAuthnType; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType">WebAuthnType</a></span>}> +{/*> **data**: \{ `errorType`: `string`; `webauthnType`: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType); \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-webauthn-error.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L28) + +#### Type Declaration + +\{ `errorType`: `string`; `webauthnType`: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType); \} + +#### errorType + +{/*> **errorType**: `string`*/} + +A code or message describing the WebAuthn error. + +#### webauthnType + +{/*> **webauthnType**: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType)*/} + +The type of WebAuthn authenticator involved. + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx new file mode 100644 index 000000000..1d06c6ba2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,153 @@ +--- +title: "ScreenMembersOnMfaWebAuthnPlatformChallenge" +--- + +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L16) + +ScreenMembersOnMfaWebAuthnPlatformChallenge + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaWebAuthnPlatformChallenge extends ScreenMembers { + /** + * Direct access to the `PublicKeyCredentialRequestOptions` (specifically the challenge part) + * needed for `navigator.credentials.get()`. + * This is a convenience accessor for `data?.passkey?.public_key`. + * @type {PasskeyRead['public_key'] | null} + */ + publicKey: PasskeyRead['public_key'] | null; + + /** + * Indicates whether the "Remember this device" checkbox should be displayed. + * @type {boolean} + */ + showRememberDevice: boolean; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +Screen-specific data. + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='publicKey' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential">AllowCredential</a></span>}> +{/*> **publicKey**: \{ `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential)[]; `challenge`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L23) + +The public key credential request options (specifically the challenge) +needed to call `navigator.credentials.get()`. This is derived from `universal_login_context.screen.data.passkey.public_key`. + +</ParamField> + +<ParamField body='showRememberDevice' type='boolean'> +{/*> **showRememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L29) + +Indicates whether the "Remember this device" checkbox should be displayed. + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx new file mode 100644 index 000000000..cf1bbf8e1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx @@ -0,0 +1,132 @@ +--- +title: "ScreenMembersOnMfaWebAuthnPlatformEnrollment" +--- + +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L11) + +ScreenMembersOnMfaWebAuthnPlatformEnrollment + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaWebAuthnPlatformEnrollment extends ScreenMembers { + /** + * @property {PasskeyCreate['public_key'] | null} publicKey - Direct access to the `PublicKeyCredentialCreationOptions`. + * This is a convenience accessor for `data?.passkeys?.public_key`. It provides the necessary options + * for `navigator.credentials.create()`. + */ + publicKey: PasskeyCreate['public_key'] | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='publicKey' type='authenticatorSelection'> +{/*> **publicKey**: \{ `authenticatorSelection`: \{ `authenticatorAttachment?`: `string`; `residentKey`: `string`; `userVerification`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `alg`: `number`; `type`: `string`; \}\]; `rp`: \{ `id`: `string`; `name`: `string`; \}; `user`: \{ `displayName`: `string`; `id`: `string`; `name`: `string`; \}; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L17) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx new file mode 100644 index 000000000..79a718e9d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,145 @@ +--- +title: "ScreenMembersOnMfaWebAuthnRoamingChallenge" +--- + +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L17) + +ScreenMembersOnMfaWebAuthnRoamingChallenge + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaWebAuthnRoamingChallenge extends ScreenMembers { + showRememberDevice?: boolean; + webauthnType: string | null; + publicKey: PasskeyRead['public_key'] | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +Screen-specific data. + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='publicKey' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential">AllowCredential</a></span>}> +{/*> **publicKey**: \{ `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential)[]; `challenge`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L20) + +</ParamField> + +<ParamField body='showRememberDevice?' type='boolean'> +{/*> `optional` **showRememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L18) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='webauthnType' type='string'> +{/*> **webauthnType**: `string` \| `null`*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L19) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx new file mode 100644 index 000000000..19216e795 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx @@ -0,0 +1,135 @@ +--- +title: "ScreenMembersOnMfaWebAuthnRoamingEnrollment" +--- + +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L7) + +Interface for screen data specific to mfa-webauthn-roaming-enrollment screen. + + +<RequestExample> +```ts +export interface ScreenMembersOnMfaWebAuthnRoamingEnrollment extends ScreenMembers { + webauthnType: string | null; + publicKey: PasskeyCreate['public_key'] | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='publicKey' type='authenticatorSelection'> +{/*> **publicKey**: \{ `authenticatorSelection`: \{ `authenticatorAttachment?`: `string`; `residentKey`: `string`; `userVerification`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `alg`: `number`; `type`: `string`; \}\]; `rp`: \{ `id`: `string`; `name`: `string`; \}; `user`: \{ `displayName`: `string`; `id`: `string`; `name`: `string`; \}; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L9) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='webauthnType' type='string'> +{/*> **webauthnType**: `string` \| `null`*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L8) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection.mdx new file mode 100644 index 000000000..e6349db10 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection.mdx @@ -0,0 +1,167 @@ +--- +title: "ScreenMembersOnOrganizationSelection" +--- + +Defined in: [interfaces/screens/organization-selection.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L26) + +Interface for the screen data specific to organization-selection screen. + + +<RequestExample> +```ts +export interface ScreenMembersOnOrganizationSelection extends ScreenMembers { + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + transaction: TransactionMembers; + User: UserMembers; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/screens/organization-selection.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L27) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/screens/organization-selection.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L28) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/screens/organization-selection.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L29) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> +{/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} + +Defined in: [interfaces/screens/organization-selection.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L30) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> +{/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} + +Defined in: [interfaces/screens/organization-selection.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L31) + +</ParamField> + +<ParamField body='User' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **User**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/screens/organization-selection.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L32) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment.mdx new file mode 100644 index 000000000..89238c492 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment.mdx @@ -0,0 +1,141 @@ +--- +title: "ScreenMembersOnPasskeyEnrollment" +--- + +Defined in: [interfaces/screens/passkey-enrollment.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L19) + + +<RequestExample> +```ts +export interface ScreenMembersOnPasskeyEnrollment extends ScreenMembers { + backLink: string | null; + loginLink: string | null; + publicKey: PasskeyCreate['public_key'] | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='backLink' type='string'> +{/*> **backLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/passkey-enrollment.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L20) + +</ParamField> + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='loginLink' type='string'> +{/*> **loginLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/passkey-enrollment.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L21) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='publicKey' type='authenticatorSelection'> +{/*> **publicKey**: \{ `authenticatorSelection`: \{ `authenticatorAttachment?`: `string`; `residentKey`: `string`; `userVerification`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `alg`: `number`; `type`: `string`; \}\]; `rp`: \{ `id`: `string`; `name`: `string`; \}; `user`: \{ `displayName`: `string`; `id`: `string`; `name`: `string`; \}; \} \| `null`*/} + +Defined in: [interfaces/screens/passkey-enrollment.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L22) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx new file mode 100644 index 000000000..e6b40b026 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx @@ -0,0 +1,125 @@ +--- +title: "ScreenMembersOnPasskeyEnrollmentLocal" +--- + +Defined in: [interfaces/screens/passkey-enrollment-local.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L24) + + +<RequestExample> +```ts +export interface ScreenMembersOnPasskeyEnrollmentLocal extends ScreenMembers { + publicKey: PasskeyCreate['public_key'] | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='publicKey' type='authenticatorSelection'> +{/*> **publicKey**: \{ `authenticatorSelection`: \{ `authenticatorAttachment?`: `string`; `residentKey`: `string`; `userVerification`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `alg`: `number`; `type`: `string`; \}\]; `rp`: \{ `id`: `string`; `name`: `string`; \}; `user`: \{ `displayName`: `string`; `id`: `string`; `name`: `string`; \}; \} \| `null`*/} + +Defined in: [interfaces/screens/passkey-enrollment-local.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L25) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx new file mode 100644 index 000000000..0083f7b85 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx @@ -0,0 +1,124 @@ +--- +title: "ScreenMembersOnPhoneIdentifierChallenge" +--- + +Defined in: [interfaces/screens/phone-identifier-challenge.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L26) + + +<RequestExample> +```ts +export interface ScreenMembersOnPhoneIdentifierChallenge extends ScreenMembers { + data: { + messageType?: 'text' | 'voice'; + phone?: string; + resendLimitReached?: boolean; + showLinkSms?: boolean; + showLinkVoice?: boolean; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='messageType?'> +{/*> **data**: \{ `messageType?`: `"voice"` \| `"text"`; `phone?`: `string`; `resendLimitReached?`: `boolean`; `showLinkSms?`: `boolean`; `showLinkVoice?`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/phone-identifier-challenge.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L27) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx new file mode 100644 index 000000000..2d6c65c56 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx @@ -0,0 +1,129 @@ +--- +title: "ScreenMembersOnPhoneIdentifierEnrollment" +--- + +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L10) + + +<RequestExample> +```ts +export interface ScreenMembersOnPhoneIdentifierEnrollment extends ScreenMembers { + data: { + phone?: 'string'; + messageType?: 'text' | 'voice'; + } | null; + editIdentifierLink: string | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='messageType?'> +{/*> **data**: \{ `messageType?`: `"voice"` \| `"text"`; `phone?`: `"string"`; \} \| `null`*/} + +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L11) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='editIdentifierLink' type='string'> +{/*> **editIdentifierLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L15) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword.mdx new file mode 100644 index 000000000..99eb5ac8a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword.mdx @@ -0,0 +1,120 @@ +--- +title: "ScreenMembersOnResetPassword" +--- + +Defined in: [interfaces/screens/reset-password.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L14) + + +<RequestExample> +```ts +export interface ScreenMembersOnResetPassword extends ScreenMembers { + data: { + username?: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='username?'> +{/*> **data**: \{ `username?`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/reset-password.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L15) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail.mdx new file mode 100644 index 000000000..2db9b5bce --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail.mdx @@ -0,0 +1,120 @@ +--- +title: "ScreenMembersOnResetPasswordEmail" +--- + +Defined in: [interfaces/screens/reset-password-email.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L13) + + +<RequestExample> +```ts +export interface ScreenMembersOnResetPasswordEmail extends ScreenMembers { + data: { + username?: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='username?'> +{/*> **data**: \{ `username?`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/reset-password-email.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L14) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError.mdx new file mode 100644 index 000000000..8ae097911 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError.mdx @@ -0,0 +1,120 @@ +--- +title: "ScreenMembersOnResetPasswordError" +--- + +Defined in: [interfaces/screens/reset-password-error.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts#L9) + + +<RequestExample> +```ts +export interface ScreenMembersOnResetPasswordError extends ScreenMembers { + data: { + username?: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='username?'> +{/*> **data**: \{ `username?`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/reset-password-error.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts#L10) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx new file mode 100644 index 000000000..9830efff2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx @@ -0,0 +1,122 @@ +--- +title: "ScreenMembersOnResetPasswordMfaEmailChallenge" +--- + +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L8) + +Interface for the screen data specific to reset-password-mfa-email-challenge screen + + +<RequestExample> +```ts +export interface ScreenMembersOnResetPasswordMfaEmailChallenge extends ScreenMembers { + data: { + email: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='email'> +{/*> **data**: \{ `email`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L9) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx new file mode 100644 index 000000000..3656b53e9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx @@ -0,0 +1,139 @@ +--- +title: "ScreenMembersOnResetPasswordMfaPhoneChallenge" +--- + +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L15) + +ScreenMembersOnResetPasswordMfaPhoneChallenge + + +<RequestExample> +```ts +export interface ScreenMembersOnResetPasswordMfaPhoneChallenge extends ScreenMembers { + /** + * @property {object | null} data - Screen-specific data. + * @property {string} data.phoneNumber - The phone number (often masked for security) associated with this MFA challenge during password reset. + */ + data: { + /** The phone number (often masked) associated with this MFA challenge. */ + phoneNumber: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='phoneNumber'> +{/*> **data**: \{ `phoneNumber`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L20) + +#### Type Declaration + +\{ `phoneNumber`: `string`; \} + +#### phoneNumber + +{/*> **phoneNumber**: `string`*/} + +The phone number (often masked) associated with this MFA challenge. + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx new file mode 100644 index 000000000..a743e7343 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx @@ -0,0 +1,118 @@ +--- +title: "ScreenMembersOnResetPasswordMfaPushChallengePush" +--- + +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L12) + +Interface for the screen data specific to reset-password-mfa-push-challenge-push screen + + +<RequestExample> +```ts +export interface ScreenMembersOnResetPasswordMfaPushChallengePush +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='deviceName'> +{/*> **data**: \{ `deviceName`: `string`; `rememberDevice?`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L14) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx new file mode 100644 index 000000000..4968ade04 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx @@ -0,0 +1,140 @@ +--- +title: "ScreenMembersOnResetPasswordMfaSmsChallenge" +--- + +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L11) + + +<RequestExample> +```ts +export interface ScreenMembersOnResetPasswordMfaSmsChallenge extends ScreenMembers { + data: { + phoneNumber: string; + /** + * Whether to show the link to switch to voice call verification + */ + showLinkVoice?: boolean; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='phoneNumber'> +{/*> **data**: \{ `phoneNumber`: `string`; `showLinkVoice?`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L12) + +#### Type Declaration + +\{ `phoneNumber`: `string`; `showLinkVoice?`: `boolean`; \} + +#### phoneNumber + +{/*> **phoneNumber**: `string`*/} + +#### showLinkVoice? + +{/*> `optional` **showLinkVoice**: `boolean`*/} + +Whether to show the link to switch to voice call verification + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx new file mode 100644 index 000000000..b4d97761e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx @@ -0,0 +1,148 @@ +--- +title: "ScreenMembersOnResetPasswordMfaVoiceChallenge" +--- + +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L9) + +Interface for the screen data specific to reset-password-mfa-voice-challenge screen. + + +<RequestExample> +```ts +export interface ScreenMembersOnResetPasswordMfaVoiceChallenge extends ScreenMembers { + data: { + /** + * The phone number to send the voice call to. + */ + phoneNumber: string; + + /** + * Whether to show the link to switch to SMS verification. + */ + showLinkSms?: boolean; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='phoneNumber'> +{/*> **data**: \{ `phoneNumber`: `string`; `showLinkSms?`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L10) + +#### Type Declaration + +\{ `phoneNumber`: `string`; `showLinkSms?`: `boolean`; \} + +#### phoneNumber + +{/*> **phoneNumber**: `string`*/} + +The phone number to send the voice call to. + +#### showLinkSms? + +{/*> `optional` **showLinkSms**: `boolean`*/} + +Whether to show the link to switch to SMS verification. + +`null` + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx new file mode 100644 index 000000000..5363bf621 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,157 @@ +--- +title: "ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge" +--- + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L30) + +ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge + + +<RequestExample> +```ts +export interface ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge extends ScreenMembers { + /** + * Convenience getter for the public key credential request options (challenge) needed for WebAuthn. + * This is derived from `screen.data.passkey.public_key`. + * If `screen.data.passkey` or `screen.data.passkey.public_key` is not available, this will be `null`. + * @type {PasskeyRead['public_key'] | null} + */ + publicKey: PasskeyRead['public_key'] | null; + + /** + * Convenience getter for whether the "Remember this device" option should be shown. + * Derived from `screen.data.show_remember_device`. Defaults to `false` if not specified. + * @type {boolean} + */ + showRememberDevice: boolean; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +Screen-specific data. + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='publicKey' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential">AllowCredential</a></span>}> +{/*> **publicKey**: \{ `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential)[]; `challenge`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L37) + +A convenience accessor for `data.passkey.public_key`. + Provides the challenge and other parameters for the + WebAuthn `navigator.credentials.get()` API call. + +</ParamField> + +<ParamField body='showRememberDevice' type='boolean'> +{/*> **showRememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L44) + +A convenience accessor for `data.show_remember_device`. + Indicates if the "Remember this device" option should be displayed. + Defaults to `false` if not present in the context. + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx new file mode 100644 index 000000000..e5c641f73 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,160 @@ +--- +title: "ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge" +--- + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L43) + +ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge + + +<RequestExample> +```ts +export interface ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge extends ScreenMembers { + /** + * A direct accessor for the `passkey.public_key` data from `screen.data`. + * This object contains the challenge and other options necessary for the + * `navigator.credentials.get()` WebAuthn API call. + * It is `null` if `screen.data.passkey.public_key` is not available. + * @type {PasskeyRead['public_key'] | null} + * @public + */ + publicKey: PasskeyRead['public_key'] | null; + + /** + * A direct accessor for the `show_remember_device` flag from `screen.data`. + * Indicates whether the UI should present an option to the user to remember this device/browser + * to potentially bypass MFA on future logins. Defaults to `false` if not set in `screen.data`. + * @type {boolean} + * @public + */ + showRememberDevice: boolean; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +Screen-specific data, +including WebAuthn challenge options and the "show remember device" flag. + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='publicKey' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential">AllowCredential</a></span>}> +{/*> **publicKey**: \{ `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential)[]; `challenge`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L52) + +A convenience accessor for `screen.data.passkey.public_key`. +Provides the challenge and related options for `navigator.credentials.get()`. + +</ParamField> + +<ParamField body='showRememberDevice' type='boolean'> +{/*> **showRememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L61) + +A convenience accessor for `screen.data.show_remember_device`. +Indicates if the "Remember this device" option should be displayed. Defaults to `false` if not present. + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest.mdx new file mode 100644 index 000000000..ac78bc428 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest.mdx @@ -0,0 +1,122 @@ +--- +title: "ScreenMembersOnResetPasswordRequest" +--- + +Defined in: [interfaces/screens/reset-password-request.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L19) + + +<RequestExample> +```ts +export interface ScreenMembersOnResetPasswordRequest extends ScreenMembers { + data: { + phone?: string; + email?: string; + username?: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='email?'> +{/*> **data**: \{ `email?`: `string`; `phone?`: `string`; `username?`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/reset-password-request.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L20) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess.mdx new file mode 100644 index 000000000..2d18c9b01 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess.mdx @@ -0,0 +1,116 @@ +--- +title: "ScreenMembersOnResetPasswordSuccess" +--- + +Defined in: [interfaces/screens/reset-password-success.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-success.ts#L12) + + +<RequestExample> +```ts +export interface ScreenMembersOnResetPasswordSuccess extends ScreenMembers {} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup.mdx new file mode 100644 index 000000000..1a901cc53 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup.mdx @@ -0,0 +1,125 @@ +--- +title: "ScreenMembersOnSignup" +--- + +Defined in: [interfaces/screens/signup.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L23) + + +<RequestExample> +```ts +export interface ScreenMembersOnSignup extends ScreenMembers { + loginLink: string | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='loginLink' type='string'> +{/*> **loginLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/signup.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L24) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId.mdx new file mode 100644 index 000000000..53006197b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId.mdx @@ -0,0 +1,125 @@ +--- +title: "ScreenMembersOnSignupId" +--- + +Defined in: [interfaces/screens/signup-id.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L25) + + +<RequestExample> +```ts +export interface ScreenMembersOnSignupId extends ScreenMembers { + loginLink: string | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> +{/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='loginLink' type='string'> +{/*> **loginLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/signup-id.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L26) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword.mdx new file mode 100644 index 000000000..21b1aff8c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword.mdx @@ -0,0 +1,138 @@ +--- +title: "ScreenMembersOnSignupPassword" +--- + +Defined in: [interfaces/screens/signup-password.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L29) + + +<RequestExample> +```ts +export interface ScreenMembersOnSignupPassword extends ScreenMembers { + loginLink: string | null; + editLink: string | null; + data: { + email?: string; + phoneNumber?: string; + username?: string; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +<ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> +{/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} + +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captcha`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captcha) + +</ParamField> + +<ParamField body='captchaImage' type='string'> +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaImage`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaimage) + +</ParamField> + +<ParamField body='captchaProvider' type='string'> +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaProvider`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchaprovider) + +</ParamField> + +<ParamField body='captchaSiteKey' type='string'> +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`captchaSiteKey`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#captchasitekey) + +</ParamField> + +<ParamField body='data' type='email?'> +{/*> **data**: \{ `email?`: `string`; `phoneNumber?`: `string`; `username?`: `string`; \} \| `null`*/} + +Defined in: [interfaces/screens/signup-password.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L32) + +#### Overrides + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`data`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#data) + +</ParamField> + +<ParamField body='editLink' type='string'> +{/*> **editLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/signup-password.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L31) + +</ParamField> + +<ParamField body='isCaptchaAvailable' type='boolean'> +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`isCaptchaAvailable`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#iscaptchaavailable) + +</ParamField> + +<ParamField body='links' type='Record'> +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`links`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#links) + +</ParamField> + +<ParamField body='loginLink' type='string'> +{/*> **loginLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/signup-password.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L30) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`name`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#name) + +</ParamField> + +<ParamField body='texts' type='Record'> +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + +#### Inherited from + +[`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers).[`texts`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.md#texts) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions.mdx new file mode 100644 index 000000000..2bd75bce7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions.mdx @@ -0,0 +1,46 @@ +--- +title: "SelectCountryCodeOptions" +--- + +Defined in: [interfaces/screens/mfa-country-codes.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L18) + +Options for selecting a country code + + +<RequestExample> +```ts +export interface SelectCountryCodeOptions { + /** The country code (e.g. 'US', 'GB') */ + country_code: string; + /** The phone prefix (e.g. '+1', '+44') */ + phone_prefix: string; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +### country\_code + +> **country\_code**: `string` + +Defined in: [interfaces/screens/mfa-country-codes.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L20) + +The country code (e.g. 'US', 'GB') + + +### phone\_prefix + +> **phone\_prefix**: `string` + +Defined in: [interfaces/screens/mfa-country-codes.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L22) + +The phone prefix (e.g. '+1', '+44') \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions.mdx new file mode 100644 index 000000000..ccff3a676 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions.mdx @@ -0,0 +1,40 @@ +--- +title: "SelectMfaEmailOptions" +--- + +Defined in: [interfaces/screens/mfa-email-list.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L18) + +Options for selecting an email address + + +<RequestExample> +```ts +export interface SelectMfaEmailOptions { + /** + * @param {number} index - The index of the phone number to select. + * + */ + index: number; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +<ParamField body='index' type='number'> +{/*> **index**: `number`*/} + +Defined in: [interfaces/screens/mfa-email-list.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L23) + +#### Param + +The index of the phone number to select. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions.mdx new file mode 100644 index 000000000..deec3bca8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions.mdx @@ -0,0 +1,36 @@ +--- +title: "SelectMfaPushDeviceOptions" +--- + +Defined in: [interfaces/screens/mfa-push-list.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L7) + +Options for selecting an MFA push device. + + +<RequestExample> +```ts +export interface SelectMfaPushDeviceOptions { + /** + * The index of the device to select from the list of enrolled devices. + * The index is 0-based. + */ + deviceIndex: number; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='deviceIndex' type='number'> +{/*> **deviceIndex**: `number`*/} + +Defined in: [interfaces/screens/mfa-push-list.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L12) + +The index of the device to select from the list of enrolled devices. +The index is 0-based. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectOrganizationOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectOrganizationOptions.mdx new file mode 100644 index 000000000..75f9f9771 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectOrganizationOptions.mdx @@ -0,0 +1,30 @@ +--- +title: "SelectOrganizationOptions" +--- + +Defined in: [interfaces/screens/organization-picker.ts:4](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L4) + + +<RequestExample> +```ts +export interface SelectOrganizationOptions { + organization: string; + state: string; +} +``` +</RequestExample> + +## Properties + +<ParamField body='organization' type='string'> +{/*> **organization**: `string`*/} + +Defined in: [interfaces/screens/organization-picker.ts:5](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L5) + +</ParamField> + +<ParamField body='state' type='string'> +{/*> **state**: `string`*/} + +Defined in: [interfaces/screens/organization-picker.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L6) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions.mdx new file mode 100644 index 000000000..abbeafd84 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions.mdx @@ -0,0 +1,39 @@ +--- +title: "ShowErrorOptions" +--- + +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L14) + +Options for submitting a WebAuthn browser error. + + +<RequestExample> +```ts +export interface ShowErrorOptions { + /** + * The details of the WebAuthn error. + */ + error: WebAuthnErrorDetails; + /** + * Any additional custom options. + */ + [key: string]: string | number | boolean | undefined | WebAuthnErrorDetails; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails) \| `undefined` + +Any additional custom options. + +## Properties + +<ParamField body='error' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>}> +{/*> **error**: [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails)*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L18) + +The details of the WebAuthn error. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.mdx new file mode 100644 index 000000000..749197b03 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.mdx @@ -0,0 +1,204 @@ +--- +title: "SignupIdMembers" +--- + +Defined in: [interfaces/screens/signup-id.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L54) + + +<RequestExample> +```ts +export interface SignupIdMembers extends BaseMembers { + screen: ScreenMembersOnSignupId; + transaction: TransactionMembersOnSignupId; + signup(payload: SignupOptions): Promise<void>; + federatedSignup(payload: FederatedSignupOptions): Promise<void>; + getSignupIdentifiers(): Identifier[] | null; + pickCountryCode(payload?: CustomOptions): Promise<void>; + validateUsername(username: string): UsernameValidationResult; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId">ScreenMembersOnSignupId</a></span>}> +{/*> **screen**: [`ScreenMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId)*/} + +Defined in: [interfaces/screens/signup-id.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L55) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a></span>}> +{/*> **transaction**: [`TransactionMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId)*/} + +Defined in: [interfaces/screens/signup-id.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L56) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='federatedSignup' type='Promise<void>'> +{/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/signup-id.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L58) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions">FederatedSignupOptions</a></span>}> +[`FederatedSignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='getSignupIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier">Identifier</a>[]</span>}> +{/*> **getSignupIdentifiers**(): [`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier)[] \| `null`*/} + +Defined in: [interfaces/screens/signup-id.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L59) + +#### Returns + +[`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier)[] \| `null` + +</ParamField> + +<ParamField body='pickCountryCode' type='Promise<void>'> +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/signup-id.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L60) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='signup' type='Promise<void>'> +{/*> **signup**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/signup-id.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L57) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions">SignupOptions</a></span>}> +[`SignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='validateUsername' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}> +{/*> **validateUsername**(`username`): [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult)*/} + +Defined in: [interfaces/screens/signup-id.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L61) + +<Expandable title="Parameters"> +<ParamField body='username' type='string'> +`string` +</ParamField> +</Expandable> + +#### Returns + +[`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.mdx new file mode 100644 index 000000000..803a3ac51 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.mdx @@ -0,0 +1,268 @@ +--- +title: "SignupMembers" +--- + +Defined in: [interfaces/screens/signup.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L35) + + +<RequestExample> +```ts +export interface SignupMembers extends BaseMembers { + screen: ScreenMembersOnSignup; + transaction: TransactionMembersOnSignup; + signup(payload: SignupOptions): Promise<void>; + federatedSignup(payload: FederatedSignupOptions): Promise<void>; + pickCountryCode(payload?: CustomOptions): Promise<void>; + validatePassword(password: string): PasswordValidationResult; + /** + * Returns a list of enabled identifiers (e.g. email, phone, username) + * based on the current transaction state. + * + * Identifiers may be required or optional depending on the connection strategy + * and configuration provided during the authentication or signup flow. + * + * @returns An array of enabled {@link Identifier} objects, or `null` if the transaction is not initialized. + * + * @example + * ```ts + * const identifiers = authClient.getSignupIdentifiers(); + * if (identifiers) { + * identifiers.forEach(({ type, required }) => { + * console.log(`${type} is ${required ? 'required' : 'optional'}`); + * }); + * } + * ``` + * @utilityFeature + * @see Identifier + */ + getSignupIdentifiers(): Identifier[] | null; + validateUsername(username: string): UsernameValidationResult; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup">ScreenMembersOnSignup</a></span>}> +{/*> **screen**: [`ScreenMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup)*/} + +Defined in: [interfaces/screens/signup.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L36) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup">TransactionMembersOnSignup</a></span>}> +{/*> **transaction**: [`TransactionMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup)*/} + +Defined in: [interfaces/screens/signup.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L37) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='federatedSignup' type='Promise<void>'> +{/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/signup.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L39) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions">FederatedSignupPayloadOptions</a></span>}> +[`FederatedSignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='getSignupIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier">Identifier</a>[]</span>}> +{/*> **getSignupIdentifiers**(): [`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier)[] \| `null`*/} + +Defined in: [interfaces/screens/signup.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L63) + +**`Utility Feature`** + +Returns a list of enabled identifiers (e.g. email, phone, username) +based on the current transaction state. + +Identifiers may be required or optional depending on the connection strategy +and configuration provided during the authentication or signup flow. + +#### Returns + +[`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier)[] \| `null` + +An array of enabled [Identifier](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier) objects, or `null` if the transaction is not initialized. + +#### Example + +```ts +const identifiers = authClient.getSignupIdentifiers(); +if (identifiers) { + identifiers.forEach(({ type, required }) => { + console.log(`${type} is ${required ? 'required' : 'optional'}`); + }); +} +``` + +#### See + +Identifier + +</ParamField> + +<ParamField body='pickCountryCode' type='Promise<void>'> +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/signup.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L40) + +<Expandable title="Parameters"> +<ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='signup' type='Promise<void>'> +{/*> **signup**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/signup.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L38) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions">SignupPayloadOptions</a></span>}> +[`SignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='validatePassword' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> +{/*> **validatePassword**(`password`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult)*/} + +Defined in: [interfaces/screens/signup.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L41) + +<Expandable title="Parameters"> +<ParamField body='password' type='string'> +`string` +</ParamField> +</Expandable> + +#### Returns + +[`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult) + +</ParamField> + +<ParamField body='validateUsername' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}> +{/*> **validateUsername**(`username`): [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult)*/} + +Defined in: [interfaces/screens/signup.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L64) + +<Expandable title="Parameters"> +<ParamField body='username' type='string'> +`string` +</ParamField> +</Expandable> + +#### Returns + +[`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions.mdx new file mode 100644 index 000000000..234ebda79 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions.mdx @@ -0,0 +1,51 @@ +--- +title: "SignupOptions" +--- + +Defined in: [interfaces/screens/signup-id.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L46) + + +<RequestExample> +```ts +export interface SignupOptions { + email?: string; + username?: string; + phone?: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='captcha?' type='string'> +{/*> `optional` **captcha**: `string`*/} + +Defined in: [interfaces/screens/signup-id.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L50) + +</ParamField> + +<ParamField body='email?' type='string'> +{/*> `optional` **email**: `string`*/} + +Defined in: [interfaces/screens/signup-id.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L47) + +</ParamField> + +<ParamField body='phone?' type='string'> +{/*> `optional` **phone**: `string`*/} + +Defined in: [interfaces/screens/signup-id.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L49) + +</ParamField> + +<ParamField body='username?' type='string'> +{/*> `optional` **username**: `string`*/} + +Defined in: [interfaces/screens/signup-id.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L48) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.mdx new file mode 100644 index 000000000..80df31418 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.mdx @@ -0,0 +1,174 @@ +--- +title: "SignupPasswordMembers" +--- + +Defined in: [interfaces/screens/signup-password.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L55) + + +<RequestExample> +```ts +export interface SignupPasswordMembers extends BaseMembers { + screen: ScreenMembersOnSignupPassword; + transaction: TransactionMembersOnSignupPassword; + signup(payload: SignupPasswordOptions): Promise<void>; + federatedSignup(payload: FederatedSignupOptions): Promise<void>; + validatePassword(password: string): PasswordValidationResult; +} +``` +</RequestExample> + +## Extends + +- [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +<ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> +{/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} + +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#branding) + +</ParamField> + +<ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> +{/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} + +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`client`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#client) + +</ParamField> + +<ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> +{/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} + +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`organization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#organization) + +</ParamField> + +<ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> +{/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} + +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`prompt`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#prompt) + +</ParamField> + +<ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword">ScreenMembersOnSignupPassword</a></span>}> +{/*> **screen**: [`ScreenMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword)*/} + +Defined in: [interfaces/screens/signup-password.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L56) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#screen) + +</ParamField> + +<ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> +{/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} + +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`tenant`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#tenant) + +</ParamField> + +<ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword">TransactionMembersOnSignupPassword</a></span>}> +{/*> **transaction**: [`TransactionMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword)*/} + +Defined in: [interfaces/screens/signup-password.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L57) + +#### Overrides + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`transaction`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#transaction) + +</ParamField> + +<ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> +{/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} + +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`untrustedData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#untrusteddata) + +</ParamField> + +<ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> +{/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} + +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + +#### Inherited from + +[`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers).[`user`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.md#user) + +</ParamField> +## Methods + +<ParamField body='federatedSignup' type='Promise<void>'> +{/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/signup-password.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L59) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions">FederatedSignupPasswordPayloadOptions</a></span>}> +[`FederatedSignupPasswordPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='signup' type='Promise<void>'> +{/*> **signup**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/signup-password.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L58) + +<Expandable title="Parameters"> +<ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions">SignupPasswordOptions</a></span>}> +[`SignupPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions) +</ParamField> +</Expandable> + +#### Returns + +`Promise`\<`void`\> + +</ParamField> + +<ParamField body='validatePassword' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> +{/*> **validatePassword**(`password`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult)*/} + +Defined in: [interfaces/screens/signup-password.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L60) + +<Expandable title="Parameters"> +<ParamField body='password' type='string'> +`string` +</ParamField> +</Expandable> + +#### Returns + +[`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions.mdx new file mode 100644 index 000000000..7afcceede --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions.mdx @@ -0,0 +1,59 @@ +--- +title: "SignupPasswordOptions" +--- + +Defined in: [interfaces/screens/signup-password.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L46) + + +<RequestExample> +```ts +export interface SignupPasswordOptions { + email?: string; + username?: string; + phoneNumber?: string; + password: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='captcha?' type='string'> +{/*> `optional` **captcha**: `string`*/} + +Defined in: [interfaces/screens/signup-password.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L51) + +</ParamField> + +<ParamField body='email?' type='string'> +{/*> `optional` **email**: `string`*/} + +Defined in: [interfaces/screens/signup-password.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L47) + +</ParamField> + +<ParamField body='password' type='string'> +{/*> **password**: `string`*/} + +Defined in: [interfaces/screens/signup-password.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L50) + +</ParamField> + +<ParamField body='phoneNumber?' type='string'> +{/*> `optional` **phoneNumber**: `string`*/} + +Defined in: [interfaces/screens/signup-password.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L49) + +</ParamField> + +<ParamField body='username?' type='string'> +{/*> `optional` **username**: `string`*/} + +Defined in: [interfaces/screens/signup-password.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L48) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions.mdx new file mode 100644 index 000000000..8812a7345 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions.mdx @@ -0,0 +1,59 @@ +--- +title: "SignupPayloadOptions" +--- + +Defined in: [interfaces/screens/signup.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L9) + + +<RequestExample> +```ts +export interface SignupOptions { + email?: string; + username?: string; + phoneNumber?: string; + password?: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='captcha?' type='string'> +{/*> `optional` **captcha**: `string`*/} + +Defined in: [interfaces/screens/signup.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L14) + +</ParamField> + +<ParamField body='email?' type='string'> +{/*> `optional` **email**: `string`*/} + +Defined in: [interfaces/screens/signup.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L10) + +</ParamField> + +<ParamField body='password?' type='string'> +{/*> `optional` **password**: `string`*/} + +Defined in: [interfaces/screens/signup.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L13) + +</ParamField> + +<ParamField body='phoneNumber?' type='string'> +{/*> `optional` **phoneNumber**: `string`*/} + +Defined in: [interfaces/screens/signup.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L12) + +</ParamField> + +<ParamField body='username?' type='string'> +{/*> `optional` **username**: `string`*/} + +Defined in: [interfaces/screens/signup.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L11) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions.mdx new file mode 100644 index 000000000..4c2cbf03e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions.mdx @@ -0,0 +1,43 @@ +--- +title: "StartResendOptions" +--- + +Defined in: [interfaces/utils/resend-control.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L11) + +Options for configuring resend functionality + + +<RequestExample> +```ts +export interface StartResendOptions { + timeoutSeconds?: number; + onStatusChange?: OnStatusChangeCallback; + onTimeout?: () => void; +} +``` +</RequestExample> + +## Properties + +<ParamField body='onStatusChange?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/OnStatusChangeCallback">OnStatusChangeCallback</a></span>}> +{/*> `optional` **onStatusChange**: [`OnStatusChangeCallback`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/OnStatusChangeCallback)*/} + +Defined in: [interfaces/utils/resend-control.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L13) + +</ParamField> + +<ParamField body='Returns' type='unknown'>{/*> `optional` **onTimeout**: () => `void`*/} + +Defined in: [interfaces/utils/resend-control.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L14) + +< +`void` + + +</ParamField> + +<ParamField body='timeoutSeconds?' type='number'> +{/*> `optional` **timeoutSeconds**: `number`*/} + +Defined in: [interfaces/utils/resend-control.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L12) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions.mdx new file mode 100644 index 000000000..cc3b7c802 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions.mdx @@ -0,0 +1,27 @@ +--- +title: "SubmitCaptchaOptions" +--- + +Defined in: [interfaces/screens/interstitial-captcha.ts:3](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts#L3) + + +<RequestExample> +```ts +export interface SubmitCaptchaOptions { + captcha: string; + [key: string]: string | number; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` + +## Properties + +<ParamField body='captcha' type='string'> +{/*> **captcha**: `string`*/} + +Defined in: [interfaces/screens/interstitial-captcha.ts:4](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts#L4) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions.mdx new file mode 100644 index 000000000..537c7e172 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "SubmitCodeOptions" +--- + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L21) + + +<RequestExample> +```ts +export interface SubmitCodeOptions { + code: string | number; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='captcha?' type='string'> +{/*> `optional` **captcha**: `string`*/} + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L23) + +</ParamField> + +<ParamField body='code' type='string'> +{/*> **code**: `string` \| `number`*/} + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L22) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions.mdx new file mode 100644 index 000000000..c69bc02c7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions.mdx @@ -0,0 +1,43 @@ +--- +title: "SubmitOTPOptions" +--- + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L28) + + +<RequestExample> +```ts +export interface SubmitOTPOptions { + username?: string; + code: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='captcha?' type='string'> +{/*> `optional` **captcha**: `string`*/} + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L31) + +</ParamField> + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L30) + +</ParamField> + +<ParamField body='username?' type='string'> +{/*> `optional` **username**: `string`*/} + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L29) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions.mdx new file mode 100644 index 000000000..2d69423e0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions.mdx @@ -0,0 +1,24 @@ +--- +title: "SubmitPasskeyCredentialOptions" +--- + +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L28) + +SubmitPasskeyCredentialOptions + + +<RequestExample> +```ts +export interface SubmitPasskeyCredentialOptions extends CustomOptions { + // No longer requires publicKey here, as it's sourced from this.screen.publicKey +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers.mdx new file mode 100644 index 000000000..f57f5d425 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers.mdx @@ -0,0 +1,46 @@ +--- +title: "TenantMembers" +--- + +Defined in: [interfaces/models/tenant.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/tenant.ts#L8) + + +<RequestExample> +```ts +export interface TenantMembers { + name: string | null; + friendlyName: string | null; + enabledLocales: string[] | null; + enabledFactors: string[] | null; +} +``` +</RequestExample> + +## Properties + +<ParamField body='enabledFactors' type='string'> +{/*> **enabledFactors**: `string`[] \| `null`*/} + +Defined in: [interfaces/models/tenant.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/tenant.ts#L12) + +</ParamField> + +<ParamField body='enabledLocales' type='string'> +{/*> **enabledLocales**: `string`[] \| `null`*/} + +Defined in: [interfaces/models/tenant.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/tenant.ts#L11) + +</ParamField> + +<ParamField body='friendlyName' type='string'> +{/*> **friendlyName**: `string` \| `null`*/} + +Defined in: [interfaces/models/tenant.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/tenant.ts#L10) + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string` \| `null`*/} + +Defined in: [interfaces/models/tenant.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/tenant.ts#L9) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.mdx new file mode 100644 index 000000000..a89bd5bb2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.mdx @@ -0,0 +1,99 @@ +--- +title: "TransactionMembers" +--- + +Defined in: [interfaces/models/transaction.ts:165](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L165) + + +<RequestExample> +```ts +export interface TransactionMembers { + state: string; + locale: string; + countryCode: CountryCode['code'] | null; + countryPrefix: CountryCode['prefix'] | null; + connectionStrategy: string | null; + hasErrors: boolean; + errors: Error[] | null; + currentConnection: Connection | null; + alternateConnections: (Connection | EnterpriseConnection)[] | null; +} +``` +</RequestExample> + +## Extended by + +- [`TransactionMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId) +- [`TransactionMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword) +- [`TransactionMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode) +- [`TransactionMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp) +- [`TransactionMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId) +- [`TransactionMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword) +- [`TransactionMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup) +- [`TransactionMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest) +- [`TransactionMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin) +- [`TransactionMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword) + +## Properties + +<ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) + +</ParamField> + +<ParamField body='connectionStrategy' type='string'> +{/*> **connectionStrategy**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) + +</ParamField> + +<ParamField body='countryCode' type='string'> +{/*> **countryCode**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) + +</ParamField> + +<ParamField body='countryPrefix' type='string'> +{/*> **countryPrefix**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) + +</ParamField> + +<ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) + +</ParamField> + +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> +{/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +{/*> **hasErrors**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) + +</ParamField> + +<ParamField body='locale' type='string'> +{/*> **locale**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) + +</ParamField> + +<ParamField body='state' type='string'> +{/*> **state**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin.mdx new file mode 100644 index 000000000..686bafb54 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin.mdx @@ -0,0 +1,159 @@ +--- +title: "TransactionMembersOnLogin" +--- + +Defined in: [interfaces/screens/login.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L37) + +Extended transaction members interface for the login screen + + +<RequestExample> +```ts +export interface TransactionMembersOnLogin extends TransactionMembers { + isSignupEnabled: boolean; + isForgotPasswordEnabled: boolean; + isPasskeyEnabled: boolean; + passwordPolicy: PasswordPolicy | null; + allowedIdentifiers: IdentifierType[] | null; +} +``` +</RequestExample> + +## Extends + +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +<ParamField body='allowedIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> +{/*> **allowedIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} + +Defined in: [interfaces/screens/login.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L42) + +</ParamField> + +<ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='connectionStrategy' type='string'> +{/*> **connectionStrategy**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='countryCode' type='string'> +{/*> **countryCode**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string'> +{/*> **countryPrefix**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> +{/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +{/*> **hasErrors**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='isForgotPasswordEnabled' type='boolean'> +{/*> **isForgotPasswordEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/login.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L39) + +</ParamField> + +<ParamField body='isPasskeyEnabled' type='boolean'> +{/*> **isPasskeyEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/login.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L40) + +</ParamField> + +<ParamField body='isSignupEnabled' type='boolean'> +{/*> **isSignupEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/login.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L38) + +</ParamField> + +<ParamField body='locale' type='string'> +{/*> **locale**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='passwordPolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy">PasswordPolicy</a></span>}> +{/*> **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy) \| `null`*/} + +Defined in: [interfaces/screens/login.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L41) + +</ParamField> + +<ParamField body='state' type='string'> +{/*> **state**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#state) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId.mdx new file mode 100644 index 000000000..f42bf99c6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId.mdx @@ -0,0 +1,165 @@ +--- +title: "TransactionMembersOnLoginId" +--- + +Defined in: [interfaces/screens/login-id.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L37) + + +<RequestExample> +```ts +export interface TransactionMembersOnLoginId extends TransactionMembers { + isSignupEnabled: boolean; + isPasskeyEnabled: boolean; + isForgotPasswordEnabled: boolean; + isUsernameRequired: boolean; + usernamePolicy: UsernamePolicy | null; + allowedIdentifiers: IdentifierType[] | null; +} +``` +</RequestExample> + +## Extends + +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +<ParamField body='allowedIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> +{/*> **allowedIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} + +Defined in: [interfaces/screens/login-id.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L43) + +</ParamField> + +<ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='connectionStrategy' type='string'> +{/*> **connectionStrategy**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='countryCode' type='string'> +{/*> **countryCode**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string'> +{/*> **countryPrefix**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> +{/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +{/*> **hasErrors**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='isForgotPasswordEnabled' type='boolean'> +{/*> **isForgotPasswordEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/login-id.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L40) + +</ParamField> + +<ParamField body='isPasskeyEnabled' type='boolean'> +{/*> **isPasskeyEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/login-id.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L39) + +</ParamField> + +<ParamField body='isSignupEnabled' type='boolean'> +{/*> **isSignupEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/login-id.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L38) + +</ParamField> + +<ParamField body='isUsernameRequired' type='boolean'> +{/*> **isUsernameRequired**: `boolean`*/} + +Defined in: [interfaces/screens/login-id.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L41) + +</ParamField> + +<ParamField body='locale' type='string'> +{/*> **locale**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='state' type='string'> +{/*> **state**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#state) + +</ParamField> + +<ParamField body='usernamePolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy">UsernamePolicy</a></span>}> +{/*> **usernamePolicy**: [`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy) \| `null`*/} + +Defined in: [interfaces/screens/login-id.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L42) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword.mdx new file mode 100644 index 000000000..f8e37a6e4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword.mdx @@ -0,0 +1,178 @@ +--- +title: "TransactionMembersOnLoginPassword" +--- + +Defined in: [interfaces/screens/login-password.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L27) + + +<RequestExample> +```ts +export interface TransactionMembersOnLoginPassword extends TransactionMembers { + isSignupEnabled: boolean; + isForgotPasswordEnabled: boolean; + isPasskeyEnabled: boolean; + getPasswordPolicy(): PasswordPolicy | null; + getUsernamePolicy(): UsernamePolicy | null; + getAllowedIdentifiers(): IdentifierType[] | null; +} +``` +</RequestExample> + +## Extends + +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +<ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='connectionStrategy' type='string'> +{/*> **connectionStrategy**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='countryCode' type='string'> +{/*> **countryCode**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string'> +{/*> **countryPrefix**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> +{/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +{/*> **hasErrors**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='isForgotPasswordEnabled' type='boolean'> +{/*> **isForgotPasswordEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/login-password.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L29) + +</ParamField> + +<ParamField body='isPasskeyEnabled' type='boolean'> +{/*> **isPasskeyEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/login-password.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L30) + +</ParamField> + +<ParamField body='isSignupEnabled' type='boolean'> +{/*> **isSignupEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/login-password.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L28) + +</ParamField> + +<ParamField body='locale' type='string'> +{/*> **locale**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='state' type='string'> +{/*> **state**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#state) + +</ParamField> +## Methods + +<ParamField body='getAllowedIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> +{/*> **getAllowedIdentifiers**(): [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} + +Defined in: [interfaces/screens/login-password.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L33) + +#### Returns + +[`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null` + +</ParamField> + +<ParamField body='getPasswordPolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy">PasswordPolicy</a></span>}> +{/*> **getPasswordPolicy**(): [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy) \| `null`*/} + +Defined in: [interfaces/screens/login-password.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L31) + +#### Returns + +[`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy) \| `null` + +</ParamField> + +<ParamField body='getUsernamePolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy">UsernamePolicy</a></span>}> +{/*> **getUsernamePolicy**(): [`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy) \| `null`*/} + +Defined in: [interfaces/screens/login-password.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L32) + +#### Returns + +[`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy) \| `null` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx new file mode 100644 index 000000000..c50eebca2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx @@ -0,0 +1,125 @@ +--- +title: "TransactionMembersOnLoginPasswordlessEmailCode" +--- + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L17) + + +<RequestExample> +```ts +export interface TransactionMembersOnLoginPasswordlessEmailCode extends TransactionMembers { + isSignupEnabled: boolean | null; +} +``` +</RequestExample> + +## Extends + +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +<ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='connectionStrategy' type='string'> +{/*> **connectionStrategy**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='countryCode' type='string'> +{/*> **countryCode**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string'> +{/*> **countryPrefix**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> +{/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +{/*> **hasErrors**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='isSignupEnabled' type='boolean'> +{/*> **isSignupEnabled**: `boolean` \| `null`*/} + +Defined in: [interfaces/screens/login-passwordless-email-code.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L18) + +</ParamField> + +<ParamField body='locale' type='string'> +{/*> **locale**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='state' type='string'> +{/*> **state**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#state) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx new file mode 100644 index 000000000..c39bb60b5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx @@ -0,0 +1,125 @@ +--- +title: "TransactionMembersOnLoginPasswordlessSmsOtp" +--- + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L24) + + +<RequestExample> +```ts +export interface TransactionMembersOnLoginPasswordlessSmsOtp extends TransactionMembers { + isSignupEnabled: boolean; +} +``` +</RequestExample> + +## Extends + +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +<ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='connectionStrategy' type='string'> +{/*> **connectionStrategy**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='countryCode' type='string'> +{/*> **countryCode**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string'> +{/*> **countryPrefix**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> +{/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +{/*> **hasErrors**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='isSignupEnabled' type='boolean'> +{/*> **isSignupEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L25) + +</ParamField> + +<ParamField body='locale' type='string'> +{/*> **locale**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='state' type='string'> +{/*> **state**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#state) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword.mdx new file mode 100644 index 000000000..2f6fc4e78 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword.mdx @@ -0,0 +1,125 @@ +--- +title: "TransactionMembersOnResetPassword" +--- + +Defined in: [interfaces/screens/reset-password.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L19) + + +<RequestExample> +```ts +export interface TransactionMembersOnResetPassword extends TransactionMembers { + passwordPolicy: PasswordPolicy | null; +} +``` +</RequestExample> + +## Extends + +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +<ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='connectionStrategy' type='string'> +{/*> **connectionStrategy**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='countryCode' type='string'> +{/*> **countryCode**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string'> +{/*> **countryPrefix**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> +{/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +{/*> **hasErrors**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='locale' type='string'> +{/*> **locale**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='passwordPolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy">PasswordPolicy</a></span>}> +{/*> **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy) \| `null`*/} + +Defined in: [interfaces/screens/reset-password.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L20) + +</ParamField> + +<ParamField body='state' type='string'> +{/*> **state**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#state) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest.mdx new file mode 100644 index 000000000..b08901b0f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest.mdx @@ -0,0 +1,141 @@ +--- +title: "TransactionMembersOnResetPasswordRequest" +--- + +Defined in: [interfaces/screens/reset-password-request.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L13) + + +<RequestExample> +```ts +export interface TransactionMembersOnResetPasswordRequest extends TransactionMembers { + allowedIdentifiers: IdentifierType[] | null; + requiredIdentifiers: IdentifierType[] | null; + hasFlexibleIdentifier: boolean; +} +``` +</RequestExample> + +## Extends + +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +<ParamField body='allowedIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> +{/*> **allowedIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} + +Defined in: [interfaces/screens/reset-password-request.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L14) + +</ParamField> + +<ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='connectionStrategy' type='string'> +{/*> **connectionStrategy**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='countryCode' type='string'> +{/*> **countryCode**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string'> +{/*> **countryPrefix**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> +{/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +{/*> **hasErrors**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='hasFlexibleIdentifier' type='boolean'> +{/*> **hasFlexibleIdentifier**: `boolean`*/} + +Defined in: [interfaces/screens/reset-password-request.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L16) + +</ParamField> + +<ParamField body='locale' type='string'> +{/*> **locale**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='requiredIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> +{/*> **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} + +Defined in: [interfaces/screens/reset-password-request.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L15) + +</ParamField> + +<ParamField body='state' type='string'> +{/*> **state**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#state) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup.mdx new file mode 100644 index 000000000..1485dfbd7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup.mdx @@ -0,0 +1,157 @@ +--- +title: "TransactionMembersOnSignup" +--- + +Defined in: [interfaces/screens/signup.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L27) + + +<RequestExample> +```ts +export interface TransactionMembersOnSignup extends TransactionMembers { + isPasskeyEnabled: boolean; + usernamePolicy: UsernamePolicy | null; + requiredIdentifiers: IdentifierType[] | null; + optionalIdentifiers: IdentifierType[] | null; + passwordPolicy: PasswordPolicy | null; +} +``` +</RequestExample> + +## Extends + +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +<ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='connectionStrategy' type='string'> +{/*> **connectionStrategy**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='countryCode' type='string'> +{/*> **countryCode**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string'> +{/*> **countryPrefix**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> +{/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +{/*> **hasErrors**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='isPasskeyEnabled' type='boolean'> +{/*> **isPasskeyEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/signup.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L28) + +</ParamField> + +<ParamField body='locale' type='string'> +{/*> **locale**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='optionalIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> +{/*> **optionalIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} + +Defined in: [interfaces/screens/signup.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L31) + +</ParamField> + +<ParamField body='passwordPolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy">PasswordPolicy</a></span>}> +{/*> **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy) \| `null`*/} + +Defined in: [interfaces/screens/signup.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L32) + +</ParamField> + +<ParamField body='requiredIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> +{/*> **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} + +Defined in: [interfaces/screens/signup.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L30) + +</ParamField> + +<ParamField body='state' type='string'> +{/*> **state**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#state) + +</ParamField> + +<ParamField body='usernamePolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy">UsernamePolicy</a></span>}> +{/*> **usernamePolicy**: [`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy) \| `null`*/} + +Defined in: [interfaces/screens/signup.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L29) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId.mdx new file mode 100644 index 000000000..445253e94 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId.mdx @@ -0,0 +1,149 @@ +--- +title: "TransactionMembersOnSignupId" +--- + +Defined in: [interfaces/screens/signup-id.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L29) + + +<RequestExample> +```ts +export interface TransactionMembersOnSignupId extends TransactionMembers { + isPasskeyEnabled: boolean; + usernamePolicy: UsernamePolicy | null; + requiredIdentifiers: IdentifierType[] | null; + optionalIdentifiers: IdentifierType[] | null; +} +``` +</RequestExample> + +## Extends + +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +<ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='connectionStrategy' type='string'> +{/*> **connectionStrategy**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='countryCode' type='string'> +{/*> **countryCode**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string'> +{/*> **countryPrefix**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> +{/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +{/*> **hasErrors**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='isPasskeyEnabled' type='boolean'> +{/*> **isPasskeyEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/signup-id.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L30) + +</ParamField> + +<ParamField body='locale' type='string'> +{/*> **locale**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='optionalIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> +{/*> **optionalIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} + +Defined in: [interfaces/screens/signup-id.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L33) + +</ParamField> + +<ParamField body='requiredIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> +{/*> **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} + +Defined in: [interfaces/screens/signup-id.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L32) + +</ParamField> + +<ParamField body='state' type='string'> +{/*> **state**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#state) + +</ParamField> + +<ParamField body='usernamePolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy">UsernamePolicy</a></span>}> +{/*> **usernamePolicy**: [`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy) \| `null`*/} + +Defined in: [interfaces/screens/signup-id.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L31) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword.mdx new file mode 100644 index 000000000..238b43c18 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword.mdx @@ -0,0 +1,149 @@ +--- +title: "TransactionMembersOnSignupPassword" +--- + +Defined in: [interfaces/screens/signup-password.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L39) + + +<RequestExample> +```ts +export interface TransactionMembersOnSignupPassword extends TransactionMembers { + isPasskeyEnabled: boolean; + passwordPolicy: PasswordPolicy | null; + requiredIdentifiers: IdentifierType[] | null; + optionalIdentifiers: IdentifierType[] | null; +} +``` +</RequestExample> + +## Extends + +- [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +<ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`alternateConnections`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#alternateconnections) + +</ParamField> + +<ParamField body='connectionStrategy' type='string'> +{/*> **connectionStrategy**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`connectionStrategy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#connectionstrategy) + +</ParamField> + +<ParamField body='countryCode' type='string'> +{/*> **countryCode**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countrycode) + +</ParamField> + +<ParamField body='countryPrefix' type='string'> +{/*> **countryPrefix**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`countryPrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#countryprefix) + +</ParamField> + +<ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> +{/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`currentConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#currentconnection) + +</ParamField> + +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> +{/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`errors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#errors) + +</ParamField> + +<ParamField body='hasErrors' type='boolean'> +{/*> **hasErrors**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`hasErrors`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#haserrors) + +</ParamField> + +<ParamField body='isPasskeyEnabled' type='boolean'> +{/*> **isPasskeyEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/signup-password.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L40) + +</ParamField> + +<ParamField body='locale' type='string'> +{/*> **locale**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`locale`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#locale) + +</ParamField> + +<ParamField body='optionalIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> +{/*> **optionalIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} + +Defined in: [interfaces/screens/signup-password.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L43) + +</ParamField> + +<ParamField body='passwordPolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy">PasswordPolicy</a></span>}> +{/*> **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy) \| `null`*/} + +Defined in: [interfaces/screens/signup-password.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L41) + +</ParamField> + +<ParamField body='requiredIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> +{/*> **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} + +Defined in: [interfaces/screens/signup-password.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L42) + +</ParamField> + +<ParamField body='state' type='string'> +{/*> **state**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) + +#### Inherited from + +[`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers).[`state`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.md#state) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx new file mode 100644 index 000000000..e66dd8332 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "TryAnotherMethodMfaOtpChallengeOptions" +--- + +Defined in: [interfaces/screens/mfa-otp-challenge.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L38) + +Options for trying another method + + +<RequestExample> +```ts +export interface TryAnotherMethodOptions { + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions.mdx new file mode 100644 index 000000000..a886dd5b2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "TryAnotherMethodOptions" +--- + +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L37) + +Options for trying another method. + + +<RequestExample> +```ts +export interface TryAnotherMethodOptions { + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions.mdx new file mode 100644 index 000000000..a631d0335 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "TryAnotherMethodPayloadOptions" +--- + +Defined in: [interfaces/screens/mfa-email-challenge.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L49) + +Options for trying another method + + +<RequestExample> +```ts +export interface TryAnotherMethodOptions { + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.mdx new file mode 100644 index 000000000..e7e5a16b4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.mdx @@ -0,0 +1,43 @@ +--- +title: "UntrustedDataMembers" +--- + +Defined in: [interfaces/models/untrusted-data.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L14) + + +<RequestExample> +```ts +export interface UntrustedDataMembers { + submittedFormData: { [key: string]: string | number | boolean | undefined | null } | null; + authorizationParams: { + login_hint?: string; + screen_hint?: string; + ui_locales?: string; + [key: `ext-${string}`]: string; + } | null; +} +``` +</RequestExample> + +## Extended by + +- [`UntrustedDataMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge) +- [`UntrustedDataMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge) +- [`UntrustedDataMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush) +- [`UntrustedDataMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge) +- [`UntrustedDataMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge) + +## Properties + +<ParamField body='authorizationParams' type='key'> +{/*> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null`*/} + +Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) + +</ParamField> + +<ParamField body='submittedFormData' type='key'> +{/*> **submittedFormData**: \{\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `null` \| `undefined`; \} \| `null`*/} + +Defined in: [interfaces/models/untrusted-data.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L15) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx new file mode 100644 index 000000000..789fd1c34 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx @@ -0,0 +1,45 @@ +--- +title: "UntrustedDataMembersOnMfaEmailChallenge" +--- + +Defined in: [interfaces/screens/mfa-email-challenge.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L20) + +Interface for untrusted data specific to mfa-email-challenge screen + + +<RequestExample> +```ts +export interface UntrustedDataMembersOnMfaEmailChallenge extends UntrustedDataMembers { + submittedFormData: { + rememberDevice: boolean; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers) + +## Properties + +<ParamField body='authorizationParams' type='key'> +{/*> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null`*/} + +Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) + +#### Inherited from + +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers).[`authorizationParams`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.md#authorizationparams) + +</ParamField> + +<ParamField body='submittedFormData' type='rememberDevice'> +{/*> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-email-challenge.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L21) + +#### Overrides + +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers).[`submittedFormData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.md#submittedformdata) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx new file mode 100644 index 000000000..777cc00b6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx @@ -0,0 +1,45 @@ +--- +title: "UntrustedDataMembersOnMfaOtpChallenge" +--- + +Defined in: [interfaces/screens/mfa-otp-challenge.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L17) + +Interface for untrusted data specific to mfa-otp-challenge screen + + +<RequestExample> +```ts +export interface UntrustedDataMembersOnMfaOtpChallenge extends UntrustedDataMembers { + submittedFormData: { + rememberDevice: boolean; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers) + +## Properties + +<ParamField body='authorizationParams' type='key'> +{/*> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null`*/} + +Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) + +#### Inherited from + +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers).[`authorizationParams`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.md#authorizationparams) + +</ParamField> + +<ParamField body='submittedFormData' type='rememberDevice'> +{/*> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-otp-challenge.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L18) + +#### Overrides + +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers).[`submittedFormData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.md#submittedformdata) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx new file mode 100644 index 000000000..81e3f70ca --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx @@ -0,0 +1,41 @@ +--- +title: "UntrustedDataMembersOnMfaPushChallengePush" +--- + +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L25) + +Interface for untrusted data specific to mfa-push-challenge-push screen + + +<RequestExample> +```ts +export interface UntrustedDataMembersOnMfaPushChallengePush +``` +</RequestExample> + +## Extends + +- [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers) + +## Properties + +<ParamField body='authorizationParams' type='key'> +{/*> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null`*/} + +Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) + +#### Inherited from + +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers).[`authorizationParams`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.md#authorizationparams) + +</ParamField> + +<ParamField body='submittedFormData' type='rememberDevice'> +{/*> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L27) + +#### Overrides + +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers).[`submittedFormData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.md#submittedformdata) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx new file mode 100644 index 000000000..015d5cc88 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx @@ -0,0 +1,45 @@ +--- +title: "UntrustedDataMembersOnMfaSmsChallenge" +--- + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L51) + +Interface for untrusted data specific to mfa-sms-challenge screen + + +<RequestExample> +```ts +export interface UntrustedDataMembersOnMfaSmsChallenge extends UntrustedDataMembers { + submittedFormData: { + rememberDevice: boolean; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers) + +## Properties + +<ParamField body='authorizationParams' type='key'> +{/*> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null`*/} + +Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) + +#### Inherited from + +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers).[`authorizationParams`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.md#authorizationparams) + +</ParamField> + +<ParamField body='submittedFormData' type='rememberDevice'> +{/*> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-sms-challenge.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L52) + +#### Overrides + +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers).[`submittedFormData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.md#submittedformdata) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx new file mode 100644 index 000000000..d896c9067 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx @@ -0,0 +1,45 @@ +--- +title: "UntrustedDataMembersOnMfaVoiceChallenge" +--- + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:146](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L146) + +Interface for untrusted data specific to mfa-voice-challenge screen + + +<RequestExample> +```ts +export interface UntrustedDataMembersOnMfaVoiceChallenge extends UntrustedDataMembers { + submittedFormData: { + rememberDevice: boolean; + } | null; +} +``` +</RequestExample> + +## Extends + +- [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers) + +## Properties + +<ParamField body='authorizationParams' type='key'> +{/*> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null`*/} + +Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) + +#### Inherited from + +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers).[`authorizationParams`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.md#authorizationparams) + +</ParamField> + +<ParamField body='submittedFormData' type='rememberDevice'> +{/*> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null`*/} + +Defined in: [interfaces/screens/mfa-voice-challenge.ts:147](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L147) + +#### Overrides + +[`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers).[`submittedFormData`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.md#submittedformdata) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers.mdx new file mode 100644 index 000000000..8ed340647 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers.mdx @@ -0,0 +1,110 @@ +--- +title: "UserMembers" +--- + +Defined in: [interfaces/models/user.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L39) + + +<RequestExample> +```ts +export interface UserMembers { + id: string | null; + email: string | null; + username: string | null; + phoneNumber: string | null; + picture: string | null; + enrolledFactors: Array<string> | null; + enrolledEmails: Array<EnrolledEmail> | null; + enrolledPhoneNumbers: Array<EnrolledPhoneNumber> | null; + enrolledDevices: Array<EnrolledDevice> | null; + organizations: Organizations[] | null; + userMetadata: { [key: string]: string } | null; + appMetadata: { [key: string]: string } | null; +} +``` +</RequestExample> + +## Properties + +<ParamField body='appMetadata' type='key'> +{/*> **appMetadata**: \{\[`key`: `string`\]: `string`; \} \| `null`*/} + +Defined in: [interfaces/models/user.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L51) + +</ParamField> + +<ParamField body='email' type='string'> +{/*> **email**: `string` \| `null`*/} + +Defined in: [interfaces/models/user.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L41) + +</ParamField> + +<ParamField body='enrolledDevices' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice">EnrolledDevice</a></span>}> +{/*> **enrolledDevices**: [`EnrolledDevice`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice)[] \| `null`*/} + +Defined in: [interfaces/models/user.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L48) + +</ParamField> + +<ParamField body='enrolledEmails' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail">EnrolledEmail</a></span>}> +{/*> **enrolledEmails**: [`EnrolledEmail`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail)[] \| `null`*/} + +Defined in: [interfaces/models/user.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L46) + +</ParamField> + +<ParamField body='enrolledFactors' type='string'> +{/*> **enrolledFactors**: `string`[] \| `null`*/} + +Defined in: [interfaces/models/user.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L45) + +</ParamField> + +<ParamField body='enrolledPhoneNumbers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber">EnrolledPhoneNumber</a></span>}> +{/*> **enrolledPhoneNumbers**: [`EnrolledPhoneNumber`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber)[] \| `null`*/} + +Defined in: [interfaces/models/user.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L47) + +</ParamField> + +<ParamField body='id' type='string'> +{/*> **id**: `string` \| `null`*/} + +Defined in: [interfaces/models/user.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L40) + +</ParamField> + +<ParamField body='organizations' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Organizations">Organizations</a></span>}> +{/*> **organizations**: [`Organizations`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Organizations)[] \| `null`*/} + +Defined in: [interfaces/models/user.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L49) + +</ParamField> + +<ParamField body='phoneNumber' type='string'> +{/*> **phoneNumber**: `string` \| `null`*/} + +Defined in: [interfaces/models/user.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L43) + +</ParamField> + +<ParamField body='picture' type='string'> +{/*> **picture**: `string` \| `null`*/} + +Defined in: [interfaces/models/user.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L44) + +</ParamField> + +<ParamField body='userMetadata' type='key'> +{/*> **userMetadata**: \{\[`key`: `string`\]: `string`; \} \| `null`*/} + +Defined in: [interfaces/models/user.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L50) + +</ParamField> + +<ParamField body='username' type='string'> +{/*> **username**: `string` \| `null`*/} + +Defined in: [interfaces/models/user.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L42) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy.mdx new file mode 100644 index 000000000..6706754e5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy.mdx @@ -0,0 +1,57 @@ +--- +title: "UsernamePolicy" +--- + +Defined in: [interfaces/models/transaction.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L47) + + +<RequestExample> +```ts +export interface UsernamePolicy { + isActive?: boolean + maxLength: number; + minLength: number; + allowedFormats?: { + usernameInEmailFormat?: boolean; + usernameInPhoneFormat?: boolean; + }; +} +``` +</RequestExample> + +## Properties + +<ParamField body='allowedFormats?' type='object'> +{/*> `optional` **allowedFormats**: `object`*/} + +Defined in: [interfaces/models/transaction.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L51) + +#### usernameInEmailFormat? + +{/*> `optional` **usernameInEmailFormat**: `boolean`*/} + +#### usernameInPhoneFormat? + +{/*> `optional` **usernameInPhoneFormat**: `boolean`*/} + +</ParamField> + +<ParamField body='isActive?' type='boolean'> +{/*> `optional` **isActive**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L48) + +</ParamField> + +<ParamField body='maxLength' type='number'> +{/*> **maxLength**: `number`*/} + +Defined in: [interfaces/models/transaction.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L49) + +</ParamField> + +<ParamField body='minLength' type='number'> +{/*> **minLength**: `number`*/} + +Defined in: [interfaces/models/transaction.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L50) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError.mdx new file mode 100644 index 000000000..5b988bbb7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError.mdx @@ -0,0 +1,67 @@ +--- +title: "UsernameValidationError" +--- + +Defined in: [interfaces/utils/validate-username.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L6) + +Represents a single username validation error returned during validation. + +Each error has a machine-readable `code` and a human-readable `message`. + + +<RequestExample> +```ts +export interface UsernameValidationError { + /** + * A unique identifier for the validation rule that failed. + * + * Example: `"username-too-short"`, `"username-invalid-characters"` + */ + code: string; + + /** + * A human-readable description of the error. + * + * Example: `"Username must be at least 3 characters long."` + */ + message: string; + + /** + * The field associated with the validation error, typically "username", "email", or "phone". + */ + field: string; +} +``` +</RequestExample> + +## Properties + +<ParamField body='code' type='string'> +{/*> **code**: `string`*/} + +Defined in: [interfaces/utils/validate-username.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L12) + +A unique identifier for the validation rule that failed. + +Example: `"username-too-short"`, `"username-invalid-characters"` + +</ParamField> + +<ParamField body='field' type='string'> +{/*> **field**: `string`*/} + +Defined in: [interfaces/utils/validate-username.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L24) + +The field associated with the validation error, typically "username", "email", or "phone". + +</ParamField> + +<ParamField body='message' type='string'> +{/*> **message**: `string`*/} + +Defined in: [interfaces/utils/validate-username.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L19) + +A human-readable description of the error. + +Example: `"Username must be at least 3 characters long."` +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult.mdx new file mode 100644 index 000000000..841d9adb9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult.mdx @@ -0,0 +1,49 @@ +--- +title: "UsernameValidationResult" +--- + +Defined in: [interfaces/utils/validate-username.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L31) + +The result of validating a username against one or more rules. + + +<RequestExample> +```ts +export interface UsernameValidationResult { + /** + * Indicates whether the username passed all validation rules. + */ + isValid: boolean; + + /** + * An array of {@link UsernameValidationError} objects representing + * the individual rules that failed, if any. + * + * This array is empty if {@link UsernameValidationResult.isValid} is `true`. + */ + errors: UsernameValidationError[]; +} +``` +</RequestExample> + +## Properties + +<ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError">UsernameValidationError</a></span>}> +{/*> **errors**: [`UsernameValidationError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError)[]*/} + +Defined in: [interfaces/utils/validate-username.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L43) + +An array of [UsernameValidationError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError) objects representing +the individual rules that failed, if any. + +This array is empty if [UsernameValidationResult.isValid](#isvalid) is `true`. + +</ParamField> + +<ParamField body='isValid' type='boolean'> +{/*> **isValid**: `boolean`*/} + +Defined in: [interfaces/utils/validate-username.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L35) + +Indicates whether the username passed all validation rules. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions.mdx new file mode 100644 index 000000000..65737689f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions.mdx @@ -0,0 +1,40 @@ +--- +title: "VerifyPlatformAuthenticatorOptions" +--- + +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L40) + +VerifyPlatformAuthenticatorOptions + + +<RequestExample> +```ts +export interface VerifyPlatformAuthenticatorOptions extends CustomOptions { + /** + * Optional. If true and `screen.showRememberDevice` is true, this indicates the user + * has chosen to remember this device, typically for 30 days, to bypass MFA on subsequent logins. + * @type {boolean} + */ + rememberDevice?: boolean; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='rememberDevice?' type='boolean'> +{/*> `optional` **rememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L46) + +Optional. If true, attempts to remember the browser for future MFA challenges. +Corresponds to the `rememberBrowser` form field. This is only applicable if `screen.showRememberDevice` is true. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions.mdx new file mode 100644 index 000000000..ec1bcdb3a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "VerifySecurityKeyOptions" +--- + +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L31) + +VerifySecurityKeyOptions + + +<RequestExample> +```ts +export interface VerifySecurityKeyOptions extends CustomOptions { + rememberDevice?: boolean; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='rememberDevice?' type='boolean'> +{/*> `optional` **rememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L32) + +Optional. If true, attempts to remember the browser for future MFA challenges. +Corresponds to the `rememberBrowser` form field. +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx new file mode 100644 index 000000000..950f030f5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx @@ -0,0 +1,25 @@ +--- +title: "WebAuthnEnrollSuccessContinueOptions" +--- + +Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L47) + +ContinueOptions + + +<RequestExample> +```ts +export interface ContinueOptions extends CustomOptions { + // No screen-specific properties are required for the 'continue' action beyond CustomOptions. + // The server uses `action: "default"` for this operation. +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails.mdx new file mode 100644 index 000000000..b28e4d44c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails.mdx @@ -0,0 +1,52 @@ +--- +title: "WebAuthnErrorDetails" +--- + +Defined in: [interfaces/common/index.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L9) + +Details of a WebAuthn browser error. + + +<RequestExample> +```ts +export interface WebAuthnErrorDetails { + /** + * The name of the error (e.g., "NotAllowedError"). + */ + name: string; + /** + * The error message. + */ + message: string; + /** + * Any additional error properties. + */ + [key: string]: string | number | boolean | undefined; +} +``` +</RequestExample> + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional error properties. + +## Properties + +<ParamField body='message' type='string'> +{/*> **message**: `string`*/} + +Defined in: [interfaces/common/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L17) + +The error message. + +</ParamField> + +<ParamField body='name' type='string'> +{/*> **name**: `string`*/} + +Defined in: [interfaces/common/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L13) + +The name of the error (e.g., "NotAllowedError"). +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions.mdx new file mode 100644 index 000000000..184a7e03f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions.mdx @@ -0,0 +1,30 @@ +--- +title: "WithRememberOptions" +--- + +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L32) + + +<RequestExample> +```ts +export interface WithRememberOptions extends CustomOptions { + rememberDevice?: boolean; +} +``` +</RequestExample> + +## Extends + +- [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + +<ParamField body='rememberDevice?' type='boolean'> +{/*> `optional` **rememberDevice**: `boolean`*/} + +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L33) +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/AuthenticatorTransport.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/AuthenticatorTransport.mdx new file mode 100644 index 000000000..27a6b9c1b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/AuthenticatorTransport.mdx @@ -0,0 +1,16 @@ +--- +title: "Type Alias: AuthenticatorTransport" +--- + +<ParamField body="AuthenticatorTransport" type='usb | nfc | ble | internal | hybrid'> +{/*> **AuthenticatorTransport** = `"usb"` \| `"nfc"` \| `"ble"` \| `"internal"` \| `"hybrid"`*/} + +Defined in: [interfaces/models/screen.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L8) + + +<RequestExample> +```ts +export type AuthenticatorTransport = 'usb' | 'nfc' | 'ble' | 'internal' | 'hybrid'; +``` +</RequestExample> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType.mdx new file mode 100644 index 000000000..fc8fa7b7f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType.mdx @@ -0,0 +1,18 @@ +--- +title: "Type Alias: IdentifierType" +--- + +<ParamField body="IdentifierType" type='phone | email | username'> +{/*> **IdentifierType** = `"phone"` \| `"email"` \| `"username"`*/} + +Defined in: [src/constants/identifiers.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/constants/identifiers.ts#L20) + +Type representing valid identifier values + + +<RequestExample> +```ts +export type IdentifierType = 'phone' | 'email' | 'username'; +``` +</RequestExample> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaEnrollFactorType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaEnrollFactorType.mdx new file mode 100644 index 000000000..45765ab40 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaEnrollFactorType.mdx @@ -0,0 +1,18 @@ +--- +title: "Type Alias: MfaEnrollFactorType" +--- + +<ParamField body="MfaEnrollFactorType" type='push-notification | otp | sms | phone | voice | webauthn-roaming'> +{/*> **MfaEnrollFactorType** = `"push-notification"` \| `"otp"` \| `"sms"` \| `"phone"` \| `"voice"` \| `"webauthn-roaming"`*/} + +Defined in: [src/constants/mfa-factors.ts:73](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/constants/mfa-factors.ts#L73) + +Type definition for MFA enroll factor constants + + +<RequestExample> +```ts +export type MfaEnrollFactorType = 'push-notification' | 'otp' | 'sms' | 'phone' | 'voice' | 'webauthn-roaming'; +``` +</RequestExample> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaLoginFactorType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaLoginFactorType.mdx new file mode 100644 index 000000000..bcd4db41f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaLoginFactorType.mdx @@ -0,0 +1,28 @@ +--- +title: "Type Alias: MfaLoginFactorType" +--- + +<ParamField body="MfaLoginFactorType" type='push-notification | otp | sms | phone | voice | email | recovery-code | webauthn-roaming | webauthn-platform | duo'> +{/*> **MfaLoginFactorType** = `"push-notification"` \| `"otp"` \| `"sms"` \| `"phone"` \| `"voice"` \| `"email"` \| `"recovery-code"` \| `"webauthn-roaming"` \| `"webauthn-platform"` \| `"duo"`*/} + +Defined in: [src/constants/mfa-factors.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/constants/mfa-factors.ts#L36) + +Type definition for MFA login factor constants + + +<RequestExample> +```ts +export type MfaLoginFactorType = + | 'push-notification' + | 'otp' + | 'sms' + | 'phone' + | 'voice' + | 'email' + | 'recovery-code' + | 'webauthn-roaming' + | 'webauthn-platform' + | 'duo'; +``` +</RequestExample> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions.mdx new file mode 100644 index 000000000..580bcd78f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions.mdx @@ -0,0 +1,113 @@ +--- +title: "Type Alias: MfaPollingOptions" +--- + +<ParamField body="MfaPollingOptions" type='object'> +{/*> **MfaPollingOptions** = `object`*/} + +Defined in: [interfaces/utils/polling-control.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L11) + +Configuration options for managing an MFA push-notification polling process. + +Supply these options when starting a polling session to control how often +the challenge endpoint is queried and how success or failure is handled. + +<Expandable title="Properties"> +<ParamField body='intervalMs?' type='number'> +{/*> `optional` **intervalMs**: `number`*/} + +Defined in: [interfaces/utils/polling-control.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L20) + +Optional interval, in **milliseconds**, between consecutive polling requests. + +- If omitted, the SDK’s internal default interval is used (typically 5000 ms). +- Choose a value that balances responsiveness with rate-limit considerations. + +#### Default Value + +```ts +Implementation-specific (commonly 5000 ms) +``` + +</ParamField> +<ParamField body='onCompleted()?' type='() => void'> +{/*> `optional` **onCompleted**: () => `void`*/} + +Defined in: [interfaces/utils/polling-control.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L29) + +Optional callback executed once the MFA push challenge is successfully +approved and polling completes. + +- Called exactly **once**, after which polling stops automatically. +- Useful for advancing the login flow (e.g., calling `continue()`). + +#### Returns + +`void` + +</ParamField> +<ParamField body='onError()?' type='(error) => void'> +{/*> `optional` **onError**: (`error`) => `void`*/} + +Defined in: [interfaces/utils/polling-control.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L41) + +Optional callback invoked if an error occurs while polling. + +Receives an [ULError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error) object containing: +- `status` — the HTTP status code from the failed request +- `responseText` — the raw response body, if available + +- Called once per error event; polling may retry depending on error type. +- Use to surface error messages or trigger custom retry/abort logic. + +<Expandable title="Parameters"> +<ParamField body='error' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error) +</ParamField> +</Expandable> + +#### Returns + +`void` +</ParamField> +</Expandable> + + + +<RequestExample> +```ts +export type MfaPollingOptions = { + /** + * Optional interval, in **milliseconds**, between consecutive polling requests. + * + * - If omitted, the SDK’s internal default interval is used (typically 5000 ms). + * - Choose a value that balances responsiveness with rate-limit considerations. + * + * @defaultValue Implementation-specific (commonly 5000 ms) + */ + intervalMs?: number; + + /** + * Optional callback executed once the MFA push challenge is successfully + * approved and polling completes. + * + * - Called exactly **once**, after which polling stops automatically. + * - Useful for advancing the login flow (e.g., calling `continue()`). + */ + onCompleted?: () => void; + + /** + * Optional callback invoked if an error occurs while polling. + * + * Receives an {@link ULError} object containing: + * - `status` — the HTTP status code from the failed request + * - `responseText` — the raw response body, if available + * + * - Called once per error event; polling may retry depending on error type. + * - Use to surface error messages or trigger custom retry/abort logic. + */ + onError?: (error: ULError) => void; +}; +``` +</RequestExample> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/OnStatusChangeCallback.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/OnStatusChangeCallback.mdx new file mode 100644 index 000000000..2b89ac37c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/OnStatusChangeCallback.mdx @@ -0,0 +1,35 @@ +--- +title: "Type Alias: OnStatusChangeCallback" +--- + +<ParamField body="OnStatusChangeCallback" type='(remainingSeconds, isDisabled) => void'> +{/*> **OnStatusChangeCallback** = (`remainingSeconds`, `isDisabled`) => `void`*/} + +Defined in: [interfaces/utils/resend-control.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L6) + +Callback function for status changes during resend countdown. + +<Expandable title="Parameters"> +<ParamField body='remainingSeconds' type='number'> +`number` + +Number of seconds remaining in the countdown +</ParamField> +<ParamField body='isDisabled' type='boolean'> +`boolean` + +Whether the resend functionality is currently disabled +</ParamField> +</Expandable> + +## Returns + +`void` + + +<RequestExample> +```ts +export type OnStatusChangeCallback = (remainingSeconds: number, isDisabled: boolean) => void; +``` +</RequestExample> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType.mdx new file mode 100644 index 000000000..53ef3699a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType.mdx @@ -0,0 +1,26 @@ +--- +title: "Type Alias: ScreenIdentifierType" +--- + +<ParamField body="ScreenIdentifierType" type='email | phone | username'> +{/*> **ScreenIdentifierType** = `"email"` \| `"phone"` \| `"username"`*/} + +Defined in: [interfaces/utils/signup-identifiers.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts#L16) + +Represents the types of user identifiers that can be used during signup. + +- `'email'`: The user will provide an email address. +- `'phone'`: The user will provide a phone number. +- `'username'`: The user will choose a username. + +This type is typically used in identity selection or signup flows +to define which identifiers are enabled and how they behave. + +<RequestExample> +```ts Example +const type: IdentifierType = 'email'; +``` +</RequestExample> + +</ParamField> +``` \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType.mdx new file mode 100644 index 000000000..9f8856054 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType.mdx @@ -0,0 +1,16 @@ +--- +title: "Type Alias: WebAuthnType" +--- + +<ParamField body="WebAuthnType" type='webauthn-roaming | webauthn-platform'> +{/*> **WebAuthnType** = `"webauthn-roaming"` \| `"webauthn-platform"`*/} + +Defined in: [interfaces/screens/mfa-webauthn-error.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L11) + + +<RequestExample> +```ts +export type WebAuthnType = 'webauthn-roaming' | 'webauthn-platform'; +``` +</RequestExample> +</ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AcceptInvitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AcceptInvitation.mdx deleted file mode 100644 index 1d9442952..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AcceptInvitation.mdx +++ /dev/null @@ -1,131 +0,0 @@ ---- -title: "AcceptInvitation" -description: "Class implementing the accept-invitation screen functionality. This screen is displayed when a user needs to accept an invitation to an organization." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React from 'react'; -import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation'; - -const AcceptInvitationScreen: React.FC = () => { - const acceptInvitationManager = new AcceptInvitation(); - const { screen, transaction } = acceptInvitationManager; - - const handleAcceptInvitation = async () => { - await acceptInvitationManager.acceptInvitation(); - }; - - return ( - <div className="flex flex-col items-center justify-center min-h-screen bg-gray-100"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4"> - <h2 className="text-2xl font-bold mb-4"> {screen?.texts?.title ?? "You've Been Invited!"} </h2> - <p className="mb-4"> - {screen?.texts?.description ?? 'XXXXXX has invited you (XXXXXXX) to join Second XXXXXX on XXXXXX.'} - </p> - <p className="mb-4"> - Inviter: {screen.data?.inviter} - </p> - <p className="mb-4"> - Email: {screen.data?.email} - </p> - <button - className="block mx-auto bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline" - type="button" - onClick={handleAcceptInvitation} - > - Accept Invitation - </button> - - {transaction?.errors?.length && ( - <div className="mt-2 mb-4"> - {transaction?.errors.map((err, index) => ( - <p key={index} className="text-red-500"> - {err.message} - </p> - ))} - </div> - )} - </div> - </div> - ); -}; - -export default AcceptInvitationScreen; -``` - -```typescript Accept Invitation lines -import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation'; - -const acceptInvitation = new AcceptInvitation(); - -// Accept the invitation -await acceptInvitation.acceptInvitation(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="acceptInvitation" type={<span>Promise<void></span>}> - Accepts the invitation to the organization. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/accept-invitation/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/accept-invitation/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AculError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AculError.mdx deleted file mode 100644 index 5e8a69d44..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AculError.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "AculError" -description: "" ---- - -## Properties - -<ParamField path="code" type={<span>string</span>} required> -</ParamField> - -<ParamField path="field" type={<span>string</span>}> -</ParamField> - ---- - -**File:** [src/utils/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Auth0ServerError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Auth0ServerError.mdx deleted file mode 100644 index 22059f8e2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Auth0ServerError.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Auth0ServerError" -description: "" ---- - -## Properties - -<ParamField path="code" type={<span>any</span>} required> -</ParamField> - -<ParamField path="field" type={<span>string</span>}> -</ParamField> - ---- - -**File:** [src/utils/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BaseContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BaseContext.mdx deleted file mode 100644 index 34b192f43..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BaseContext.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "BaseContext" -description: "" ---- - -## Properties - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - Identifier for the current screen, used to verify correct screen imports -</ParamField> - -## Methods - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/models/base-context.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/base-context.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding.mdx deleted file mode 100644 index 2e80bc5e8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "Branding" -description: "" ---- - -## Properties - -<ParamField path="settings" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a>['settings']</span>} required> - Branding settings like colors, logo URLs, etc. -</ParamField> - -<ParamField path="themes" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a>['themes']</span>} required> - Branding themes defining the visual appearance -</ParamField> - -## Methods - -<ParamField path="getSettings" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a>['settings']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a> | undefined</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getThemes" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a>['themes']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a> | undefined</span>}> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [src/models/branding.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/branding.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblock.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblock.mdx deleted file mode 100644 index bc160be3d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblock.mdx +++ /dev/null @@ -1,151 +0,0 @@ ---- -title: "BruteForceProtectionUnblock" -description: "Represents the BruteForceProtectionUnblock screen. This class provides methods to interact with the brute-force protection unblock screen, such as submitting the unblock request." ---- - -<RequestExample> - -```typescript unblock Account lines -import BruteForceProtectionUnblock from '@auth0/auth0-acul-js/brute-force-protection-unblock'; - -const unblockScreen = new BruteForceProtectionUnblock(); -unblockScreen.unblockAccount({}).then(() => { - console.log('Account unblock request submitted successfully.'); -}).catch((error) => { - console.error('Failed to submit account unblock request:', error); -}); -``` - -```tsx React Component Example with TailwindCSS lines -import React, { useState } from 'react'; -import BruteForceProtectionUnblock from '@auth0/auth0-acul-js/brute-force-protection-unblock'; - -const UnblockAccountScreen: React.FC = () => { - const [loading, setLoading] = useState(false); - const [error, setError] = useState<string | null>(null); - const [success, setSuccess] = useState(false); - const unblockScreen = new BruteForceProtectionUnblock(); - - const handleUnblockAccount = async () => { - setLoading(true); - setError(null); - setSuccess(false); - - try { - await unblockScreen.unblockAccount(); - setSuccess(true); - } catch (e: any) { - setError(e.message || 'Failed to unblock account.'); - } finally { - setLoading(false); - } - }; - - return ( - <div className="flex items-center justify-center min-h-screen bg-gray-100"> - <div className="bg-white shadow rounded lg:w-1/3 md:w-1/2 w-2/3 p-10 m-4"> - <h2 className="text-2xl font-semibold text-gray-800 mb-5"> - Unblock Account - </h2> - - { - error && ( - <div className="bg-red-100 border border-red-400 text-red-700 px-4 py-3 rounded relative mb-4" role="alert"> - <strong className="font-bold">Error!</strong> - <span className="block sm:inline">{error}</span> - </div> - ) - } - - { - success && ( - <div className="bg-green-100 border border-green-400 text-green-700 px-4 py-3 rounded relative mb-4" role="alert"> - <strong className="font-bold">Success!</strong> - <span className="block sm:inline">Account unblocked successfully.</span> - </div> - ) - } - - <button - onClick={handleUnblockAccount} - disabled={loading} - className={"bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline disabled:opacity-50 disabled:cursor-not-allowed w-full"} - > - { - loading ? 'Unblocking...' : 'Unblock Account' - } - </button> - </div> - </div> - ); -}; - -export default UnblockAccountScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - Identifier for the current screen, used to verify correct screen imports -</ParamField> - -## Methods - -<ParamField path="unblockAccount" type={<span>Promise<void></span>}> - Submits the unblock request. This method sends a request to unblock the account associated with the current transaction. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/brute-force-protection-unblock/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/brute-force-protection-unblock/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockFailure.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockFailure.mdx deleted file mode 100644 index 248fb7f7d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockFailure.mdx +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: "BruteForceProtectionUnblockFailure" -description: "Represents the Brute Force Protection Unblock Failure screen." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React from 'react'; -import BruteForceProtectionUnblockFailure from '@auth0/auth0-acul-js/brute-force-protection-unblock-failure'; - -const BruteForceProtectionUnblockFailureScreen: React.FC = () => { - const bruteForceProtectionUnblockFailure = new BruteForceProtectionUnblockFailure(); - const { screen } = bruteForceProtectionUnblockFailure; - const errorType = screen.data?.errorType; - - return ( - <div className="flex items-center justify-center min-h-screen bg-gray-100"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4"> - <h2 className="text-2xl font-bold mb-6">Brute Force Protection</h2> - <p className="text-gray-700 text-base"> - {errorType ? `Error Type: ${errorType}` : 'Unknown Error'} - </p> - </div> - </div> - ); -}; - -export default BruteForceProtectionUnblockFailureScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - The screen interface for the Brute Force Protection Unblock Failure screen. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - Identifier for the current screen, used to verify correct screen imports -</ParamField> - -## Methods - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/brute-force-protection-unblock-failure/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/brute-force-protection-unblock-failure/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockSuccess.mdx deleted file mode 100644 index 945395e73..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockSuccess.mdx +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "BruteForceProtectionUnblockSuccess" -description: "Represents the Brute Force Protection Unblock Success screen. This screen is displayed when a user successfully unblocks their account after brute force protection measures were triggered." ---- - -<RequestExample> - -```typescript typescript lines -import BruteForceProtectionUnblockSuccess from '@auth0/auth0-acul-js/brute-force-protection-unblock-success'; - -const BruteForceProtectionUnblockSuccessManager = new BruteForceProtectionUnblockSuccess(); -const { screen } = BruteForceProtectionUnblockSuccessManager; - -const BruteForceProtectionUnblockSuccessScreen = () => { - return ( - <div className="w-[100vw] flex flex-col items-center justify-center min-h-screen bg-gray-100"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4 flex flex-col"> - <h2 className="text-2xl font-bold mb-6">Brute Force Protection Unblock Success Screen</h2> - <div className="mb-4"> - <p>The account has been unblocked successfully.</p> - </div> - </div> - </div> - ); -}; - -export default BruteForceProtectionUnblockSuccessScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - Identifier for the current screen, used to verify correct screen imports -</ParamField> - -## Methods - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/brute-force-protection-unblock-success/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/brute-force-protection-unblock-success/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Client.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Client.mdx deleted file mode 100644 index fdb4eac8a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Client.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Client" -description: "" ---- - -## Properties - -<ParamField path="id" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a>['id']</span>} required> - The unique identifier of the client -</ParamField> - -<ParamField path="name" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a>['name']</span>} required> - The name of the client -</ParamField> - -<ParamField path="logoUrl" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a>['logoUrl']</span>} required> - URL to the client's logo, if available -</ParamField> - -<ParamField path="description" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a>['description']</span>} required> - Description of the client, if available -</ParamField> - -<ParamField path="metadata" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a>['metadata']</span>} required> - @property | null} metadata - Custom metadata associated with the client -</ParamField> - ---- - -**File:** [src/models/client.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/client.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Consent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Consent.mdx deleted file mode 100644 index d8df3ad08..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Consent.mdx +++ /dev/null @@ -1,273 +0,0 @@ ---- -title: "Consent" -description: "" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useMemo } from 'react'; -import Consent from '@auth0/auth0-acul-js/consent'; -import type { Scope } from '@auth0/auth0-acul-js/consent'; // Import Scope type - -const ConsentScreen: React.FC = () => { - // Instantiate the SDK class for the Consent screen. - // useMemo ensures it's only created once per component instance. - const consentManager = useMemo(() => new Consent(), []); - - const { client, organization, screen, transaction, user } = consentManager; - const texts = screen.texts ?? {}; // UI texts from Auth0 dashboard - - const handleAccept = () => { - consentManager.accept(); - }; - - const handleDecline = () => { - consentManager.deny(); - }; - - const pageTitle = texts.title ?? 'Authorize Application'; - const description = texts.description ?? `${client.name || 'The application'} is requesting access to your account.`; - const acceptButtonText = texts.acceptButtonText ?? 'Allow'; - const declineButtonText = texts.declineButtonText ?? 'Deny'; - - return ( - <div className="flex flex-col items-center justify-center min-h-screen bg-gray-100 p-4 antialiased"> - <div className="w-full max-w-lg bg-white rounded-xl shadow-2xl p-8 space-y-6"> - {/* Client Logo and Name */} - <div className="flex flex-col items-center space-y-3"> - {client.logoUrl && ( - <img src={client.logoUrl} alt={`${client.name || 'Application'} logo`} className="h-16 w-16 rounded-full object-contain" /> - )} - <h1 className="text-2xl font-bold text-gray-800">{pageTitle}</h1> - </div> - - {/* User and Organization Info */} - <div className="text-center text-gray-600"> - <p>{description}</p> - {user.email && <p className="mt-1 text-sm">You are logged in as <span className="font-semibold">{user.email}</span>.</p>} - {organization?.name && ( - <p className="mt-1 text-sm"> - This access is being requested on behalf of the organization: <span className="font-semibold">{organization.displayName || organization.name}</span>. - </p> - )} - </div> - - {/* Scopes (Permissions) Section */} - {!screen?.hideScopes && screen.scopes.length > 0 && ( - <div className="border-t border-b border-gray-200 py-6"> - <h2 className="text-lg font-semibold text-gray-700 mb-3"> - {texts.scopesTitle ?? 'This application will be ableto:'} - </h2> - <ul className="space-y-3 max-h-60 overflow-y-auto pr-2"> - {screen.scopes.map((scope: Scope) => ( - <li key={scope.value} className="flex items-start"> - <svg className="flex-shrink-0 h-5 w-5 text-green-500 mt-0.5 mr-2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor"> - <path fillRule="evenodd" d="M16.707 5.293a1 1 0 010 1.414l-8 8a1 1 0 01-1.414 0l-4-4a1 1 0 011.414-1.414L8 12.586l7.293-7.293a1 1 0 011.414 0z" clipRule="evenodd" /> - </svg> - <div> - <p className="text-sm font-medium text-gray-700">{scope.value}</p> - <p className="text-sm font-small text-gray-700">{scope.description}</p> - </div> - </li> - ))} - </ul> - </div> - )} - {screen?.hideScopes && ( - <p className="text-sm text-gray-500 text-center italic"> - {texts.scopesHiddenMessage ?? 'This application is requesting standard permissions.'} - </p> - )} - - - {/* Display transaction errors (e.g., from server validation) */} - {transaction.errors && transaction.errors.length > 0 && ( - <div className="bg-red-50 border-l-4 border-red-400 text-red-700 p-4 rounded-md" role="alert"> - <p className="font-bold">{texts.alertListTitle ?? 'Errors:'}</p> - <ul className="list-disc list-inside ml-4"> - {transaction.errors.map((err, index) => ( - <li key={`tx-err-${index}`}>{err.message}</li> - ))} - </ul> - </div> - )} - - {/* Action Buttons */} - <div className="flex flex-col sm:flex-row gap-4 pt-4"> - <button - onClick={handleDecline} - className="w-full sm:w-auto flex-1 px-6 py-3 border border-gray-300 rounded-lg shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-indigo-500 disabled:opacity-60 disabled:cursor-not-allowed transition-colors duration-150" - > - {declineButtonText} - </button> - <button - onClick={handleAccept} - className="w-full sm:w-auto flex-1 px-6 py-3 border border-transparent rounded-lg shadow-sm text-sm font-medium text-white bg-indigo-600 hover:bg-indigo-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-indigo-500 disabled:opacity-60 disabled:cursor-not-allowed transition-colors duration-150" - > - {acceptButtonText} - </button> - </div> - </div> - </div> - ); -}; - -export default ConsentScreen; -``` - -```typescript Initialize the SDK Class lines -import Consent from '@auth0/auth0-acul-js/consent'; - -const consentManager = new Consent(); - -// You can now access screen, client information, user details, etc. -const clientName = consentManager.client.name; -const userEmail = consentManager.user.email; -const requestedScopes = consentManager.screen?.scopes; -const shouldHideScopes = consentManager.screen?.hideScopes; - -console.log(`${clientName} is requesting consent from ${userEmail}.`); -if (shouldHideScopes) { - console.log("Scope details are hidden."); -} else if (requestedScopes) { - console.log("Requested permissions:"); - requestedScopes.forEach(scope => { - console.log(`- ${scope.description} (${scope.value})`); - }); -} - -// Check for errors from a previous submission attempt: -const errors = consentManager.transaction.errors; -if (errors && errors.length > 0) { - errors.forEach(err => console.error(`Error: ${err.message}`)); -} -``` - -```typescript Accept Consent lines -import Consent from '@auth0/auth0-acul-js/consent'; -import type { CustomOptions } from '@auth0/auth0-acul-js'; // For payload type - -const consentManager = new Consent(); - -async function grantConsent() { - // Optionally, provide custom parameters if your flow requires them - const payload: CustomOptions = { - // custom_param: "value" - }; - - try { - await consentManager.accept(payload); - // If successful, Auth0 will typically redirect the user. - } catch (error: any) { - // This catch block handles unexpected errors during the submission itself (e.g., network issues). - // Specific validation errors from Auth0 will be available in - // `consentManager.transaction.errors` after the promise resolves or the page reloads. - console.error('Failed to accept consent:', error.message); - } -} - -// Call this function, for example, when the user clicks an "Allow" or "Accept" button. -// grantConsent(); -``` - -```typescript Deny Consent lines -import Consent from '@auth0/auth0-acul-js/consent'; -import type { CustomOptions } from '@auth0/auth0-acul-js'; // For payload type - -const consentManager = new Consent(); - -async function denyConsent() { - // Optionally, provide custom parameters - const payload: CustomOptions = { - // denial_reason_code: "user_rejected" - }; - - try { - await consentManager.deny(payload); - // If successful, Auth0 will typically redirect the user, - // possibly to an error page or back to the application with an access_denied error. - } catch (error: any) { - console.error('Failed to deny consent:', error.message); - } -} - -// Call this function, for example, when the user clicks a "Deny" or "Cancel" button. -// denyConsent(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnConsent">ScreenMembersOnConsent</a></span>} required> - Holds the specific screen data and properties for the Consent screen, processed by `ScreenOverride`. This includes the list of `scopes` being requested and the `hideScopes` flag. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="accept" type={<span>Promise<void></span>}> - Submits the user's decision to accept (grant) the requested permissions. This method prepares and posts form data to the `/u/consent?state=<transaction_state>` endpoint with `action: "accept"`. The transaction state is automatically included in both the URL query parameter and the form body. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="deny" type={<span>Promise<void></span>}> - Submits the user's decision to deny (reject) the requested permissions. This method prepares and posts form data to the `/u/consent?state=<transaction_state>` endpoint with `action: "deny"`. The transaction state is automatically included in both the URL query parameter and the form body. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/consent/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/consent/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/CustomizedConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/CustomizedConsent.mdx deleted file mode 100644 index 258676fec..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/CustomizedConsent.mdx +++ /dev/null @@ -1,319 +0,0 @@ ---- -title: "CustomizedConsent" -description: "" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useMemo } from 'react'; -import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent'; -import type { Scope, AuthorizationDetail } from '@auth0/auth0-acul-js/customized-consent'; - -const CustomizedConsentScreen: React.FC = () => { - // Instantiate the SDK class for the Customized Consent screen. - // useMemo ensures it's only created once per component instance. - const consentManager = useMemo(() => new CustomizedConsent(), []); - - const { client, organization, screen, transaction, user } = consentManager; - const texts = screen.texts ?? {}; // UI texts from Auth0 dashboard - const screenData = screen; // Access parsed scopes and authorizationDetails - - const handleAccept = () => { - consentManager.accept(); - }; - - const handleDecline = () => { - consentManager.deny(); - }; - - const pageTitle = texts.title ?? 'Authorize Application'; - const description = texts.description ?? `${client.name || 'The application'} is requesting access to your account and specific resources.`; - const acceptButtonText = texts.acceptButtonText ?? 'Allow Access'; - const declineButtonText = texts.declineButtonText ?? 'Deny Access'; - - return ( - <div className="flex flex-col items-center justify-center min-h-screen bg-gray-100 p-4 antialiased"> - <div className="w-full max-w-2xl bg-white rounded-xl shadow-2xl p-8 space-y-6"> - {/* Client Logo and Name */} - <div className="flex flex-col items-center space-y-3"> - {client.logoUrl && ( - <img src={client.logoUrl} alt={`${client.name || 'Application'} logo`} className="h-16 w-16 rounded-full object-contain" /> - )} - <h1 className="text-3xl font-bold text-gray-800">{pageTitle}</h1> - </div> - - {/* User and Organization Info */} - <div className="text-center text-gray-600"> - <p>{description}</p> - {user.email && <p className="mt-1 text-sm">You are logged in as <span className="font-semibold">{user.email}</span>.</p>} - {organization?.name && ( - <p className="mt-1 text-sm"> - This access is being requested on behalf of the organization: <span className="font-semibold">{organization.displayName || organization.name}</span>. - </p> - )} - </div> - - {/* Scopes (Permissions) Section */} - {screenData.scopes.length > 0 && ( - <div className="border-t border-gray-200 py-6"> - <h2 className="text-xl font-semibold text-gray-700 mb-4"> - {texts.scopesTitle ?? 'This application will be able to:'} - </h2> - <ul className="space-y-3 max-h-48 overflow-y-auto pr-2"> - {screenData.scopes.map((scope: Scope) => ( - <li key={scope.value} className="flex items-start p-3 bg-gray-50 rounded-lg shadow-sm"> - <svg className="flex-shrink-0 h-6 w-6 text-blue-500 mt-0.5 mr-3" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor"> - <path strokeLinecap="round" strokeLinejoin="round" strokeWidth="2" d="M9 12l2 2 4-4m6 2a9 9 0 11-18 0 9 9 0 0118 0z" /> - </svg> - <div> - <p className="text-sm font-medium text-gray-700">{scope.value}</p> - <p className="text-sm font-small text-gray-700">{scope.description}</p> - </div> - </li> - ))} - </ul> - </div> - )} - - {/* Authorization Details Section */} - {screenData.authorizationDetails.length > 0 && ( - <div className="border-t border-gray-200 pt-6"> - <h2 className="text-xl font-semibold text-gray-700 mb-4"> - {texts.authorizationDetailsTitle ?? 'Specific Authorization Details:'} - </h2> - <div className="space-y-4 max-h-60 overflow-y-auto pr-2"> - {screenData.authorizationDetails.map((detail: AuthorizationDetail, index: number) => ( - <div key={index} className="p-4 bg-blue-50 border border-blue-200 rounded-lg shadow"> - <h3 className="text-lg font-medium text-blue-700 capitalize mb-2"> - {detail.type.replace(/_/g, ' ')} - </h3> - <ul className="list-disc list-inside pl-4 space-y-1"> - {Object.entries(detail).map(([key, value]) => { - if (key === 'type') return null; // Skip the type, already displayed - return ( - <li key={key} className="text-sm text-gray-600"> - <span className="font-semibold capitalize">{key.replace(/_/g, ' ')}:</span> {value} - </li> - ); - })} - </ul> - </div> - ))} - </div> - </div> - )} - - {/* Display transaction errors */} - {transaction.errors && transaction.errors.length > 0 && ( - <div className="bg-red-50 border-l-4 border-red-400 text-red-700 p-4 rounded-md mt-6" role="alert"> - <p className="font-bold">{texts.alertListTitle ?? 'Errors:'}</p> - <ul className="list-disc list-inside ml-4"> - {transaction.errors.map((err, index) => ( - <li key={`tx-err-${index}`}>{err.message}</li> - ))} - </ul> - </div> - )} - - {/* Action Buttons */} - <div className="flex flex-col sm:flex-row gap-4 pt-6"> - <button - onClick={handleDecline} - className="w-full sm:w-auto flex-1 px-6 py-3 border border-gray-300 rounded-lg shadow-sm text-md font-medium text-gray-700 bg-white hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-indigo-500 disabled:opacity-60 disabled:cursor-not-allowed transition-colors duration-150" - > - {declineButtonText} - </button> - <button - onClick={handleAccept} - className="w-full sm:w-auto flex-1 px-6 py-3 border border-transparent rounded-lg shadow-sm text-md font-medium text-white bg-indigo-600 hover:bg-indigo-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-indigo-500 disabled:opacity-60 disabled:cursor-not-allowed transition-colors duration-150" - > - {acceptButtonText} - </button> - </div> - </div> - </div> - ); -}; - -export default CustomizedConsentScreen; -``` - -```typescript Initialize the SDK Class and get screen related properties lines -import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent'; - -const consentManager = new CustomizedConsent(); - -// Access client information -const clientName = consentManager.client.name; -const clientLogo = consentManager.client.logoUrl; - -// Access user information -const userEmail = consentManager.user.email; - -// Access organization information (if available) -const organizationName = consentManager.organization?.displayName || consentManager.organization?.name; - -// Access screen-specific data -const requestedScopes = consentManager.screen.scopes; -const authorizationDetails = consentManager.screen.authorizationDetails; -const pageTitleFromTexts = consentManager.screen.texts?.title; - -console.log(`${clientName} is requesting consent from ${userEmail}.`); -if (organizationName) { - console.log(`This request is on behalf of ${organizationName}.`); -} - -console.log("Requested Scopes:"); -requestedScopes.forEach(scope => { - console.log(`- ${scope.description || scope.name} (${scope.name})`); - if (scope.values && scope.values.length > 0) { - console.log(` Values: ${scope.values.join(', ')}`); - } -}); - -console.log("Authorization Details:"); -authorizationDetails.forEach(detail => { - console.log(`- Type: ${detail.type}`); - Object.entries(detail).forEach(([key, value]) => { - if (key !== 'type') { - console.log(` ${key}: ${value}`); - } - }); -}); - -// Check for errors from a previous submission attempt: -const errors = consentManager.transaction.errors; -if (errors && errors.length > 0) { - errors.forEach(err => console.error(`Error: ${err.message} (Code: ${err.code})`)); -} -``` - -```typescript Accept Consent lines -import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent'; -import type { CustomOptions } from '@auth0/auth0-acul-js'; // For payload type - -const consentManager = new CustomizedConsent(); - -async function grantConsent() { - // Optionally, provide custom parameters if your flow requires them - const payload: CustomOptions = { - // custom_param_on_accept: "value" - }; - - try { - await consentManager.accept(payload); - // If successful, Auth0 will typically redirect the user. - } catch (error: any) { - // This catch block handles unexpected errors during the submission itself (e.g., network issues). - // Specific validation errors from Auth0 will be available in - // `consentManager.transaction.errors` after the promise resolves or the page reloads. - console.error('Failed to accept consent:', error.message); - } -} - -// Call this function, for example, when the user clicks an "Allow" or "Accept" button. -// grantConsent(); -``` - -```typescript Decline Consent lines -import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent'; -import type { CustomOptions } from '@auth0/auth0-acul-js'; // For payload type - -const consentManager = new CustomizedConsent(); - -async function denyConsent() { - // Optionally, provide custom parameters - const payload: CustomOptions = { - denial_reason_code: "user_rejected_specifics" - }; - - try { - await consentManager.deny(payload); - // If successful, Auth0 will typically redirect the user, - // possibly to an error page or back to the application with an access_denied error. - } catch (error: any) { - console.error('Failed to deny consent:', error.message); - } -} - -// Call this function, for example, when the user clicks a "Deny" or "Cancel" button. -// denyConsent(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - The unique identifier for the Customized Consent screen. This static property is used by the SDK's `BaseContext` to ensure that the class is instantiated in the correct screen context. -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnCustomizedConsent">ScreenMembersOnCustomizedConsent</a></span>} required> - Holds the specific screen data and properties for the Customized Consent screen, processed by `ScreenOverride`. This includes `scopes` and `authorizationDetails`. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="accept" type={<span>Promise<void></span>}> - Submits the user's decision to accept (grant) the requested permissions and authorization details. This method prepares and posts form data to the `/u/customized-consent?state=<transaction_state>` endpoint with `action: "accept"`. The transaction state is automatically included in both the URL query parameter and the form body. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="deny" type={<span>Promise<void></span>}> - Submits the user's decision to deny (reject) the requested permissions and authorization details. This method prepares and posts form data to the `/u/customized-consent?state=<transaction_state>` endpoint with `action: "deny"`. The transaction state is automatically included in both the URL query parameter and the form body. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/customized-consent/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/customized-consent/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivation.mdx deleted file mode 100644 index 8bed5afc0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivation.mdx +++ /dev/null @@ -1,140 +0,0 @@ ---- -title: "DeviceCodeActivation" -description: "Class implementing the Device Code Activation screen functionality. This screen is displayed when the user needs to enter the code on their device to activate it." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState } from 'react'; -import DeviceCodeActivation from '@auth0/auth0-acul-js/device-code-activation'; - -const DeviceCodeActivationScreen: React.FC = () => { - const [code, setCode] = useState(''); - const deviceCodeActivationManager = new DeviceCodeActivation(); - const { screen, transaction: { errors } } = deviceCodeActivationManager; - const texts = screen.texts ?? {}; - - const handleContinue = () => { - deviceCodeActivationManager.continue({ code }); - }; - - return ( - <div className="flex flex-col items-center min-h-screen bg-gray-100 p-4"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 w-full max-w-md"> - <h2 className="text-2xl font-bold mb-4 text-center"> - {texts.title ?? 'Device Activation'} - </h2> - <p className="text-sm text-gray-700 mb-4 text-center"> - {texts.description ?? 'Enter the code displayed on your device'} - </p> - - <input - className="shadow appearance-none border rounded w-full py-2 px-3 text-gray-700 leading-tight focus:outline-none focus:shadow-outline mb-3" - id="code" - type="text" - placeholder={texts.placeholder ?? 'Enter your one-time code'} - value={code} - onChange={(e) => setCode(e.target.value)} - /> - - {errors?.length && ( - <div className="mb-4 space-y-1"> - {errors.map((err, index) => ( - <p key={index} className="text-red-600 text-sm"> - {err.message} - </p> - ))} - </div> - )} - - <button - className="w-full bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline" - type="button" - onClick={handleContinue} - > - {texts.buttonText ?? 'Continue'} - </button> - </div> - </div> - ); -}; - -export default DeviceCodeActivationScreen; -``` - -```typescript Continue with Code lines -import DeviceCodeActivation from '@auth0/auth0-acul-js/device-code-activation'; - -const deviceCodeActivation = new DeviceCodeActivation(); - -deviceCodeActivation.continue({ - code: 'HXNL-XWMT', -}); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Submits the device code entered by the user. This action is triggered when the user enters the code displayed on their device and submits the form. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/device-code-activation/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/device-code-activation/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationAllowed.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationAllowed.mdx deleted file mode 100644 index cda777b9f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationAllowed.mdx +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: "DeviceCodeActivationAllowed" -description: "Class implementing the Device Code Activation Allowed screen functionality. This screen is displayed when the device code activation is allowed." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React from 'react'; -import DeviceCodeActivationAllowed from '@auth0/auth0-acul-js/device-code-activation-allowed'; - -const DeviceCodeActivationAllowedScreen: React.FC = () => { - const deviceCodeActivationAllowedManager = new DeviceCodeActivationAllowed(); - const { client, screen, organization, prompt, transaction } = deviceCodeActivationAllowedManager; - - return ( - <div className="flex flex-col items-center justify-center min-h-screen bg-gray-100"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4"> - <h2 className="text-2xl font-bold mb-4">Device Code Activation Allowed</h2> - <p className="mb-4">Client ID: {client.id}</p> - <p className="mb-4">Client Name: {client.name}</p> - {organization?.id && <p className="mb-4">Organization ID: {organization.id}</p>} - <p className="mb-4">Prompt Name: {prompt.name}</p> - <p className="mb-4">Transaction State: {transaction.state}</p> - <p className="mb-4">Screen Name: {screen.name}</p> - </div> - </div> - ); -}; - -export default DeviceCodeActivationAllowedScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/device-code-activation-allowed/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/device-code-activation-allowed/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationDenied.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationDenied.mdx deleted file mode 100644 index 14eb579b4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationDenied.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "DeviceCodeActivationDenied" -description: "Class implementing the Device Code Activation Denied screen functionality. This screen is displayed when the device code activation is denied." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React from 'react'; -import DeviceCodeActivationDenied from '@auth0/auth0-acul-js/device-code-activation-denied'; - -const DeviceCodeActivationDeniedScreen: React.FC = () => { - const deviceCodeActivationDeniedManager = new DeviceCodeActivationDenied(); - const { client, screen, organization, prompt, transaction } = deviceCodeActivationDeniedManager; - - return ( - <div className="flex flex-col items-center justify-center min-h-screen bg-gray-100"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4"> - <h2 className="text-2xl font-bold mb-4">Device Code Activation Denied</h2> - <p className="mb-4">We are not able to activate your device.</p> - </div> - </div> - ); -}; - -export default DeviceCodeActivationDeniedScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/device-code-activation-denied/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/device-code-activation-denied/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeConfirmation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeConfirmation.mdx deleted file mode 100644 index 07d4a42d8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeConfirmation.mdx +++ /dev/null @@ -1,179 +0,0 @@ ---- -title: "DeviceCodeConfirmation" -description: "Class implementing the Device Code Confirmation screen functionality. This screen is displayed when the user needs to confirm the device code." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React from 'react'; -import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation'; - -const DeviceCodeConfirmationScreen: React.FC = () => { - const deviceCodeConfirmationManager = new DeviceCodeConfirmation(); - const { screen, transaction: { errors } } = deviceCodeConfirmationManager; - const texts = screen?.texts || {}; - - const handleConfirm = async () => { - await deviceCodeConfirmationManager.confirm(); - }; - - const handleCancel = async () => { - await deviceCodeConfirmationManager.cancel(); - }; - - return ( - <div className="flex flex-col items-center min-h-screen bg-gray-100 px-4"> - <div className="bg-white shadow-md rounded-xl p-6 w-full max-w-md space-y-4"> - <h1 className="text-2xl font-bold text-center"> - {texts.title ?? 'Device Confirmation'} - </h1> - - {texts.description && ( - <p className="text-sm text-gray-600 text-center"> - {texts.description} - </p> - )} - - <div className="mt-4"> - <label className="block text-gray-700 text-sm font-medium mb-2"> - {texts.inputCodeLabel ?? 'Secure code'} - </label> - <input - type="text" - disabled - value={screen?.data?.textCode ?? ''} - className="w-full px-3 py-2 border border-gray-300 rounded-md bg-gray-100 text-gray-700 cursor-not-allowed" - /> - </div> - - {texts.confirmationText && ( - <p className="text-xs text-gray-500 text-center mt-2"> - {texts.confirmationText} - </p> - )} - - {errors?.length && ( - <div className="mt-2 space-y-1 text-left"> - {errors.map((error, idx) => ( - <p key={idx} className="text-red-600 text-sm"> - {error.message} - </p> - ))} - </div> - )} - - <div className="flex justify-between mt-6"> - <button - className="bg-red-500 hover:bg-red-600 text-white font-semibold py-2 px-4 rounded-lg w-[45%]" - onClick={handleCancel} - > - {texts.cancelButtonText ?? 'Cancel'} - </button> - <button - className="bg-blue-600 hover:bg-blue-700 text-white font-semibold py-2 px-4 rounded-lg w-[45%]" - onClick={handleConfirm} - > - {texts.confirmButtonText ?? 'Confirm'} - </button> - </div> - </div> - </div> - ); -}; - -export default DeviceCodeConfirmationScreen; -``` - -```typescript Confirm Device Code lines -import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation'; - -const deviceCodeConfirmation = new DeviceCodeConfirmation(); - -// Confirm the device code -await deviceCodeConfirmation.confirm(); -``` - -```typescript Cancel Device Code lines -import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation'; - -const deviceCodeConfirmation = new DeviceCodeConfirmation(); - -// Cancel the device code flow -await deviceCodeConfirmation.cancel(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>screenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="confirm" type={<span>Promise<void></span>}> - Confirms the device code. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="cancel" type={<span>Promise<void></span>}> - Cancels the device code flow. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/device-code-confirmation/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailIdentifierChallenge.mdx deleted file mode 100644 index 9e8a12c01..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailIdentifierChallenge.mdx +++ /dev/null @@ -1,285 +0,0 @@ ---- -title: "EmailIdentifierChallenge" -description: "" ---- - -<RequestExample> - -```typescript submitEmailChallenge lines -import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; - -const emailIdentifierChallenge = new EmailIdentifierChallenge(); -emailIdentifierChallenge.submitEmailChallenge({ - code:"dummyCode" -}); -``` - -```typescript resendCode lines -import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; - -const emailIdentifierChallenge = new EmailIdentifierChallenge(); -emailIdentifierChallenge.resendCode(); -``` - -```typescript returnToPrevious lines -import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; - -const emailIdentifierChallenge = new EmailIdentifierChallenge(); -emailIdentifierChallenge.returnToPrevious(); -``` - -```typescript resendManager lines -import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; - -const emailIdentifierChallenge = new EmailIdentifierChallenge(); - -function handleStatusChange(remainingSeconds: number) { - console.log('Remaining seconds:', remainingSeconds); -} - -function handleTimeout() { - console.log('Resend timeout completed'); -} - -const resendManager = emailIdentifierChallenge.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleTimeout, -}); - -const { startResend } = resendManager; - -// Use startResend() to initiate the resend with cooldown -startResend(); -``` - -```typescript EmailIdentifierChallenge React Example lines -import React, { useState, useMemo } from 'react'; -import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; - -const EmailIdentifierChallengeScreen: React.FC = () => { - const [code, setCode] = useState(''); - const [error, setError] = useState(''); - const [success, setSuccess] = useState(false); - const [resent, setResent] = useState(false); - const [returned, setReturned] = useState(false); - const [disabled, setDisabled] = useState(false); - - const emailIdentifierChallenge = useMemo(() => new EmailIdentifierChallenge(), []); - - function handleStatusChange(remainingSeconds: number) { - setDisabled(remainingSeconds > 0); - } - - function handleonTimeout() { - console.log('Resend timeout completed'); - } - - const resendManager = useMemo( - () => - emailIdentifierChallenge.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleonTimeout, - }), - [emailIdentifierChallenge] - ); - - const { startResend } = resendManager; - - const handleSubmit = async (e: React.FormEvent) => { - e.preventDefault(); - setError(''); - setSuccess(false); - setResent(false); - setReturned(false); - - if (!code) { - setError('Code is required.'); - return; - } - try { - await emailIdentifierChallenge.submitEmailChallenge({ code }); - setSuccess(true); - } catch { - setError('Invalid code. Please try again.'); - } - }; - - const handleResend = async (e: React.FormEvent) => { - e.preventDefault(); - try { - await startResend(); - setResent(true); - } catch (err: any) { - setError(err.message || 'Failed to resend code.'); - } - }; - - const handleReturn = async (e: React.FormEvent) => { - e.preventDefault(); - setError(''); - setSuccess(false); - setResent(false); - setReturned(false); - - try { - await emailIdentifierChallenge.returnToPrevious(); - setReturned(true); - } catch { - setError('Failed to return to previous step. Please try again later.'); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - Email Identifier Challenge - </h2> - </div> - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label htmlFor="code" className="block text-sm font-medium text-gray-700"> - Code - </label> - <div className="mt-1"> - <input - id="code" - name="code" - type="text" - required - value={code} - onChange={(e) => setCode(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - <button - type="submit" - className="w-full py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Submit Challenge - </button> - </form> - {/* ✅ Resend with cooldown */} - <form className="space-y-6 mt-4" onSubmit={handleResend}> - <button - type="submit" - disabled={disabled} - className={`w-full py-2 px-4 border rounded-md shadow-sm text-sm font-medium - ${disabled ? 'bg-gray-300 text-gray-500 cursor-not-allowed' : 'bg-white text-blue-600 border-blue-600 hover:bg-blue-50'} - `} - > - {disabled ? `Resend limit has been reached` : 'Resend Code'} - </button> - </form> - <form className="space-y-6 mt-4" onSubmit={handleReturn}> - <button - type="submit" - className="w-full py-2 px-4 border border-gray-400 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-gray-500" - > - Return to Previous - </button> - </form> - {error && <div className="text-red-600 text-sm mt-2">{error}</div>} - {success && <div className="text-green-600 text-sm mt-2">Challenge submitted successfully!</div>} - {resent && <div className="text-blue-600 text-sm mt-2">Code resent to your email.</div>} - {returned && <div className="text-blue-600 text-sm mt-2">Returned to previous step.</div>} - </div> - </div> - </div> - ); -}; - -export default EmailIdentifierChallengeScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="submitEmailChallenge" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailChallengeOptions">EmailChallengeOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="returnToPrevious" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> - Gets resend functionality with timeout management for this screen - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/email-identifier-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailOTPChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailOTPChallenge.mdx deleted file mode 100644 index cf54a1f34..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailOTPChallenge.mdx +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "EmailOTPChallenge" -description: "Represents the Email OTP Challenge screen." ---- - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="submitCode" type={<span>Promise<void></span>}> - Submits the OTP code entered by the user. - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OtpCodeOptions">OtpCodeOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>}> - Requests a new OTP code to be sent to the user's email. - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> - Gets resend functionality with timeout management for this screen - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/email-otp-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailVerificationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailVerificationResult.mdx deleted file mode 100644 index 57ceecaca..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailVerificationResult.mdx +++ /dev/null @@ -1,184 +0,0 @@ ---- -title: "EmailVerificationResult" -description: "" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React from 'react'; -import EmailVerificationResult from '@auth0/auth0-acul-js/email-verification-result'; - -const EmailVerificationResultScreen: React.FC = () => { - // Instantiate the SDK class for the Email Verification Result screen - const emailVerificationResultManager = new EmailVerificationResult(); - const { client, screen, transaction, organization } = emailVerificationResultManager; - - // Determine the message and styling based on the verification status - let statusMessage = 'An unexpected error occurred.'; - let statusColor = 'text-gray-700'; // Default color - let title = screen.texts?.title ?? 'Email Verification'; // Default title - - const verificationStatus = screen.data?.status; - const loginLink = screen.loginLink; - - if (verificationStatus === 'success') { - statusMessage = screen.texts?.descriptionSuccess ?? 'Your email has been successfully verified.'; - statusColor = 'text-green-600'; - title = screen.texts?.titleSuccess ?? 'Verification Successful'; - } else if (verificationStatus === 'failure') { - statusMessage = screen.texts?.descriptionFailure ?? 'There was an issue verifying your email. Please try again or contact support.'; - statusColor = 'text-red-600'; - title = screen.texts?.titleFailure ?? 'Verification Failed'; - } else if (verificationStatus === 'already_verified') { - statusMessage = screen.texts?.descriptionAlreadyVerified ?? 'This email address has already been verified.'; - statusColor = 'text-blue-600'; - title = screen.texts?.titleAlreadyVerified ?? 'Email Already Verified'; - } - // Add more status checks as needed based on actual possible values - - const handleGoToLogin = (): void => { - if (loginLink) { - window.location.href = loginLink; - } - }; - - return ( - <div className="flex flex-col items-center justify-center min-h-screen bg-gray-100 p-4"> - <div className="w-full max-w-md bg-white rounded-lg shadow-md p-8 text-center"> - {client.logoUrl && ( - <img src={client.logoUrl} alt={client.name ?? 'Application Logo'} className="mx-auto h-16 mb-6" /> - )} - <h1 className={`text-2xl font-semibold mb-4 ${statusColor}`}> - {title} - </h1> - - <p className={`text-gray-700 mb-6 ${statusColor}`}> - {statusMessage} - </p> - - {organization?.name && ( - <p className="text-sm text-gray-500 mb-2"> - Organization: {organization.displayName || organization.name} - </p> - )} - - {transaction.errors && transaction.errors.length > 0 && ( - <div className="bg-red-100 border border-red-400 text-red-700 px-4 py-3 rounded relative mb-4 text-left" role="alert"> - <strong className="font-bold">Error(s):</strong> - {transaction.errors.map((err, index) => ( - <p key={`tx-error-${index}`} className="block sm:inline ml-2">{err.message}</p> - ))} - </div> - )} - - {loginLink && ( - <button - onClick={handleGoToLogin} - className="w-full px-4 py-2 text-white bg-blue-600 rounded-md hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-blue-500 focus:ring-opacity-50 transition duration-150 ease-in-out" - > - {screen.texts?.buttonText ?? 'Proceed to Login'} - </button> - )} - </div> - </div> - ); -}; - -export default EmailVerificationResultScreen; -``` - -```typescript Accessing Screen Information lines -import EmailVerificationResult from '@auth0/auth0-acul-js/email-verification-result'; - -const screenManager = new EmailVerificationResult(); - -// Access client information -console.log('Client Name:', screenManager.client.name); - -// Access organization information (if available) -if (screenManager.organization) { - console.log('Organization Name:', screenManager.organization.name); -} - -// Access prompt information -console.log('Prompt Name:', screenManager.prompt.name); - -// Access screen-specific data -const verificationStatus = screenManager.screen.data?.status; -console.log('Verification Status:', verificationStatus); - -const loginLink = screenManager.screen.loginLink; -if (loginLink) { - console.log('Login Link:', loginLink); - // You can use this link to redirect the user: - // window.location.href = loginLink; -} - -// Access transaction details -console.log('Transaction State:', screenManager.transaction.state); -if (screenManager.transaction.hasErrors && screenManager.transaction.errors) { - screenManager.transaction.errors.forEach(error => { - console.error('Transaction Error:', error.message); - }); -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - static -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - Holds the specific screen data and properties for the This includes the verification status and the login link. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/email-verification-result/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/email-verification-result/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/FormHandler.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/FormHandler.mdx deleted file mode 100644 index 0874875fd..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/FormHandler.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "FormHandler" -description: "" ---- - -## Properties - -<ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FormOptions">FormOptions</a></span>} required> -</ParamField> - -## Methods - -<ParamField path="submitData" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span>T</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="buildForm" type={<span>HTMLFormElement</span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PostPayloadOptions">PostPayloadOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="addTelemetryField" type={<span>HTMLFormElement</span>}> - <Expandable title="parameters"> - <ParamField path="form" type={<span>HTMLFormElement</span>} required> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [src/utils/form-handler.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/form-handler.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/InterstitialCaptcha.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/InterstitialCaptcha.mdx deleted file mode 100644 index d6b040b5f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/InterstitialCaptcha.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: "InterstitialCaptcha" -description: "" ---- - -<RequestExample> - -```typescript submitCaptcha lines -import InterstitialCaptcha from "@auth0/auth0-acul-js/intersitial-captcha"; - -const interstitialCaptcha = new InterstitialCaptcha(); -interstitialCaptcha.submitCaptcha({ - captcha: "captchaValue", -}); -``` - -```typescript InterstitialCaptcha React Example lines -import React, { useState } from 'react'; -import InterstitialCaptcha from '@auth0/auth0-acul-js/intersitial-captcha'; - -const InterstitialCaptchaScreen: React.FC = () => { - const [captcha, setCaptcha] = useState(''); - const [error, setError] = useState(''); - const [success, setSuccess] = useState(false); - - const interstitialCaptcha = new InterstitialCaptcha(); - - const handleSubmit = async (e) => { - e.preventDefault(); - setError(''); - setSuccess(false); - if (!captcha) { - setError('Captcha is required.'); - return; - } - try { - await interstitialCaptcha.submitCaptcha({ captcha }); - setSuccess(true); - } catch (err) { - setError('Invalid captcha. Please try again.'); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - Interstitial Captcha - </h2> - </div> - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label htmlFor="captcha" className="block text-sm font-medium text-gray-700"> - Captcha - </label> - <div className="mt-1"> - <input - id="captcha" - name="captcha" - type="text" - required - value={captcha} - onChange={(e) => setCaptcha(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - <button - type="submit" - className="w-full py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Submit Captcha - </button> - </form> - {error && <div className="text-red-600 text-sm mt-2">{error}</div>} - {success && <div className="text-green-600 text-sm mt-2">Captcha submitted successfully!</div>} - </div> - </div> - </div> - ); -}; - -export default InterstitialCaptchaScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="submitCaptcha" type={<span>Promise<void></span>}> - This methods handles InterstitialCaptcha related configuration. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCaptchaOptions">SubmitCaptchaOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/interstitial-captcha/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/interstitial-captcha/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Login.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Login.mdx deleted file mode 100644 index 76cb0f300..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Login.mdx +++ /dev/null @@ -1,280 +0,0 @@ ---- -title: "Login" -description: "Login screen implementation class" ---- - -<RequestExample> - -```typescript Basic Login with Username/Password lines -import Login from '@auth0/auth0-acul-js/login'; - -const loginManager = new Login(); - -// Handle form submission and error handling -const errors = loginManager.getErrors(); -const handleSubmit = async (e: React.FormEvent) => { - e.preventDefault(); - - try { - await loginManager.login({ - username: 'user@example.com', - password: 'myPassword123' - }); - } catch (error) { - console.error('Login failed:', error); - } -}; - -return ( - <div> - {/* Render the login ID screen content */} - <button onclick={handleLogin}>Continue<button> - {loginIdManager.transaction.hasErrors && errors && ( - // A custom React component that renders a <div> with error details - <ErrorMessages errors={errors} /> - )} - ) -``` - -```typescript Login with Social Provider lines -import Login from '@auth0/auth0-acul-js/login'; - -const loginManager = new Login(); - -// Handle social login -const handleSocialLogin = async (connection: string) => { - try { - await loginManager.federatedLogin({ - connection: connection // e.g. 'google-oauth2' - }); - } catch (error) { - console.error('Social login failed:', error); - } -}; -``` - -```tsx React Component Example with TailwindCSS lines -import React, { useState } from 'react'; -import Login from '@auth0/auth0-acul-js/login'; - -const LoginScreen: React.FC = () => { - const [username, setUsername] = useState(''); - const [password, setPassword] = useState(''); - const [error, setError] = useState(''); - - const loginManager = new Login(); - const { transaction } = loginManager; - const activeIdentifiers = useMemo(() => loginManager.getActiveIdentifiers(), []); - - const getIdentifierLabel = () => { - if (activeIdentifiers?.length === 1) return `Enter your ${activeIdentifiers[0]}`; - return `Enter your ${activeIdentifiers?.join(" or ")}`; - }; - - const handleSubmit = async (e: React.FormEvent) => { - e.preventDefault(); - setError(''); - - try { - await loginManager.login({ - username, - password - }); - } catch (error) { - setError('Login failed. Please check your credentials.'); - } - }; - - const handleSocialLogin = async (connection: string) => { - try { - await loginManager.federatedLogin({ connection }); - } catch (error) { - setError('Social login failed. Please try again.'); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - Sign in to your account - </h2> - </div> - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label htmlFor="username" className="block text-sm font-medium text-gray-700"> - {getIdentifierLabel()} - </label> - <div className="mt-1"> - <input - id="username" - name="username" - type="text" - required - value={username} - onChange={(e) => setUsername(e.target.value)} - placeholder= {getIdentifierLabel()} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - - <div> - <label htmlFor="password" className="block text-sm font-medium text-gray-700"> - Password - </label> - <div className="mt-1"> - <input - id="password" - name="password" - type="password" - required - value={password} - onChange={(e) => setPassword(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - - {error && ( - <div className="text-red-600 text-sm"> - {error} - </div> - )} - - <div> - <button - type="submit" - className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Sign in - </button> - </div> - </form> - - {transaction.alternateConnections && transaction.alternateConnections.length > 0 && ( - <div className="mt-6"> - <div className="relative"> - <div className="absolute inset-0 flex items-center"> - <div className="w-full border-t border-gray-300" /> - </div> - <div className="relative flex justify-center text-sm"> - <span className="px-2 bg-white text-gray-500"> - Or continue with - </span> - </div> - </div> - - <div className="mt-6 grid grid-cols-3 gap-3"> - {transaction.alternateConnections.map((connection) => ( - <button - key={connection.name} - onClick={() => handleSocialLogin(connection.name)} - className="w-full inline-flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm bg-white text-sm font-medium text-gray-500 hover:bg-gray-50" - > - {connection.name} - </button> - ))} - </div> - </div> - )} - </div> - </div> - </div> - ); -}; - -export default LoginScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="transaction" type={<span>TransactionOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="login" type={<span>Promise<void></span>}> - Performs login with username/password - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions">LoginOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="federatedLogin" type={<span>Promise<void></span>}> - Performs login with social provider - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions">FederatedLoginOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="pickCountryCode" type={<span>Promise<void></span>}> - Picks country code for phone number input - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getLoginIdentifiers" type={<span>IdentifierType[] | null</span>}> - Gets the active identifier types for the login screen - -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/login/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/login/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginEmailVerification.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginEmailVerification.mdx deleted file mode 100644 index 424ba5965..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginEmailVerification.mdx +++ /dev/null @@ -1,378 +0,0 @@ ---- -title: "LoginEmailVerification" -description: "classdesc Manages interactions for the \"login-email-verification\" screen. This screen prompts the user to enter a one-time code sent to their email address to verify their identity during the login process. It provides methods to submit the entered code (`continueWithCode`) or to request a new code if the original one was not received or has expired (`resendCode`). Inherits from `BaseContext` to access shared authentication flow data like transaction state, client information, and internationalization texts." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState, FormEvent, ChangeEvent, useMemo } from 'react'; -import LoginEmailVerification, { ContinueWithCodeOptions, ResendCodeOptions } from '@auth0/auth0-acul-js/login-email-verification'; // Adjust path as necessary - -const LoginEmailVerificationScreen: React.FC = () => { - const [code, setCode] = useState<string>(''); - const [isSubmitting, setIsSubmitting] = useState<boolean>(false); - const [uiMessages, setUiMessages] = useState<{ type: 'error' | 'success', text: string }[]>([]); - const [disabled, setDisabled] = useState(false); - const [remainingSeconds, setRemainingSeconds] = useState(0); - - // Instantiate the SDK class for the Login Email Verification screen - // This should be done once per component instance. - const [loginEmailVerificationManager] = useState(() => new LoginEmailVerification()); - const { screen, transaction, client } = loginEmailVerificationManager; - - function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { - setDisabled(isDisabled); - setRemainingSeconds(remainingSeconds); - } - - function handleTimeout() { - console.log('Resend timeout completed'); - } - - const resendManager = useMemo( - () => - loginEmailVerificationManager.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleTimeout, - }), - [loginEmailVerificationManager] - ); - - const { startResend } = resendManager; - - /** - * Handles the change in the code input field. - */ - const handleCodeChange = (event: ChangeEvent<HTMLInputElement>): void => { - setCode(event.target.value); - }; - - /** - * Handles the submission of the verification code. - */ - const handleSubmitCode = async (event: FormEvent<HTMLFormElement>): Promise<void> => { - event.preventDefault(); - if (!code.trim()) { - setUiMessages([{ type: 'error', text: screen.texts?.noCodeError || 'Please enter a code.' }]); - return; - } - setIsSubmitting(true); - setUiMessages([]); // Clear previous messages - - try { - const payload: ContinueWithCodeOptions = { code }; - await loginEmailVerificationManager.continueWithCode(payload); - // On successful submission, Auth0 typically handles redirection. - // If the page reloads with errors (e.g., invalid code), the useEffect hook will update uiMessages. - } catch (error: any) { - // Handles unexpected errors (e.g., network issues during form submission) - setUiMessages([{ type: 'error', text: error.message || 'An unexpected error occurred. Please try again.' }]); - } finally { - setIsSubmitting(false); - } - }; - - /** - * Handles the request to resend the verification code. - */ - const handleResendCode = async (): Promise<void> => { - try { - await startResend(); - } catch (error: any) { - setUiMessages([{ type: 'error', text: error.message || 'Failed to resend code. Please try again.' }]); - } - }; - - // Extract texts for UI elements, providing default fallbacks - const texts = screen?.texts ?? {}; - const title = texts.title ?? 'Verify Your Email'; - const description = texts.description ?? `We've sent a verification code to your email address. Please enter it below to continue.`; - const codeLabel = texts.codeLabel ?? 'Verification Code'; - const codePlaceholder = texts.codePlaceholder ?? 'Enter 6-digit code'; - const continueButtonText = texts.buttonText ?? 'Continue'; - const resendButtonText = texts.resendActionText ?? 'Resend Code'; - const submittingText = texts.submittingText ?? 'Processing...'; - - - return ( - <div className="flex flex-col items-center justify-center min-h-screen bg-gray-50 p-4 antialiased"> - <div className="w-full max-w-md bg-white rounded-xl shadow-xl p-8 space-y-6"> - {client.logoUrl && ( - <img - src={client.logoUrl} - alt={client.name || 'Client Logo'} - className="mx-auto h-12 w-auto mb-6" // Adjusted size - /> - )} - <div className="text-center"> - <h1 className="text-3xl font-bold text-gray-900"> - {title} - </h1> - <p className="mt-2 text-sm text-gray-600"> - {description} - </p> - </div> - - <form onSubmit={handleSubmitCode} className="space-y-6"> - <div> - <label htmlFor="code" className="block text-sm font-medium text-gray-700"> - {codeLabel} - </label> - <input - id="code" - name="code" - type="text" - inputMode="numeric" - autoComplete="one-time-code" - required - value={code} - onChange={handleCodeChange} - className="mt-1 block w-full px-4 py-3 border border-gray-300 rounded-lg shadow-sm placeholder-gray-400 - focus:outline-none focus:ring-2 focus:ring-indigo-500 focus:border-indigo-500 - sm:text-sm transition duration-150 ease-in-out" - placeholder={codePlaceholder} - disabled={isSubmitting} - /> - </div> - - {/* Display errors from the transaction object (e.g., invalid state) */} - {transaction.errors && transaction.errors.length > 0 && ( - <div className="bg-red-100 border border-red-400 text-red-700 px-4 py-3 rounded relative mb-4" role="alert"> - {transaction.errors.map((err, index) => ( - <p key={`tx-error-${index}`}>{err.message}</p> - ))} - </div> - )} - - {/* Display errors/success caught during form submission */} - {uiMessages.length > 0 && ( - <div className="space-y-2"> - {uiMessages.map((msg, idx) => ( - <div - key={idx} - role="alert" - className={`p-4 rounded-md text-sm ${ - msg.type === 'error' ? 'bg-red-50 text-red-700 border border-red-200' : - 'bg-green-50 text-green-700 border border-green-200' - }`} - > - {msg.text} - </div> - ))} - </div> - )} - - <div> - <button - type="submit" - disabled={isSubmitting || !code.trim()} - className="w-full flex justify-center py-3 px-4 border border-transparent rounded-lg shadow-sm - text-sm font-medium text-white bg-indigo-600 hover:bg-indigo-700 - focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-indigo-500 - disabled:opacity-60 disabled:cursor-not-allowed transition duration-150 ease-in-out" - > - {isSubmitting ? submittingText : continueButtonText} - </button> - </div> - </form> - - <div className="text-center"> - <button - type="button" - onClick={handleResendCode} - disabled={isSubmitting || disabled} - className="text-sm font-medium text-indigo-600 hover:text-indigo-500 - disabled:opacity-60 disabled:cursor-not-allowed transition duration-150 ease-in-out" - > - {isSubmitting ? submittingText : disabled ? `Resend code in ${remainingSeconds}s` : resendButtonText} - </button> - </div> - </div> - </div> - ); -}; - -export default LoginEmailVerificationScreen; -``` - -```typescript resendManager lines -import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification'; - -const loginEmailVerification = new LoginEmailVerification(); - -function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { - console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); -} - -function handleTimeout() { - console.log('Resend timeout completed'); -} - -const resendManager = loginEmailVerification.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleTimeout, -}); - -const { startResend } = resendManager; - -// Use startResend() to initiate the resend with cooldown -startResend(); -``` - -```jsx Initialize the SDK Class lines -import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification'; - -const loginEmailVerificationManager = new LoginEmailVerification(); - -// You can now access screen data, transaction details, etc. -// For example, to get the page title defined in Auth0 dashboard: -const pageTitle = loginEmailVerificationManager.screen.texts?.title; - -// To check for errors from a previous submission attempt: -const errors = loginEmailVerificationManager.transaction.errors; -if (errors && errors.length > 0) { - errors.forEach(err => console.log(`Error: ${err.message}`)); -} -``` - -```jsx Submit Verification Code lines -import LoginEmailVerification, { ContinueWithCodeOptions } from '@auth0/auth0-acul-js/login-email-verification'; - -const loginEmailVerificationManager = new LoginEmailVerification(); -const userEnteredCode = "123456"; // Example code from user input - -const payload: ContinueWithCodeOptions = { - code: userEnteredCode, - // You can add any custom options here if needed - // customParam: "customValue" -}; - -async function submitCode() { - try { - await loginEmailVerificationManager.continueWithCode(payload); - // If the submission is successful and the code is valid, - // Auth0 will typically redirect the user to the next step in the flow. - } catch (error) { - // This catch block handles unexpected errors during the submission itself (e.g., network issues). - // Specific validation errors from Auth0 (like "invalid-code") will be available in - // `loginEmailVerificationManager.transaction.errors` after the promise resolves or the page reloads. - console.error('Failed to submit verification code:', error); - } -} - -submitCode(); -``` - -```jsx Resend Verification Code lines -import LoginEmailVerification, { ResendCodeOptions } from '@auth0/auth0-acul-js/login-email-verification'; - -const loginEmailVerificationManager = new LoginEmailVerification(); - -// Optional: Define any custom options for the resend request -const payload: ResendCodeOptions = { - // customParam: "anotherCustomValue" -}; - -async function resendVerificationCode() { - try { - await loginEmailVerificationManager.resendCode(payload); - // A new code will be sent to the user's email. - // The UI should ideally provide feedback to the user (e.g., "A new code has been sent."). - // If Auth0 encounters an issue (e.g., "too-many-emails"), it will be reflected in - // `loginEmailVerificationManager.transaction.errors` after the page re-renders or the promise resolves. - } catch (error) { - // Handles unexpected errors during the resend request (e.g., network issues). - console.error('Failed to resend verification code:', error); - } -} - -resendVerificationCode(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - The unique identifier for the Login Email Verification screen. This static property is used by the SDK's `BaseContext` to ensure that the class is instantiated in the correct screen context. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continueWithCode" type={<span>Promise<void></span>}> - Submits the email verification code entered by the user to Auth0. This method prepares and posts the form data, including the verification code and the required `action: "default"`, to the `/u/login-email-verification` endpoint. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithCodeOptions">ContinueWithCodeOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>}> - Requests Auth0 to send a new verification code to the user's email address. This is typically used when the user didn't receive the original code, or it has expired. This method posts form data with `action: "resend-code"` to the `/u/login-email-verification` endpoint. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions">ResendCodeOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> - Gets resend functionality with timeout management for this screen - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/login-email-verification/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/login-email-verification/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginId.mdx deleted file mode 100644 index 7bc03f8b4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginId.mdx +++ /dev/null @@ -1,178 +0,0 @@ ---- -title: "LoginId" -description: "" ---- - -<RequestExample> - -```typescript login lines -import LoginId from "@auth0/auth0-acul-js/login-id" - -const loginIdManager = new LoginId(); - -loginIdManager.login({ - username: "testUser" -}) -``` - -```typescript error handling lines -import LoginId from "@auth0/auth0-acul-js/login-id" - -const loginIdManager = new LoginId(); -const errors = loginIdManager.getErrors(); - -loginIdManager.login({ - username: "testUser" -}) - -return ( - <div> - {/* Render the login ID screen content */} - <button onclick={handleLogin}>Continue<button> - {loginIdManager.transaction.hasErrors && errors && ( - // A custom React component that renders a <div> with error details - <ErrorMessages errors={errors} /> - )} -) -``` - -```typescript federatedLogin lines -import LoginId from "@auth0/auth0-acul-js/login-id"; -const loginIdManager = new LoginId(); - -// Check if alternateConnections is available and has at least one item -if (!loginIdManager.transaction.alternateConnections) { - console.error('No alternate connections available.'); -} - -// Select the first available connection (users can select any available connection) -const selectedConnection = alternateConnections[0]; - -// Log the chosen connection for debugging or informational purposes -console.log(`Selected connection: ${selectedConnection.name}`); - -// Proceed with federated login using the selected connection -loginIdManager.federatedLogin({ - connection: selectedConnection.name, -}) -``` - -```typescript passkeyLogin lines -import LoginId from "@auth0/auth0-acul-js/login-id"; -const loginIdManager = new LoginId(); - -// it internally maps users available passkey config provided from auth0 server -loginIdManager.passkeyLogin(); -``` - -```typescript pickCountryCode lines -import LoginId from "@auth0/auth0-acul-js/login-id"; -const loginIdManager = new LoginId(); - -loginIdManager.pickCountryCode(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="#passkeyController" type={<span>AbortController</span>}> -</ParamField> - -<ParamField path="#isConditionalUIRegistered" type={<span>any</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="transaction" type={<span>TransactionOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="login" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions">LoginOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="federatedLogin" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions">FederatedLoginOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="passkeyLogin" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="pickCountryCode" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getLoginIdentifiers" type={<span>IdentifierType[] | null</span>}> - Gets the active identifier types for the login screen - -</ParamField> - -<ParamField path="registerPasskeyAutofill" type={<span>Promise<void></span>}> - This method delegates to the internal `registerPasskeyAutofill()` utility, returning a background `AbortController` to manage request lifetime. It should only be invoked once per page lifecycle. - - <Expandable title="parameters"> - <ParamField path="inputId" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/login-id/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/login-id/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPassword.mdx deleted file mode 100644 index 714d17678..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPassword.mdx +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: "LoginPassword" -description: "" ---- - -<RequestExample> - -```typescript login lines -import LoginPassword from "@auth0/auth0-acul-js/login-password" - -const loginPasswordManager = new LoginPassword(); - -loginPasswordManager.login({ - username: "testUser", - password: "******" -}); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="transaction" type={<span>TransactionOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="login" type={<span>Promise<void></span>}> - This methods handles login-password related configuration. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordOptions">LoginPasswordOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="federatedLogin" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions">FederatedLoginOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/login-password/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/login-password/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessEmailCode.mdx deleted file mode 100644 index 342477933..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessEmailCode.mdx +++ /dev/null @@ -1,218 +0,0 @@ ---- -title: "LoginPasswordlessEmailCode" -description: "" ---- - -<RequestExample> - -```typescript continueWithEmailCode lines -//Creates an instance of LoginPasswordlessEmailCode and calls the method with sample data. -import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code'; -const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode(); - -loginPasswordlessEmailCode.submitCode({ - email: "test@domain.com"; - code: "testcode"; -}); -``` - -```typescript resendCode lines -import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code'; - -const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode(); -loginPasswordlessEmailCode.resendCode(); -``` - -```typescript LoginPasswordlessEmailCode React Example lines -import React, { useState } from 'react'; -import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code'; - -const LoginPasswordlessEmailCodeScreen: React.FC = () => { - const [email, setEmail] = useState(''); - const [code, setCode] = useState(''); - const [error, setError] = useState(''); - const [success, setSuccess] = useState(false); - const [resent, setResent] = useState(false); - - const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode(); - - const handleSubmit = async (e) => { - e.preventDefault(); - setError(''); - setSuccess(false); - setResent(false); - - if (!email || !code) { - setError('Email and code are required.'); - return; - } - - try { - await loginPasswordlessEmailCode.submitCode({ email, code }); - setSuccess(true); - } catch (err) { - setError('Invalid code or email. Please try again.'); - } - }; - - const handleResend = async () => { - setError(''); - setSuccess(false); - setResent(false); - try { - await loginPasswordlessEmailCode.resendCode(); - setResent(true); - } catch (err) { - setError('Failed to resend code. Please try again later.'); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - Continue with Email Code - </h2> - </div> - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label htmlFor="email" className="block text-sm font-medium text-gray-700"> - Email - </label> - <div className="mt-1"> - <input - id="email" - name="email" - type="email" - required - value={email} - onChange={(e) => setEmail(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - <div> - <label htmlFor="code" className="block text-sm font-medium text-gray-700"> - Code - </label> - <div className="mt-1"> - <input - id="code" - name="code" - type="text" - required - value={code} - onChange={(e) => setCode(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - {error && <div className="text-red-600 text-sm">{error}</div>} - {success && <div className="text-green-600 text-sm">Login successful!</div>} - {resent && <div className="text-blue-600 text-sm">Code resent to your email.</div>} - <div className="flex items-center justify-between"> - <button - type="submit" - className="flex-1 mr-2 py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Continue - </button> - <button - type="button" - onClick={handleResend} - className="flex-1 ml-2 py-2 px-4 border border-blue-600 rounded-md shadow-sm text-sm font-medium text-blue-600 bg-white hover:bg-blue-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Resend Code - </button> - </div> - </form> - </div> - </div> - </div> - ); -}; - -export default LoginPasswordlessEmailCodeScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="transaction" type={<span>TransactionOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="submitCode" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCodeOptions">SubmitCodeOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> - Creates a resend control manager for handling email code resend operations. - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/login-passwordless-email-code/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessSmsOtp.mdx deleted file mode 100644 index 1fd2d8429..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessSmsOtp.mdx +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: "LoginPasswordlessSmsOtp" -description: "" ---- - -<RequestExample> - -```typescript submitOTP lines -//Creates an instance of LoginPasswordlessSmsOtp and calls the method with sample data. -import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; -const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); - -loginPasswordlessSmsOtp.submitOTP({ - username: "test@domain.com"; - otp: "testOTP"; -}); -``` - -```typescript resendOTP lines -import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; - -const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); -loginPasswordlessSmsOtp.resendOTP(); -``` - -```typescript resendManager lines -import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; - -const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); - -function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { - console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); -} - -function handleTimeout() { - console.log('Resend timeout completed'); -} - -const resendManager = loginPasswordlessSmsOtp.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleTimeout, -}); - -const { startResend } = resendManager; - -// Use startResend() to initiate the resend with cooldown -startResend(); -``` - -```typescript LoginPasswordlessSmsOtp React Example lines -import React, { useState, useMemo } from 'react'; -import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; - -const LoginPasswordlessSmsOtpScreen: React.FC = () => { - const [username, setUsername] = useState(''); - const [otp, setOtp] = useState(''); - const [error, setError] = useState(''); - const [success, setSuccess] = useState(false); - const [disabled, setDisabled] = useState(false); - const [remainingSeconds, setRemainingSeconds] = useState(0); - - const loginPasswordlessSmsOtp = useMemo(() => new LoginPasswordlessSmsOtp(), []); - - function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { - setDisabled(isDisabled); - setRemainingSeconds(remainingSeconds); - } - - function handleTimeout() { - console.log('Resend timeout completed'); - } - - const resendManager = useMemo( - () => - loginPasswordlessSmsOtp.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleTimeout, - }), - [loginPasswordlessSmsOtp] - ); - - const { startResend } = resendManager; - - const handleSubmit = async (e) => { - e.preventDefault(); - setError(''); - setSuccess(false); - - if (!username || !otp) { - setError('Username and OTP are required.'); - return; - } - - try { - await loginPasswordlessSmsOtp.submitOTP({ username, otp }); - setSuccess(true); - } catch (err) { - setError('Invalid OTP or username. Please try again.'); - } - }; - - const handleResend = async () => { - try { - await startResend(); - } catch (err) { - setError('Failed to resend OTP. Please try again later.'); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - Continue with SMS OTP - </h2> - </div> - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label htmlFor="username" className="block text-sm font-medium text-gray-700"> - Username - </label> - <div className="mt-1"> - <input - id="username" - name="username" - type="text" - required - value={username} - onChange={(e) => setUsername(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - <div> - <label htmlFor="otp" className="block text-sm font-medium text-gray-700"> - OTP - </label> - <div className="mt-1"> - <input - id="otp" - name="otp" - type="text" - required - value={otp} - onChange={(e) => setOtp(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - {error && <div className="text-red-600 text-sm">{error}</div>} - {success && <div className="text-green-600 text-sm">Login successful!</div>} - <div className="flex items-center justify-between"> - <button - type="submit" - className="flex-1 mr-2 py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Continue - </button> - <button - type="button" - onClick={handleResend} - disabled={disabled} - className={`flex-1 ml-2 py-2 px-4 border rounded-md shadow-sm text-sm font-medium focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 ${ - disabled - ? 'bg-gray-300 text-gray-500 cursor-not-allowed border-gray-300' - : 'border-blue-600 text-blue-600 bg-white hover:bg-blue-50' - }`} - > - {disabled ? `Resend OTP in ${remainingSeconds}s` : 'Resend OTP'} - </button> - </div> - </form> - </div> - </div> - </div> - ); -}; - -export default LoginPasswordlessSmsOtpScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="transaction" type={<span>TransactionOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="submitOTP" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitOTPOptions">SubmitOTPOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendOTP" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> - Gets resend functionality with timeout management for this screen - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/login-passwordless-sms-otp/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Logout.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Logout.mdx deleted file mode 100644 index a2073b207..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Logout.mdx +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: "Logout" -description: "Class implementing the logout screen functionality. This screen allows users to confirm or deny the logout action." ---- - -<RequestExample> - -```tsx Basic Usage lines -import Logout, { type ConfirmLogoutOptions } from '@auth0/auth0-acul-js/logout'; - -const logout = new Logout(); - -// Confirm logout (yes) -await logout.confirmLogout({ action: 'accept' }); - -// Or cancel logout (no) -await logout.confirmLogout({ action: 'deny' }); -``` - -```tsx React Component Example with TailwindCSS lines -import React, {useEffect } from 'react'; -import Logout, { type ConfirmLogoutOptions} from '@auth0/auth0-acul-js/logout'; - -const LogoutScreen: React.FC = () => { - const logout = new Logout(); - const { screen, transaction: { errors } } = logout; - const texts = screen.texts ?? {}; - - // Update the document title if provided - useEffect(() => { - if (texts.pageTitle) { - document.title = texts.pageTitle; - } - }, [texts.pageTitle]); - - const handleAction = async (action: ConfirmLogoutOptions['action']) => { - await logout.confirmLogout({ action } as ConfirmLogoutOptions); - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col px-4 py-12"> - <div className="mx-auto w-full max-w-md bg-white shadow-md rounded px-8 pt-6 pb-8"> - <h1 className="text-2xl font-bold mb-4 text-center"> - {texts.title ?? 'Logout'} - </h1> - - {texts.userSalute && ( - <p className="text-sm text-gray-600 mb-2"> - {texts.userSalute} - </p> - )} - - <p className="text-sm text-gray-700 mb-6"> - {texts.description ?? 'Are you sure you want to log out?'} - </p> - - {errors?.length && ( - <div className="mt-2 space-y-1 text-left"> - {errors.map((error, idx) => ( - <p key={idx} className="text-red-600 text-sm"> - {error.message} - </p> - ))} - </div> - )} - - <div className="flex justify-between"> - <button - onClick={() => handleAction('deny')} - className="w-[150px] py-2 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - {texts.declineButtonText ?? 'No'} - </button> - - <button - onClick={() => handleAction('accept')} - className="w-[150px] px-4 py-2 bg-blue-600 text-white text-sm font-medium rounded-md shadow-sm hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - {texts.acceptButtonText ?? 'Yes'} - </button> - </div> - - {/* Auth0 badge/link */} - {texts.badgeUrl && ( - <div className="mt-6 text-center"> - <a - href={texts.badgeUrl} - target="_blank" - rel="noopener noreferrer" - className="text-xs text-gray-400 hover:underline" - > - {texts.badgeAltText ?? 'Auth0'} - </a> - </div> - )} - </div> - </div> - ); -}; - -export default LogoutScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="confirmLogout" type={<span>Promise<void></span>}> - Confirms the logout action (accept or deny). - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConfirmLogoutOptions">ConfirmLogoutOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/logout/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/logout/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutAborted.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutAborted.mdx deleted file mode 100644 index ec14789ed..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutAborted.mdx +++ /dev/null @@ -1,123 +0,0 @@ ---- -title: "LogoutAborted" -description: "Class implementing the logout-aborted screen functionality This screen is displayed when a user aborts the logout process." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useEffect } from 'react'; -import LogoutAborted from '@auth0/auth0-acul-js/logout-aborted'; - -const LogoutAbortedScreen: React.FC = () => { - const logoutAborted = new LogoutAborted(); - const { screen, transaction: { errors } } = logoutAborted; - const texts = screen.texts ?? {}; - - // Update the document title if provided by the spec - useEffect(() => { - if (texts.pageTitle) { - document.title = texts.pageTitle; - } - }, [texts.pageTitle]); - - return ( - <div className="min-h-screen bg-gray-100 flex justify-center p-4"> - <div className="w-full h-[300px] max-w-md bg-white shadow-md rounded px-8 pt-6 pb-8 text-center"> - <h1 className="text-2xl font-bold mb-4"> - {texts.eventTitle ?? 'You have not been logged out.'} - </h1> - - {texts.userSalute && ( - <p className="text-sm text-gray-600 mb-2"> - {texts.userSalute} - </p> - )} - - {errors?.length && ( - <div className="mt-2 space-y-1 text-left"> - {errors.map((error, idx) => ( - <p key={idx} className="text-red-600 text-sm"> - {error.message} - </p> - ))} - </div> - )} - - {/* Auth0 badge/link */} - {texts.badgeUrl && ( - <div className="mt-6"> - <a - href={texts.badgeUrl} - target="_blank" - rel="noopener noreferrer" - className="text-xs text-gray-400 hover:underline" - > - {texts.badgeAltText ?? 'Auth0'} - </a> - </div> - )} - </div> - </div> - ); -}; - -export default LogoutAbortedScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/logout-aborted/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/logout-aborted/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutComplete.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutComplete.mdx deleted file mode 100644 index 1e8961a75..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutComplete.mdx +++ /dev/null @@ -1,123 +0,0 @@ ---- -title: "LogoutComplete" -description: "Class implementing the logout-complete screen functionality This screen is displayed when a user aborts the logout process." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useEffect } from 'react'; -import LogoutComplete from '@auth0/auth0-acul-js/logout-complete'; - -const LogoutCompleteScreen: React.FC = () => { - const logoutComplete = new LogoutComplete(); - const { screen, transaction: { errors } } = logoutComplete; - const texts = screen.texts ?? {}; - - // Update the document title if provided by the spec - useEffect(() => { - if (texts.pageTitle) { - document.title = texts.pageTitle; - } - }, [texts.pageTitle]); - - return ( - <div className="min-h-screen bg-gray-100 flex justify-center p-4"> - <div className="w-full h-[300px] max-w-md bg-white shadow-md rounded px-8 pt-6 pb-8 text-center"> - <h1 className="text-2xl font-bold mb-4"> - {texts.eventTitle ?? 'You have successfully logged out.'} - </h1> - - {texts.userSalute && ( - <p className="text-sm text-gray-600 mb-2"> - {texts.userSalute} - </p> - )} - - {errors?.length && ( - <div className="mt-2 space-y-1 text-left"> - {errors.map((error, idx) => ( - <p key={idx} className="text-red-600 text-sm"> - {error.message} - </p> - ))} - </div> - )} - - {/* Auth0 badge/link */} - {texts.badgeUrl && ( - <div className="mt-6"> - <a - href={texts.badgeUrl} - target="_blank" - rel="noopener noreferrer" - className="text-xs text-gray-400 hover:underline" - > - {texts.badgeAltText ?? 'Auth0'} - </a> - </div> - )} - </div> - </div> - ); -}; - -export default LogoutCompleteScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/logout-complete/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/logout-complete/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaBeginEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaBeginEnrollOptions.mdx deleted file mode 100644 index c861248e2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaBeginEnrollOptions.mdx +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: "MfaBeginEnrollOptions" -description: "MFA Begin Enroll Options screen implementation class Handles the selection and enrollment of MFA factors" ---- - -<RequestExample> - -```typescript Basic Usage lines -import MfaBeginEnrollOptions from '@auth0/auth0-acul-js/mfa-begin-enroll-options'; - -const mfaBeginEnrollOptions = new MfaBeginEnrollOptions(); - -// Get available factors from tenant configuration -const { tenant } = mfaBeginEnrollOptions; -const availableFactors = tenant.enabledFactors; - -// Continue with selected factor enrollment -const handleFactorSelection = async (factor: string) => { - try { - await mfaBeginEnrollOptions.enroll({ - action: factor // e.g. 'push-notification', 'otp', 'sms', etc. - }); - } catch (error) { - console.error('Error enrolling factor:', error); - } -}; -``` - -```tsx React Component Example with TailwindCSS lines -import React, { useCallback } from 'react'; -import MfaBeginEnrollOptions, { type FactorType } from '@auth0/auth0-acul-js/mfa-begin-enroll-options'; - -/** Enum for Factor Types */ -enum FactorTypeEnum { - PUSH_NOTIFICATION = 'push-notification', - OTP = 'otp', - SMS = 'sms', - PHONE = 'phone', - VOICE = 'voice', - WEBAUTHN_ROAMING = 'webauthn-roaming' -} - -const MfaBeginEnrollOptionsScreen: React.FC = () => { - const mfaBeginEnrollOptions = new MfaBeginEnrollOptions(); - const { tenant, screen: { texts } } = mfaBeginEnrollOptions; - - /** Dynamically map factor IDs to display names */ - const factorDisplayNames: Record<FactorTypeEnum, string> = { - [FactorTypeEnum.PUSH_NOTIFICATION]: texts?.authenticatorNamesPushNotification ?? 'Push Notification (Auth0 Guardian)', - [FactorTypeEnum.OTP]: texts?.authenticatorNamesOTP ?? 'One-Time Password (Google Authenticator)', - [FactorTypeEnum.SMS]: texts?.authenticatorNamesSMS ?? 'SMS', - [FactorTypeEnum.PHONE]: texts?.authenticatorNamesPhone ?? 'Phone Call', - [FactorTypeEnum.VOICE]: texts?.authenticatorNamesVoice ?? 'Voice Call', - [FactorTypeEnum.WEBAUTHN_ROAMING]: texts?.authenticatorNamesWebauthnRoaming ?? 'Security Key' - }; - - /** Handles user selection of an MFA factor */ - const handleFactorSelection = useCallback(async (factor: FactorTypeEnum) => { - try { - await mfaBeginEnrollOptions.enroll({ - action: factor as FactorType - }); - } catch (error) { - console.error(`Error enrolling factor [${factor}]:`, error); - } - }, []); - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col flex-start py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="text-center text-3xl font-extrabold text-gray-900"> - {texts?.title ?? 'Multi-factor Authentication'} - </h2> - <p className="mt-2 text-center text-sm text-gray-600"> - {texts?.description ?? 'Choose a Multi-factor Authentication Method'} - </p> - </div> - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <div className="space-y-4"> - {tenant.enabledFactors?.map((factor) => { - const factorEnum = factor as FactorTypeEnum; - return ( - <button - key={factor} - onClick={() => handleFactorSelection(factorEnum)} - className="w-full flex justify-center py-3 px-4 border border-gray-300 rounded-md shadow-sm bg-white hover:bg-gray-50 text-sm font-medium text-gray-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - {factorDisplayNames[factorEnum]} - </button> - ); - })} - </div> - </div> - </div> - </div> - ); -}; - -export default MfaBeginEnrollOptionsScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="enroll" type={<span>Promise<void></span>}> - Continues the enrollment process with the selected factor - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollOptions">MfaEnrollOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-begin-enroll-options/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-begin-enroll-options/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaCountryCodes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaCountryCodes.mdx deleted file mode 100644 index 5bdc380ce..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaCountryCodes.mdx +++ /dev/null @@ -1,173 +0,0 @@ ---- -title: "MfaCountryCodes" -description: "Class implementing the mfa-country-codes screen functionality This screen allows users to select a country code for MFA phone number verification" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React from 'react'; -import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes'; - -const MfaCountryCodesScreen: React.FC = () => { - const mfaCountryCodes = new MfaCountryCodes(); - const { screen } = mfaCountryCodes; - const { phone_prefixes } = screen.data || {}; - const handleCountrySelect = async (countryCode: string, phonePrefix: string) => { - try { - await mfaCountryCodes.selectCountryCode({ - country_code: countryCode, - phone_prefix: phonePrefix - }); - } catch (error) { - console.error('Failed to select country code:', error); - } - }; - - const handleGoBack = async () => { - try { - await mfaCountryCodes.goBack(); - } catch (error) { - console.error('Failed to go back:', error); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - Select Your Country Code - </h2> - </div> - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <div className="space-y-4"> - {phone_prefixes?.map((prefix, index) => ( - <button - key={`${prefix.country_code}${index}`} - onClick={() => handleCountrySelect(prefix.country_code, prefix.phone_prefix)} - className="w-full flex justify-between items-center py-3 px-4 border border-gray-300 rounded-md shadow-sm bg-white hover:bg-gray-50 text-sm font-medium text-gray-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - <span>{prefix.country}</span> - <span className="text-gray-500">{prefix.phone_prefix}</span> - </button> - ))} - </div> - - <div className="mt-6"> - <button - onClick={handleGoBack} - className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Go Back - </button> - </div> - </div> - </div> - </div> - ); -}; - -export default MfaCountryCodesScreen; -``` - -```typescript Select Country Code lines -import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes'; - - const mfaCountryCodes = new MfaCountryCodes(); - - // Get the available country codes and phone prefixes - const { screen } = mfaCountryCodes; - const { phone_prefixes } = screen.data - const {country_code, phone_prefix} = phone_prefixes[0] - - await mfaCountryCodes.selectCountryCode({ - country_code: 'US', - phone_prefix: '+1', - }); -``` - -```typescript Go Back lines -import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes'; - -const mfaCountryCodes = new MfaCountryCodes(); - -// Navigate back to the previous screen -await mfaCountryCodes.goBack(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="selectCountryCode" type={<span>Promise<void></span>}> - Selects a country code from the available options - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectCountryCodeOptions">SelectCountryCodeOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="goBack" type={<span>Promise<void></span>}> - Navigates back to the previous screen - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-country-codes/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaDetectBrowserCapabilities.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaDetectBrowserCapabilities.mdx deleted file mode 100644 index 2f91bb44e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaDetectBrowserCapabilities.mdx +++ /dev/null @@ -1,165 +0,0 @@ ---- -title: "MfaDetectBrowserCapabilities" -description: "Class implementing the mfa-detect-browser-capabilities screen functionality This screen detects browser capabilities for MFA authentication methods" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useEffect, useState } from 'react'; -import MfaDetectBrowserCapabilities from '@auth0/auth0-acul-js/mfa-detect-browser-capabilities'; - -const MfaDetectBrowserCapabilitiesScreen: React.FC = () => { - const [isLoading, setIsLoading] = useState(true); - const [error, setError] = useState<string | null>(null); - const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); - - useEffect(() => { - const detectCapabilities = async () => { - try { - setIsLoading(true); - setError(null); - - await mfaDetectBrowserCapabilities.detectCapabilities(); - } catch (err) { - setError('Failed to detect browser capabilities. Please try again.'); - console.error('Error:', err); - } finally { - setIsLoading(false); - } - }; - - detectCapabilities(); - }, []); - - if (isLoading) { - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <div className="flex justify-center"> - <div className="animate-spin rounded-full h-12 w-12 border-b-2 border-blue-500" /> - </div> - <p className="mt-4 text-center text-sm text-gray-600"> - Detecting browser capabilities... - </p> - </div> - </div> - </div> - ); - } - - if (error) { - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <div className="rounded-md bg-red-50 p-4"> - <div className="flex"> - <div className="flex-shrink-0"> - <svg - className="h-5 w-5 text-red-400" - xmlns="http://www.w3.org/2000/svg" - viewBox="0 0 20 20" - fill="currentColor" - > - <path - fillRule="evenodd" - d="M10 18a8 8 0 100-16 8 8 0 000 16zM8.707 7.293a1 1 0 00-1.414 1.414L8.586 10l-1.293 1.293a1 1 0 101.414 1.414L10 11.414l1.293 1.293a1 1 0 001.414-1.414L11.414 10l1.293-1.293a1 1 0 00-1.414-1.414L10 8.586 8.707 7.293z" - clipRule="evenodd" - /> - </svg> - </div> - <div className="ml-3"> - <h3 className="text-sm font-medium text-red-800">{error}</h3> - </div> - </div> - </div> - </div> - </div> - </div> - ); - } - - return null; // The screen will automatically redirect after successful capability detection -}; - -export default MfaDetectBrowserCapabilitiesScreen; -``` - -```typescript Detect Browser Capabilities lines -import MfaDetectBrowserCapabilities from '@auth0/auth0-acul-js/mfa-detect-browser-capabilities'; - -const detectBrowserCapabilities = async () => { - const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); - - // Submit capabilities - await mfaDetectBrowserCapabilities.detectCapabilities(); -}; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="detectCapabilities" type={<span>Promise<void></span>}> - Picks an authenticator based on browser capabilities - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-detect-browser-capabilities/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-detect-browser-capabilities/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailChallenge.mdx deleted file mode 100644 index db547b7be..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailChallenge.mdx +++ /dev/null @@ -1,343 +0,0 @@ ---- -title: "MfaEmailChallenge" -description: "Class implementing the mfa-email-challenge screen functionality This screen is shown when a user needs to verify their email during MFA" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState, useEffect, useMemo } from 'react'; -import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; - -const MfaEmailChallengeScreen: React.FC = () => { - const [code, setCode] = useState(''); - const [rememberDevice, setRememberDevice] = useState(false); - const [error, setError] = useState(''); - const [disabled, setDisabled] = useState(false); - const [remainingSeconds, setRemainingSeconds] = useState(0); - - const mfaEmailChallenge = useMemo(() => new MfaEmailChallenge(), []); - const { screen } = mfaEmailChallenge; - - function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { - setDisabled(isDisabled); - setRemainingSeconds(remainingSeconds); - } - - function handleTimeout() { - console.log('Resend timeout completed'); - } - - const resendManager = useMemo( - () => - mfaEmailChallenge.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleTimeout, - }), - [mfaEmailChallenge] - ); - - const { startResend } = resendManager; - - // Initialize form values from untrustedData - useEffect(() => { - // Use untrustedData to prepopulate form fields if available - const savedFormData = mfaEmailChallenge.untrustedData.submittedFormData; - if (savedFormData?.rememberDevice !== undefined) { - setRememberDevice(savedFormData.rememberDevice); - } - }, [mfaEmailChallenge]); - - const handleSubmit = async (e: React.FormEvent) => { - e.preventDefault(); - setError(''); - - try { - await mfaEmailChallenge.continue({ - code, - rememberDevice, - }); - } catch (err) { - setError('Failed to verify code. Please try again.'); - } - }; - - const handleResendCode = async () => { - try { - await startResend(); - } catch (err) { - setError('Failed to resend code. Please try again.'); - } - }; - const handlePickEmail = async () => { - try { - await mfaEmailChallenge.pickEmail(); - } catch (err) { - setError('Failed pick email. Please try again.'); - } - }; - - const handleTryAnotherMethod = async () => { - try { - await mfaEmailChallenge.tryAnotherMethod(); - } catch (err) { - setError('Failed to try another method. Please try again.'); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - Verify Your Email - </h2> - <p className="mt-2 text-center text-sm text-gray-600"> - Enter the code sent to {screen.data?.email} - </p> - </div> - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label - htmlFor="code" - className="block text-sm font-medium text-gray-700" - > - Code - </label> - <div className="mt-1"> - <input - id="code" - name="code" - type="text" - required - value={code} - onChange={(e) => setCode(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - - {screen.data?.showRememberDevice && ( - <div className="flex items-center"> - <input - id="rememberDevice" - name="rememberDevice" - type="checkbox" - className="h-4 w-4 text-blue-600 focus:ring-blue-500 border-gray-300 rounded" - checked={rememberDevice} - onChange={(e) => setRememberDevice(e.target.checked)} - /> - <label - htmlFor="rememberDevice" - className="ml-2 block text-sm text-gray-900" - > - Remember this device - </label> - </div> - )} - - - - <div> - <button - type="submit" - className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Verify Code - </button> - </div> - </form> - - <div className="mt-6"> - <div className="flex justify-between"> - <button - onClick={handleResendCode} - disabled={disabled} - className={`text-sm ${disabled ? 'text-gray-400 cursor-not-allowed' : 'text-blue-600 hover:text-blue-500'}`} - > - {disabled ? `Resend code in ${remainingSeconds}s` : 'Resend Code'} - </button> - <button - onClick={handlePickEmail} - className="text-sm text-blue-600 hover:text-blue-500" - > - Pick Email - </button> - <button - onClick={handleTryAnotherMethod} - className="text-sm text-blue-600 hover:text-blue-500" - > - Try Another Method - </button> - </div> - </div> - - {error && <div className="text-red-600 text-sm mt-2">{error}</div>} - </div> - </div> - </div> - ); -}; - -export default MfaEmailChallengeScreen; -``` - -```typescript resendManager lines -import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; - -const mfaEmailChallenge = new MfaEmailChallenge(); - -function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { - console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); -} - -function handleTimeout() { - console.log('Resend timeout completed'); -} - -const resendManager = mfaEmailChallenge.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleTimeout, -}); - -const { startResend } = resendManager; - -// Use startResend() to initiate the resend with cooldown -startResend(); -``` - -```typescript Continue with Code lines -import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; - -const mfaEmailChallenge = new MfaEmailChallenge(); - -// Access untrustedData to prepopulate form fields -const { rememberDevice } = mfaEmailChallenge.untrustedData.submittedFormData || {}; - -mfaEmailChallenge.continue({ - code: '123456', - rememberDevice: rememberDevice || false, -}); -``` - -```typescript Resend Code lines -import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; - -const mfaEmailChallenge = new MfaEmailChallenge(); - -mfaEmailChallenge.resendCode(); -``` - -```typescript Try Another Method lines -import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; - -const mfaEmailChallenge = new MfaEmailChallenge(); - -mfaEmailChallenge.tryAnotherMethod(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span>UntrustedDataOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Continues with the email challenge using the provided code - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>}> - Resends the email code - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions">ResendCodeOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows the user to try another MFA method - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="pickEmail" type={<span>Promise<void></span>}> - Submits the action to pick a different Email configuration, if available. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> - Gets resend functionality with timeout management for this screen - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-email-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailList.mdx deleted file mode 100644 index fc7ac4f16..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailList.mdx +++ /dev/null @@ -1,167 +0,0 @@ ---- -title: "MfaEmailList" -description: "Class implementing the mfa-email-list screen functionality This screen allows users to select an enrolled email address for MFA" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React from 'react'; -import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list'; - -const MfaEmailListScreen: React.FC = () => { - const mfaEmailList = new MfaEmailList(); - const { user } = mfaEmailList; - - const handleSelectEmail = async (index: number) => { - try { - await mfaEmailList.selectMfaEmail({ - index: index, - }); - } catch (error) { - console.error('Failed to select email:', error); - } - }; - - const handleGoBack = async () => { - try { - await mfaEmailList.goBack(); - } catch (error) { - console.error('Failed to go back:', error); - } - }; - - return ( - <div className="flex flex-col items-center justify-center min-h-screen bg-gray-100"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4"> - <h2 className="text-2xl font-bold mb-4">Select an Email Address</h2> - { - user.enrolledEmails ? ( - <ul className="mb-4"> - {user.enrolledEmails.map((email, index) => ( - <li key={index} className="py-2"> - <button - onClick={() => handleSelectEmail(index)} - className="bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded" - > - {email} - </button> - </li> - ))} - </ul> - ) : ( - <p>No email addresses enrolled.</p> - ) - } - <button - onClick={handleGoBack} - className="bg-gray-500 hover:bg-gray-700 text-white font-bold py-2 px-4 rounded" - > - Back - </button> - </div> - </div> - ); -}; - -export default MfaEmailListScreen; -``` - -```typescript Select MFA Email lines -import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list'; - -const mfaEmailList = new MfaEmailList(); -const getEnrolledEmails = mfaSmsList.user.enrolledEmails; -// select any email from list, for demonstration we will pick up first email -const selectedEmail = getEnrolledEmails[0] - -// Select the first email address (index 0) -await mfaEmailList.selectMfaEmail({ - index: selectedEmail -}); -``` - -```typescript Go Back lines -import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list'; - -const mfaEmailList = new MfaEmailList(); - -// Navigate back to the previous screen -await mfaEmailList.goBack(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - The screen object for the mfa-email-list screen -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="selectMfaEmail" type={<span>Promise<void></span>}> - Selects an enrolled email address from the list - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaEmailOptions">SelectMfaEmailOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="goBack" type={<span>Promise<void></span>}> - Navigates back to the previous screen - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-email-list/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEnrollResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEnrollResult.mdx deleted file mode 100644 index 7fa8ac67b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEnrollResult.mdx +++ /dev/null @@ -1,221 +0,0 @@ ---- -title: "MfaEnrollResult" -description: "" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React from 'react'; -import MfaEnrollResult from '@auth0/auth0-acul-js/mfa-enroll-result'; - -const MfaEnrollResultScreen: React.FC = () => { - const mfaEnrollResult = new MfaEnrollResult(); - const { screen } = mfaEnrollResult; - - // Determine message and styling based on enrollment status - let title = screen.texts?.title ?? 'MFA Enrollment'; - - let description = screen.texts?.description ?? 'Your multi-factor authentication status.'; - let iconComponent = null; - let textColorClass = 'text-gray-900'; - let iconColorClass = 'text-gray-500'; - - // Use data.status to determine the enrollment result - const enrollmentStatus = screen.data?.status; - - if (enrollmentStatus === 'success') { - title = screen.texts?.titleSuccess ?? 'MFA Enrollment Complete'; - description = screen.texts?.descriptionSuccess ?? 'Your multi-factor authentication has been successfully set up.'; - textColorClass = 'text-green-700'; - iconColorClass = 'text-green-500'; - iconComponent = ( - <svg - className={`h-12 w-12 ${iconColorClass}`} - fill="none" - stroke="currentColor" - viewBox="0 0 24 24" - xmlns="http://www.w3.org/2000/svg" - > - <path - strokeLinecap="round" - strokeLinejoin="round" - strokeWidth={2} - d="M5 13l4 4L19 7" - /> - </svg> - ); - } else if (enrollmentStatus === 'failure') { - title = screen.texts?.titleFailure ?? 'MFA Enrollment Failed'; - description = screen.texts?.descriptionFailure ?? 'There was a problem setting up your multi-factor authentication.'; - textColorClass = 'text-red-700'; - iconColorClass = 'text-red-500'; - iconComponent = ( - <svg - className={`h-12 w-12 ${iconColorClass}`} - fill="none" - stroke="currentColor" - viewBox="0 0 24 24" - xmlns="http://www.w3.org/2000/svg" - > - <path - strokeLinecap="round" - strokeLinejoin="round" - strokeWidth={2} - d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" - /> - </svg> - ); - } else if (enrollmentStatus === 'already-enrolled') { - title = screen.texts?.titleAlreadyEnrolled ?? 'Already Enrolled'; - description = screen.texts?.alreadyEnrolledDescription ?? 'Two-factor Verification has Already Been Enabled.'; - textColorClass = 'text-blue-700'; - iconColorClass = 'text-blue-500'; - iconComponent = ( - <svg - className={`h-12 w-12 ${iconColorClass}`} - fill="none" - stroke="currentColor" - viewBox="0 0 24 24" - xmlns="http://www.w3.org/2000/svg" - > - <path - strokeLinecap="round" - strokeLinejoin="round" - strokeWidth={2} - d="M9 12l2 2 4-4m6 2a9 9 0 11-18 0 9 9 0 0118 0z" - /> - </svg> - ); - } else if (enrollmentStatus === 'already-used') { - title = screen.texts?.alreadyUsedTitle ?? 'Already Used'; - description = screen.texts?.alreadyUsedDescription ?? 'This link has already been used. Please get a new link to enroll with Multi-factor Authentication.'; - textColorClass = 'text-orange-700'; - iconColorClass = 'text-orange-500'; - iconComponent = ( - <svg - className={`h-12 w-12 ${iconColorClass}`} - fill="none" - stroke="currentColor" - viewBox="0 0 24 24" - xmlns="http://www.w3.org/2000/svg" - > - <path - strokeLinecap="round" - strokeLinejoin="round" - strokeWidth={2} - d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" - /> - </svg> - ); - } else { - // Default or unknown status - iconComponent = ( - <svg - className={`h-12 w-12 ${iconColorClass}`} - fill="none" - stroke="currentColor" - viewBox="0 0 24 24" - xmlns="http://www.w3.org/2000/svg" - > - <path - strokeLinecap="round" - strokeLinejoin="round" - strokeWidth={2} - d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" - /> - </svg> - ); - } - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className={`mt-6 text-center text-3xl font-extrabold ${textColorClass}`}> - {title} - </h2> - <p className="mt-2 text-center text-sm text-gray-600"> - {description} - </p> - </div> - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <div className="flex items-center justify-center"> - {iconComponent} - </div> - - <div className="mt-6 text-center"> - <p className="text-sm text-gray-500"> - {screen.texts?.badgeAltText && ( - <span className="block mt-2">{screen.texts.badgeAltText}</span> - )} - </p> - </div> - </div> - </div> - </div> - ); -}; - -export default MfaEnrollResultScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - static -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - Holds the specific screen data and properties for the MFA Enroll Result screen, including the enrollment `status`. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-enroll-result/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-enroll-result/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaLoginOptions.mdx deleted file mode 100644 index 64e62baff..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaLoginOptions.mdx +++ /dev/null @@ -1,184 +0,0 @@ ---- -title: "MfaLoginOptions" -description: "Class implementing the mfa-login-options screen functionality This screen allows users to select which MFA factor they want to use for login" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useCallback } from 'react'; -import MfaBeginEnrollOptions, { type LoginFactorType } from '@auth0/auth0-acul-js/mfa-login-options'; - -/** Enum for Factor Types */ -enum FactorTypeEnum { - PUSH_NOTIFICATION = 'push-notification', - OTP = 'otp', - SMS = 'sms', - PHONE = 'phone', - VOICE = 'voice', - EMAIL = 'email', - RECOVERY_CODE = 'recovery-code', - WEBAUTHN_ROAMING = 'webauthn-roaming', - WEBAUTHN_PLATFORM = 'webauthn-platform', - DUO = 'duo' -} - -const MfaLoginOptionsScreen: React.FC = () => { - const mfaBeginEnrollOptions = new MfaBeginEnrollOptions(); - const { tenant, screen: { texts } } = mfaBeginEnrollOptions; - - /** Dynamically map factor IDs to display names */ - const factorDisplayNames: Record<FactorTypeEnum, string> = { - [FactorTypeEnum.PUSH_NOTIFICATION]: texts?.authenticatorNamesPushNotification ?? 'Push Notification (Auth0 Guardian)', - [FactorTypeEnum.OTP]: texts?.authenticatorNamesOTP ?? 'One-Time Password (Google Authenticator)', - [FactorTypeEnum.SMS]: texts?.authenticatorNamesSMS ?? 'SMS', - [FactorTypeEnum.PHONE]: texts?.authenticatorNamesPhone ?? 'Phone Call', - [FactorTypeEnum.VOICE]: texts?.authenticatorNamesVoice ?? 'Voice Call', - [FactorTypeEnum.EMAIL]: texts?.authenticatorNamesEmail ?? 'Email', - [FactorTypeEnum.RECOVERY_CODE]: texts?.authenticatorNamesRecoveryCode ?? 'Recovery Code', - [FactorTypeEnum.WEBAUTHN_PLATFORM]: texts?.authenticatorNamesWebauthnPlatform ?? 'Platform Authenticator', - [FactorTypeEnum.WEBAUTHN_ROAMING]: texts?.authenticatorNamesWebauthnRoaming ?? 'Security Key', - [FactorTypeEnum.DUO]: texts?.authenticatorNamesDuo ?? 'Notification via DUO app' - }; - - /** Handles user selection of an MFA factor */ - const handleFactorSelection = useCallback(async (factor: FactorTypeEnum) => { - try { - await mfaBeginEnrollOptions.enroll({ - action: factor as LoginFactorType - }); - } catch (error) { - console.error(`Error enrolling factor [${factor}]:`, error); - } - }, []); - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col flex-start py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="text-center text-3xl font-extrabold text-gray-900"> - {texts?.title ?? 'Multi-factor Authentication'} - </h2> - <p className="mt-2 text-center text-sm text-gray-600"> - {texts?.description ?? 'Choose a Multi-factor Authentication Method'} - </p> - </div> - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <div className="space-y-4"> - {tenant.enabledFactors?.map((factor) => { - const factorEnum = factor as FactorTypeEnum; - return ( - <button - key={factor} - onClick={() => handleFactorSelection(factorEnum)} - className="w-full flex justify-center py-3 px-4 border border-gray-300 rounded-md shadow-sm bg-white hover:bg-gray-50 text-sm font-medium text-gray-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - {factorDisplayNames[factorEnum]} - </button> - ); - })} - </div> - </div> - </div> - </div> - ); -}; - -export default MfaLoginOptionsScreen; -``` - -```typescript Continue with Selected Factor lines -import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options'; - -const mfaLoginOptions = new MfaLoginOptions(); - -// Continue with push notification -await mfaLoginOptions.enroll({ - action: 'push-notification' -}); - -// Continue with SMS -await mfaLoginOptions.enroll({ - action: 'sms' -}); - -// Continue with OTP -await mfaLoginOptions.enroll({ - action: 'otp' -}); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaLoginOptions">ScreenMembersOnMfaLoginOptions</a></span>} required> - The screen object for the mfa-login-options screen -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="enroll" type={<span>Promise<void></span>}> - Continues the login process with the selected MFA factor - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEnrollOptions">LoginEnrollOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="returnToPrevious" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-login-options/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpChallenge.mdx deleted file mode 100644 index 3189babf2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpChallenge.mdx +++ /dev/null @@ -1,244 +0,0 @@ ---- -title: "MfaOtpChallenge" -description: "Class implementing the mfa-otp-challenge screen functionality This screen is shown when a user needs to enter an OTP code during MFA" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState, useEffect } from 'react'; -import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge'; - -const MfaOtpChallengeScreen: React.FC = () => { - const [code, setCode] = useState(''); - const [rememberDevice, setRememberDevice] = useState(false); - const [error, setError] = useState(''); - - const mfaOtpChallenge = new MfaOtpChallenge(); - const { - screen: { texts, data }, - transaction, - } = mfaOtpChallenge; - - // Initialize form values from untrustedData - useEffect(() => { - // Use untrustedData to prepopulate form fields if available - const savedFormData = mfaOtpChallenge.untrustedData.submittedFormData; - if (savedFormData?.rememberDevice !== undefined) { - setRememberDevice(savedFormData.rememberDevice); - } - }, []); - - const handleSubmit = async (e: React.FormEvent) => { - e.preventDefault(); - setError(''); - - try { - await mfaOtpChallenge.continue({ - code, - rememberDevice, - }); - } catch (err) { - setError('Failed to verify code. Please try again.'); - console.error(err); - } - }; - - const handleTryAnotherMethod = async () => { - try { - await mfaOtpChallenge.tryAnotherMethod(); - } catch (err) { - setError('Failed to try another method. Please try again.'); - console.error(err); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - {texts?.title ?? 'Verify Your Identity'} - </h2> - <p className="mt-2 text-center text-sm text-gray-600"> - {texts?.description ?? - 'Check your preferred one-time password application for a code.'} - </p> - </div> - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label - htmlFor="code" - className="block text-sm font-medium text-gray-700" - > - {texts?.codePlaceholder ?? 'Enter your one-time code'} - </label> - <div className="mt-1"> - <input - id="code" - name="code" - type="text" - placeholder={ - texts?.codePlaceholder ?? 'Enter your one-time code' - } - required - value={code} - onChange={(e) => setCode(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - - {transaction?.errors?.length && ( - <div className="text-red-600 text-sm mt-2"> - {transaction.errors.map((err, index) => ( - <p key={index}>{err.message}</p> - ))} - </div> - )} - - {data?.showRememberDevice && ( - <div className="flex items-center"> - <input - id="rememberDevice" - name="rememberDevice" - type="checkbox" - className="h-4 w-4 text-blue-600 focus:ring-blue-500 border-gray-300 rounded" - checked={rememberDevice} - onChange={(e) => setRememberDevice(e.target.checked)} - /> - <label - htmlFor="rememberDevice" - className="ml-2 block text-sm text-gray-900" - > - {texts?.rememberMeText ?? 'Remember this browser for 30 days'} - </label> - </div> - )} - - {error && <div className="text-red-600 text-sm">{error}</div>} - - <div> - <button - type="submit" - className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Verify Code - </button> - </div> - </form> - - <div className="mt-6"> - <div className="flex justify-between"> - <button - onClick={handleTryAnotherMethod} - className="text-sm text-blue-600 hover:text-blue-500" - > - {texts?.pickAuthenticatorText ?? 'Try Another Method'} - </button> - </div> - </div> - </div> - </div> - </div> - ); -}; - -export default MfaOtpChallengeScreen; -``` - -```typescript Continue with Code lines -import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge'; - -const mfaOtpChallenge = new MfaOtpChallenge(); - -mfaOtpChallenge.continue({ - code: '123456', - rememberDevice: true, -}); -``` - -```typescript Try Another Method lines -import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge'; - -const mfaOtpChallenge = new MfaOtpChallenge(); - -mfaOtpChallenge.tryAnotherMethod(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span>UntrustedDataOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Continues with the OTP challenge using the provided code - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows the user to try another MFA method - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-otp-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentCode.mdx deleted file mode 100644 index 60bd0b609..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentCode.mdx +++ /dev/null @@ -1,194 +0,0 @@ ---- -title: "MfaOtpEnrollmentCode" -description: "Class implementing the mfa-otp-enrollment-code screen functionality. This screen is displayed when the user needs to enter the OTP code received during MFA enrollment." ---- - -<RequestExample> - -```typescript continue lines -import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; - -const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); -mfaOtpEnrollmentCode.continue({ - code:"123546" -}); -``` - -```typescript tryAnotherMethod lines -import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; - -const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); -mfaOtpEnrollmentCode.tryAnotherMethod(); -``` - -```tsx React Component Example with TailwindCSS lines -import React, { useState } from 'react'; -import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; - -const MfaOtpEnrollmentCodeScreen: React.FC = () => { - const [code, setCode] = useState(''); - - const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); - const { screen, transaction } = mfaOtpEnrollmentCode; - - const handleSubmit = async (e: React.FormEvent) => { - e.preventDefault(); - await mfaOtpEnrollmentCode.continue({ - code, - }); - }; - - const handleTryAnotherMethod = async () => { - await mfaOtpEnrollmentCode.tryAnotherMethod(); - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - { screen?.texts?.title ?? 'Secure Your Account' } - </h2> - <p className="mt-2 text-center text-sm text-gray-600"> - { screen?.texts?.description ?? 'Manually enter the following code into your preferred authenticator app and then enter the provided one-time code below.' } - </p> - <p className="mt-2 text-center text-sm text-gray-600"> - Code: {screen.data?.text_code} - </p> - </div> - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label htmlFor="code" className="block text-sm font-medium text-gray-700"> - {screen?.texts?.placeholder ?? 'Enter your one-time code'} - </label> - <div className="mt-1"> - <input - id="code" - name="code" - type="text" - placeholder={screen?.texts?.placeholder ?? 'Enter your one-time code'} - required - value={code} - onChange={(e) => setCode(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - - {transaction?.errors?.length && ( - <div className="mt-2 mb-4"> - {transaction?.errors.map((err, index) => ( - <p key={index} className="text-red-500"> - {err.message} - </p> - ))} - </div> - )} - - <div> - <button - type="submit" - className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Verify Code - </button> - </div> - </form> - - <div className="mt-6"> - <div className="flex justify-center"> - <button - onClick={handleTryAnotherMethod} - className="text-sm text-blue-600 hover:text-blue-500" - > - {screen?.texts?.tryAnotherMethod ?? 'Try another method'} - </button> - </div> - </div> - </div> - </div> - </div> - ); -}; - -export default MfaOtpEnrollmentCodeScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - Screen identifier for validation and telemetry -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - The screen properties for the mfa-otp-enrollment-code screen. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Continues the MFA OTP enrollment process by submitting the OTP code. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows the user to try another MFA method. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-otp-enrollment-code/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentQr.mdx deleted file mode 100644 index f3ed29dd4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentQr.mdx +++ /dev/null @@ -1,211 +0,0 @@ ---- -title: "MfaOtpEnrollmentQr" -description: "Class implementing the mfa-otp-enrollment-qr screen functionality" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState } from 'react'; -import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; - -const MfaOtpEnrollmentQrScreen: React.FC = () => { - const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); - const { screen, transaction } = mfaOtpEnrollmentQr; - const { qr_code } = screen.data || {}; - - const [otpCode, setOtpCode] = useState(''); - - const handleToggleView = async () => { - try { - await mfaOtpEnrollmentQr.toggleView(); - } catch (error) { - console.error('Failed to toggle view:', error); - } - }; - - const handleTryAnotherMethod = async () => { - try { - await mfaOtpEnrollmentQr.tryAnotherMethod(); - } catch (error) { - console.error('Failed to pick authenticator:', error); - } - }; - - const handleContinue = async () => { - await mfaOtpEnrollmentQr.continue({ code: otpCode }); - }; - - return ( - <div className="flex flex-col items-center min-h-screen bg-gray-100"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4"> - <h2 className="text-2xl font-bold">{screen.texts?.title ?? 'Secure Your Account'}</h2> - <p className="mb-4">{screen.texts?.description ?? 'Scan the QR Code below using your preferred authenticator app and then enter the provided one-time code below.'}</p> - - {qr_code ? ( - <div className=""> - <img src={qr_code} alt="QR Code" className="mx-auto" /> - </div> - ) : ( - <p>Loading QR Code...</p> - )} - - <button - className="mx-auto block text-blue-600 hover:text-blue-800 underline focus:outline-none" - type="button" - onClick={handleToggleView} - > - {screen.texts?.codeEnrollmentText ?? 'Trouble Scanning?'} - </button> - - <div className="flex justify-center flex-col items-center mt-3"> - <input - id="code" - placeholder="Enter OTP code" - type="text" - required - value={otpCode} - onChange={(e) => setOtpCode(e.target.value)} - className="w-64 px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - <button - className="w-64 mx-auto block bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline mt-2" - type="button" - onClick={handleContinue} - > - { screen.texts?.buttonText ?? 'Continue' } - </button> - - {transaction?.errors?.length && ( - <div className="mt-2 mb-4"> - {transaction?.errors.map((err, index) => ( - <p key={index} className="text-red-500"> - {err.message} - </p> - ))} - </div> - )} - </div> - - <hr className="my-4" /> - - <div className="flex justify-center items-end"> - - - <button - className="mx-auto block bg-gray-500 hover:bg-gray-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline mt-2" - type="button" - onClick={handleTryAnotherMethod} - > - { screen.texts?.tryAnotherMethodText ?? 'Try Another Method' } - </button> - </div> - - </div> - </div> - ); -}; - -export default MfaOtpEnrollmentQrScreen; -``` - -```typescript Toggle View lines -import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; - -const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); - -mfaOtpEnrollmentQr.toggleView(); -``` - -```typescript Try Another Method lines -import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; - -const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); - -mfaOtpEnrollmentQr.tryAnotherMethod(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - Screen identifier for validation and telemetry -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="toggleView" type={<span>Promise<void></span>}> - Navigates to the authenticator selection screen. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>}> - Continues with the default action. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Navigates to the authenticator selection screen. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-otp-enrollment-qr/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneChallenge.mdx deleted file mode 100644 index 24d335a17..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneChallenge.mdx +++ /dev/null @@ -1,302 +0,0 @@ ---- -title: "MfaPhoneChallenge" -description: "" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState } from 'react'; -import MfaPhoneChallenge, { type ContinueOptions } from '@auth0/auth0-acul-js/mfa-phone-challenge'; - -const MfaPhoneChallengeScreen: React.FC = () => { - // Instantiate the SDK class for the MFA Phone Challenge screen - const mfaPhoneChallenge = new MfaPhoneChallenge(); - const { screen, transaction } = mfaPhoneChallenge; - - // State to handle potential errors during submission - const [error, setError] = useState<string | null>(null); - // State to manage loading state during submission - const [isLoading, setIsLoading] = useState<boolean>(false); - - /** - * Handles the submission when the user selects SMS or Voice Call. - * @param {'sms' | 'voice'} type - The selected delivery method. - */ - const handleContinue = async (type: ContinueOptions['type']) => { - setIsLoading(true); - setError(null); - try { - await mfaPhoneChallenge.continue({ type }); - // On success, the page will typically redirect automatically. - // No need to set loading to false here. - } catch (err: any) { - setError(err.message || 'An unexpected error occurred. Please try again.'); - setIsLoading(false); - } - }; - - /** - * Handles the submission when the user wants to try a different MFA method. - */ - const handleTryAnotherMethod = async () => { - setIsLoading(true); - setError(null); - try { - await mfaPhoneChallenge.tryAnotherMethod(); - // On success, the page will typically redirect automatically. - } catch (err: any) { - setError(err.message || 'Failed to switch methods. Please try again.'); - setIsLoading(false); - } - }; - - // Extract texts for UI elements, providing default fallbacks - const texts = screen?.texts ?? {}; - const title = texts.title ?? 'Verify Your Identity'; - const description = texts.description ?? `How would you like to get the verification code sent to ${screen.data?.phoneNumber ?? 'your phone'}?`; - const smsButtonText = texts.smsButtonText ?? 'Send code via SMS'; - const voiceButtonText = texts.voiceButtonText ?? 'Send code via Voice Call'; - const tryAnotherMethodText = texts.pickAuthenticatorText ?? 'Try Another Method'; - - return ( - <div className="flex flex-col items-center justify-center min-h-screen bg-gray-100 p-4"> - <div className="w-full max-w-md bg-white rounded-lg shadow-md p-8"> - <h1 className="text-2xl font-semibold text-center text-gray-800 mb-4"> - {title} - </h1> - <p className="text-center text-gray-600 mb-6"> - {description} - </p> - - {/* Display errors from the transaction object (e.g., invalid state) */} - {transaction.errors && transaction.errors.length > 0 && ( - <div className="bg-red-100 border border-red-400 text-red-700 px-4 py-3 rounded relative mb-4" role="alert"> - {transaction.errors.map((err, index) => ( - <p key={`tx-error-${index}`}>{err.message}</p> - ))} - </div> - )} - - {/* Display errors caught during form submission */} - {error && ( - <div className="bg-red-100 border border-red-400 text-red-700 px-4 py-3 rounded relative mb-4" role="alert"> - <p>{error}</p> - </div> - )} - - <div className="space-y-4"> - {/* SMS Button */} - <button - onClick={() => handleContinue('sms')} - disabled={isLoading} - className="w-full px-4 py-2 text-white bg-blue-600 rounded-md hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-blue-500 focus:ring-opacity-50 disabled:opacity-50 disabled:cursor-not-allowed transition duration-150 ease-in-out" - > - {isLoading ? 'Sending...' : smsButtonText} - </button> - - {/* Voice Call Button */} - <button - onClick={() => handleContinue('voice')} - disabled={isLoading} - className="w-full px-4 py-2 text-white bg-green-600 rounded-md hover:bg-green-700 focus:outline-none focus:ring-2 focus:ring-green-500 focus:ring-opacity-50 disabled:opacity-50 disabled:cursor-not-allowed transition duration-150 ease-in-out" - > - {isLoading ? 'Calling...' : voiceButtonText} - </button> - </div> - - {/* Separator */} - <div className="my-6 border-t border-gray-300"></div> - - {/* Try Another Method Button */} - <button - onClick={handleTryAnotherMethod} - disabled={isLoading} - className="w-full px-4 py-2 text-gray-700 bg-gray-200 rounded-md hover:bg-gray-300 focus:outline-none focus:ring-2 focus:ring-gray-400 focus:ring-opacity-50 disabled:opacity-50 disabled:cursor-not-allowed transition duration-150 ease-in-out" - > - {isLoading ? 'Switching...' : tryAnotherMethodText} - </button> - - {/* Note: The 'pickPhone' action is less common for this specific screen */} - {/* but could be added similarly if needed: */} - <button - onClick={async () => { - setIsLoading(true); - setError(null); - try { - await mfaPhoneChallenge.pickPhone(); - } catch (err: any) { - setError(err.message || 'Failed to switch phones.'); - setIsLoading(false); - } - }} - disabled={isLoading} - className="mt-4 w-full text-sm text-blue-600 hover:underline focus:outline-none" - > - Use a different phone number - </button> - </div> - </div> - ); -}; - -export default MfaPhoneChallengeScreen; -``` - -```typescript Initialize the SDK Class lines -import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; - -const mfaPhoneChallenge = new MfaPhoneChallenge(); - -// You can access screen data like the phone number -const phoneNumber = mfaPhoneChallenge.screen.data?.phoneNumber; -console.log('Phone number for challenge:', phoneNumber); - -// Access transaction details like errors -const errors = mfaPhoneChallenge.transaction.errors; -if (errors) { - console.error('Transaction errors:', errors); -} -``` - -```typescript Send Code via SMS lines -import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; - -const mfaPhoneChallenge = new MfaPhoneChallenge(); - -try { - await mfaPhoneChallenge.continue({ type: 'sms' }); - // If successful, the user will be redirected to the code entry screen. -} catch (error) { - console.error('Failed to request SMS code:', error); - // Handle the error, e.g., display a message to the user. -} -``` - -```typescript Send Code via Voice Call lines -import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; - -const mfaPhoneChallenge = new MfaPhoneChallenge(); - -try { - await mfaPhoneChallenge.continue({ type: 'voice' }); - // If successful, the user will be redirected to the code entry screen. -} catch (error) { - console.error('Failed to request voice call:', error); - // Handle the error. -} -``` - -```typescript Try Another MFA Method lines -import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; - -const mfaPhoneChallenge = new MfaPhoneChallenge(); - -try { - await mfaPhoneChallenge.tryAnotherMethod(); - // If successful, the user will be redirected to the authenticator selection screen. -} catch (error) { - console.error('Failed to switch MFA method:', error); - // Handle the error. -} -``` - -```typescript Pick a Different Phone (Less Common) lines -import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; - -const mfaPhoneChallenge = new MfaPhoneChallenge(); - -try { - await mfaPhoneChallenge.pickPhone(); - // If successful, the user will be redirected to a phone selection screen. -} catch (error) { - console.error('Failed to initiate picking a different phone:', error); - // Handle the error. -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - The unique identifier for this screen. -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - Holds the specific screen data for the MFA Phone Challenge. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Submits the user's choice of receiving the MFA code via SMS or voice call. It uses the phone number provided in the screen context. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="pickPhone" type={<span>Promise<void></span>}> - Initiates the process for the user to select a different phone number (if applicable). This typically triggers a navigation to a phone selection screen. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickPhoneOptions">PickPhoneOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows the user to choose a different MFA method (e.g., OTP, Recovery Code). This typically triggers navigation to the authenticator selection screen. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickAuthenticatorOptions">PickAuthenticatorOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-phone-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneEnrollment.mdx deleted file mode 100644 index 8ad8cdc37..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneEnrollment.mdx +++ /dev/null @@ -1,233 +0,0 @@ ---- -title: "MfaPhoneEnrollment" -description: "Class implementing the mfa-phone-enrollment screen functionality. This screen allows users to enroll using a phone number for MFA." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState } from 'react'; -import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; - -const MfaPhoneEnrollmentScreen: React.FC = () => { - const [phone, setPhone] = useState(''); - const [type, setType] = useState<'sms' | 'voice'>('sms'); - const mfaPhoneEnrollment = new MfaPhoneEnrollment(); - const { screen, transaction: { errors } } = mfaPhoneEnrollment; - const texts = screen.texts ?? {}; - - const handlePickCountryCode = async () => { - await mfaPhoneEnrollment.pickCountryCode(); - }; - - const handleContinueEnrollment = async () => { - await mfaPhoneEnrollment.continueEnrollment({ phone, type }); - }; - - const handleTryAnotherMethod = async () => { - await mfaPhoneEnrollment.tryAnotherMethod(); - }; - - return ( - <div className="flex flex-col items-center min-h-screen bg-gray-100 p-4"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 w-full max-w-md"> - <h2 className="text-2xl font-bold mb-4 text-center"> - {texts.title ?? 'Secure Your Account'} - </h2> - <p className="text-sm text-gray-600 mb-6 text-center"> - {texts.description ?? 'Enter your country code and phone number to which we can send a 6-digit code:'} - </p> - - <button - className="w-full mb-4 bg-green-500 hover:bg-green-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline" - type="button" - onClick={handlePickCountryCode} - > - {texts.pickCountryCodeButtonText ?? 'Pick Country Code'} - </button> - - <div className="mb-4"> - <label className="block text-gray-700 text-sm font-bold mb-2" htmlFor="phone"> - {texts.placeholder ?? 'Enter your phone number'} - </label> - <input - className="shadow appearance-none border rounded w-full py-2 px-3 text-gray-700 leading-tight focus:outline-none focus:shadow-outline" - id="phone" - type="text" - placeholder={texts.placeholder ?? 'Enter your phone number'} - value={phone} - onChange={(e) => setPhone(e.target.value)} - /> - {errors?.length && ( - <div className="mt-2 space-y-1"> - {errors.map((error, idx) => ( - <p key={idx} className="text-red-600 text-sm"> - {error.message} - </p> - ))} - </div> - )} - </div> - - <div className="mb-4"> - <label className="block text-gray-700 text-sm font-bold mb-2"> - {texts.chooseMessageTypeText ?? 'How do you want to receive the code?'} - </label> - <div className="flex gap-4"> - <label className="flex items-center gap-1"> - <input - type="radio" - value="sms" - checked={type === 'sms'} - onChange={() => setType('sms')} - /> - {texts.smsButtonText ?? 'Text message'} - </label> - <label className="flex items-center gap-1"> - <input - type="radio" - value="voice" - checked={type === 'voice'} - onChange={() => setType('voice')} - /> - {texts.voiceButtonText ?? 'Voice call'} - </label> - </div> - </div> - - <button - className="w-full bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline mb-4" - type="button" - onClick={handleContinueEnrollment} - > - {texts.continueButtonText ?? 'Continue'} - </button> - - <button - className="text-sm text-blue-500 hover:underline focus:outline-none" - type="button" - onClick={handleTryAnotherMethod} - > - {texts.pickAuthenticatorText ?? 'Try another method'} - </button> - </div> - </div> - ); -}; - -export default MfaPhoneEnrollmentScreen; -``` - -```typescript Pick Country Code lines -import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; - -const mfaPhoneEnrollment = new MfaPhoneEnrollment(); - -// Call the pickCountryCode method -mfaPhoneEnrollment.pickCountryCode(); -``` - -```typescript Continue Enrollment lines -import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; - -const mfaPhoneEnrollment = new MfaPhoneEnrollment(); - -// Call the continueEnrollment method with a phone number and type -mfaPhoneEnrollment.continueEnrollment({ - phone: "1234567890", - type: "sms" // or "voice" -}); -``` - -```typescript Try Another Method lines -import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; - -const mfaPhoneEnrollment = new MfaPhoneEnrollment(); - -// Call the tryAnotherMethod -mfaPhoneEnrollment.tryAnotherMethod(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="pickCountryCode" type={<span>Promise<void></span>}> - Navigates to the country code selection screen. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="continueEnrollment" type={<span>Promise<void></span>}> - Continues the enrollment process with the provided phone number and type (SMS or voice). - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows the user to try another MFA method. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-phone-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushChallengePush.mdx deleted file mode 100644 index 99665c5c7..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushChallengePush.mdx +++ /dev/null @@ -1,424 +0,0 @@ ---- -title: "MfaPushChallengePush" -description: "Class implementing the mfa-push-challenge-push screen functionality This screen is shown when a user needs to confirm a push notification during MFA" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { - useState, - useEffect, - useRef, - useMemo, -} from 'react'; -import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; - -const MfaPushChallengePushScreen: React.FC = () => { - const [isLoading, setIsLoading] = useState(false); - const [rememberDevice, setRememberDevice] = useState(false); - const [isPolling, setIsPolling] = useState(false); - const mfaPushChallengePush = useMemo(() => new MfaPushChallengePush(), []); - const { screen, transaction } = mfaPushChallengePush; - const { deviceName, showRememberDevice } = - mfaPushChallengePush.screen.data || {}; - const pollingControl = useRef<ReturnType<typeof mfaPushChallengePush.pollingManager> | null>(null); - - useEffect(() => { - const savedFormData = mfaPushChallengePush.untrustedData.submittedFormData; - if (savedFormData?.rememberDevice !== undefined) { - setRememberDevice(savedFormData.rememberDevice); - } - }, [mfaPushChallengePush.untrustedData.submittedFormData]); - - const screenText = { - title: screen.texts?.title ?? 'Push Notification Sent', - description: - screen.texts?.description ?? - "We've sent a push notification to your device", - rememberMe: - screen.texts?.rememberMeText ?? 'Remember this device for 30 days', - resend: screen.texts?.resendActionText ?? 'Resend Push Notification', - enterCode: screen.texts?.enterOtpCode ?? 'Enter Code Manually', - tryAnother: screen.texts?.pickAuthenticatorText ?? 'Try Another Method', - waiting: - screen.texts?.spinner_push_notification_label ?? - 'Waiting for you to accept the push notification...', - errorResend: 'Failed to resend push notification. Please try again.', - errorManualCode: 'Failed to switch to manual code entry. Please try again.', - errorAnotherMethod: - 'Failed to switch authentication method. Please try again.', - }; - - useEffect(() => { - return () => { - if (pollingControl.current) { - pollingControl.current?.stopPolling(); - } - setIsPolling(false); - }; - }, []); - - const handleResend = async () => { - setIsLoading(true); - try { - await mfaPushChallengePush.resendPushNotification({ rememberDevice }); - } catch (err) { - console.log(err); - } finally { - setIsLoading(false); - } - }; - - const handleEnterCodeManually = async () => { - setIsLoading(true); - try { - await mfaPushChallengePush.enterCodeManually({ rememberDevice }); - } catch (err) { - console.log(err); - } finally { - setIsLoading(false); - } - }; - - const handleTryAnotherMethod = async () => { - setIsLoading(true); - try { - await mfaPushChallengePush.tryAnotherMethod({ rememberDevice }); - } catch (err) { - console.log(err); - } finally { - setIsLoading(false); - } - }; - - const handleStartPolling = () => { - if (!isPolling) { - pollingControl.current = mfaPushChallengePush.pollingManager( - 5000, - () => { - mfaPushChallengePush.continue({ rememberDevice }); - setIsPolling(false); - } - ); - pollingControl.current?.startPolling(); - setIsPolling(true); - } - }; - - const handleStopPolling = () => { - if (pollingControl.current) { - pollingControl.current?.stopPolling(); - setIsPolling(false); - } -}; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col items-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - {screenText.title} - </h2> - <p className="mt-2 text-left text-sm text-gray-600"> - {screenText.description} - {deviceName && <span className="font-medium"> ({deviceName})</span>} - </p> - </div> - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <div className="space-y-4"> - <div className="flex items-center justify-center"> - <div className="animate-spin rounded-full h-12 w-12 border-b-2 border-blue-500" /> - </div> - - <p className="text-center text-sm text-gray-500"> - {isPolling ? screenText.waiting : 'Polling stopped.'} - </p> - - {showRememberDevice && ( - <div className="flex items-center flex-start"> - <input - id="rememberDevice" - type="checkbox" - checked={rememberDevice} - onChange={(e) => setRememberDevice(e.target.checked)} - className="h-4 w-4 text-blue-600 border-gray-300 rounded focus:ring-blue-500" - /> - <label - htmlFor="rememberDevice" - className="ml-2 block text-sm text-left text-gray-700" - > - {screenText.rememberMe} - </label> - </div> - )} - - {transaction?.errors?.length && ( - <div className="mb-4 space-y-1"> - {transaction.errors.map((err, index) => ( - <p key={index} className="text-red-600 text-sm text-center"> - {err.message} - </p> - ))} - </div> - )} - - <button - onClick={handleResend} - disabled={isLoading} - className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 disabled:opacity-50" - > - {screenText.resend} - </button> - - <button - onClick={handleStopPolling} - disabled={!isPolling} - className="w-full flex justify-center py-2 px-4 border border-red-500 rounded-md shadow-sm text-sm font-medium text-white bg-red-600 hover:bg-red-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-red-500 disabled:opacity-50" - > - Stop Polling - </button> - - <button - onClick={handleStartPolling} - className="w-full flex justify-center py-2 px-4 border border-green-500 rounded-md shadow-sm text-sm font-medium text-white bg-green-600 hover:bg-green-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-green-500 disabled:opacity-50" - > - Start Polling - </button> - - <button - onClick={handleEnterCodeManually} - disabled={isLoading} - className="w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 disabled:opacity-50" - > - {screenText.enterCode} - </button> - - <button - onClick={handleTryAnotherMethod} - disabled={isLoading} - className="w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 disabled:opacity-50" - > - {screenText.tryAnother} - </button> - </div> - </div> - </div> - </div> - ); -}; - -export default MfaPushChallengePushScreen; -``` - -```tsx Polling Usage Example (with stop/start) lines -import React, { useEffect, useRef } from 'react'; -import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; - -const mfaPushChallengePush = new MfaPushChallengePush(); -const pollerRef = useRef(null); - -useEffect(() => { - // Start polling for push notification acceptance - pollerRef.current = mfaPushChallengePush.pollingManager(5000, () => { - mfaPushChallengePush.continue(); - }); - - // To stop polling when component unmounts - return () => { - if (pollerRef.current) pollerRef.current.stopPolling(); - }; -}, []); - -// To manually stop polling -// pollerRef.current.stopPolling(); - -// To restart polling: -// pollerRef.current.startPolling(); - -// To check if polling is running: -// const isPolling = pollerRef.current.isRunning(); -``` - -```javascript Plain JavaScript Usage lines -import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; - -const mfaPushChallengePush = new MfaPushChallengePush(); - -// Get polling object -const polling = mfaPushChallengePush.pollingManager(5000, async () => { - await mfaPushChallengePush.continue(); -}); - -// Start polling -polling.startPolling(); - -polling.stopPolling(); - -console.log(polling.isRunning()); // true or false -``` - -```tsx React Usage Example lines -import React, { useEffect, useRef } from 'react'; -import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; - -const MfaPushChallengePushScreen: React.FC = () => { - const mfaPushChallengePush = React.useMemo(() => new MfaPushChallengePush(), []); - const pollingRef = useRef<any>(null); - - useEffect(() => { - // Get polling object - pollingRef.current = mfaPushChallengePush.pollingManager(5000, async () => { - await mfaPushChallengePush.continue(); - }); - // Start polling - pollingRef.current.startPolling(); - return () => { - pollingRef.current?.stopPolling(); - }; - }, [mfaPushChallengePush]); - - - return <div>...</div>; -}; -``` - -```typescript Continue (Poll for Push Notification Acceptance) lines -import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; - -const mfaPushChallengePush = new MfaPushChallengePush(); - -// Poll for push notification acceptance -const pollInterval = setInterval(async () => { - try { - await mfaPushChallengePush.continue(); - clearInterval(pollInterval); - } catch (error) { - - } -}, 5000); -``` - -```typescript Resend Push Notification lines -import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; - -const mfaPushChallengePush = new MfaPushChallengePush(); -mfaPushChallengePush.resendPushNotification(); -``` - -```typescript Enter Code Manually lines -import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; - -const mfaPushChallengePush = new MfaPushChallengePush(); -mfaPushChallengePush.enterCodeManually(); -``` - -```typescript Try Another Method lines -import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; - -const mfaPushChallengePush = new MfaPushChallengePush(); -mfaPushChallengePush.tryAnotherMethod(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span>UntrustedDataOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Continues with the push notification challenge - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WithRememberOptions">WithRememberOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendPushNotification" type={<span>Promise<void></span>}> - Resends the push notification - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WithRememberOptions">WithRememberOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="enterCodeManually" type={<span>Promise<void></span>}> - Switches to entering the verification code manually - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows trying another authentication method - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="pollingManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> - Starts and manages polling for an MFA push challenge. Creates a polling session that repeatedly checks the MFA push challenge endpoint at the specified interval until the challenge is approved or an error occurs. When the approval condition is met, the provided callback is invoked and polling stops automatically. Use the returned to start, stop, or check the status of the polling process at any time. - - <Expandable title="parameters"> - <ParamField path="options" type={<span>MfaPollingOptions</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-push-challenge-push/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushEnrollmentQr.mdx deleted file mode 100644 index fe76de66c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushEnrollmentQr.mdx +++ /dev/null @@ -1,165 +0,0 @@ ---- -title: "MfaPushEnrollmentQr" -description: "Class implementing the mfa-push-enrollment-qr screen functionality" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React from 'react'; -import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr'; - -const MfaPushEnrollmentQrScreen: React.FC = () => { - const mfaPushEnrollmentQr = new MfaPushEnrollmentQr(); - const { screen } = mfaPushEnrollmentQr; - const { qrCode, qrUri, showCodeCopy } = screen.data || {}; - - const handlePickAuthenticator = async () => { - try { - await mfaPushEnrollmentQr.pickAuthenticator(); - } catch (error) { - console.error('Failed to pick authenticator:', error); - } - }; - - const handleCopyCode = () => { - if (qrUri) { - navigator.clipboard.writeText(qrUri) - .then(() => { - alert('Code copied to clipboard'); - }) - .catch((error) => { - console.error('Failed to copy code:', error); - }); - } - }; - - return ( - <div className="flex flex-col items-center flex-start min-h-screen bg-gray-100"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4"> - <h2 className="text-2xl font-bold">{ screen.texts?.title ?? 'Enroll with Push Notification' }</h2> - <p className="mb-4">{ screen.texts?.description ?? '' }</p> - { - qrCode ? ( - <div className="mb-4"> - <img src={qrCode} alt="QR Code" className="mb-4 mx-auto" /> - - {showCodeCopy && qrUri && ( - <div className="text-center mb-4"> - <p className="text-sm text-gray-600 mb-2">Or copy this code to your authenticator app:</p> - <div className="flex items-center justify-center"> - <code className="bg-gray-100 p-2 rounded mr-2 text-xs overflow-hidden text-ellipsis max-w-xs"> - {qrUri} - </code> - <button - onClick={handleCopyCode} - className="bg-gray-200 hover:bg-gray-300 text-gray-800 text-sm py-1 px-2 rounded" - aria-label="Copy code" - > - Copy - </button> - </div> - </div> - )} - </div> - ) : ( - <p>Loading QR Code...</p> - ) - } - <button - className="mx-auto block bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline" - type="button" - onClick={handlePickAuthenticator} - > - Try Another Method - </button> - </div> - </div> - ); -}; - -export default MfaPushEnrollmentQrScreen; -``` - -```typescript Pick Authenticator lines -import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr'; - -const mfaPushEnrollmentQr = new MfaPushEnrollmentQr(); - -mfaPushEnrollmentQr.pickAuthenticator(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="pickAuthenticator" type={<span>Promise<void></span>}> - Navigates to the authenticator selection screen. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="pollingManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> - Starts and manages polling for an MFA push challenge. Creates a polling session that repeatedly checks the MFA push challenge endpoint at the specified interval until the challenge is approved or an error occurs. When the approval condition is met, the provided callback is invoked and polling stops automatically. Use the returned to start, stop, or check the status of the polling process at any time. - - <Expandable title="parameters"> - <ParamField path="options" type={<span>MfaPollingOptions</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-push-enrollment-qr/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushList.mdx deleted file mode 100644 index 1b0fec3cf..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushList.mdx +++ /dev/null @@ -1,167 +0,0 @@ ---- -title: "MfaPushList" -description: "Class implementing the mfa-push-list screen functionality" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React from 'react'; -import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; - -const MfaPushListScreen: React.FC = () => { - const mfaPushList = new MfaPushList(); - const { screen, user } = mfaPushList; - const { enrolledDevices } = user || {}; - - const handleSelectDevice = async (deviceIndex: number) => { - try { - await mfaPushList.selectMfaPushDevice({ deviceIndex }); - } catch (error) { - console.error('Failed to select device:', error); - } - }; - - const handleGoBack = async () => { - try { - await mfaPushList.goBack(); - } catch (error) { - console.error('Failed to go back:', error); - } - }; - - return ( - <div className="flex flex-col items-center justify-center min-h-screen bg-gray-100"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4"> - <h2 className="text-2xl font-bold mb-4">{ screen.texts?.title ?? 'Select a Device for MFA Push' } </h2> - <p className="mb-4"> { screen.texts?.description } </p> - { - enrolledDevices && enrolledDevices.length > 0 ? ( - <ul className="mb-4"> - {enrolledDevices.map((device, index) => ( - <li key={index} className="mb-2"> - <button - className="bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline" - type="button" - onClick={() => handleSelectDevice(index)} - > - {device} - </button> - </li> - ))} - </ul> - ) : ( - <p>No enrolled devices found.</p> - ) - } - <button - className="bg-gray-500 hover:bg-gray-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline" - type="button" - onClick={handleGoBack} - > - Go Back - </button> - </div> - </div> - ); -}; - -export default MfaPushListScreen; -``` - -```typescript Select MFA Push Device lines -import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; - -const mfaPushList = new MfaPushList(); - -const enrolledDevices = mfaSmsList.user.enrolledDevices; -// select any device from list, for demonstration we will pick up first device -const selectedEmail = enrolledDevices[0] - -// Select the first device (index 0) -await mfaPushList.selectMfaPushDevice({ deviceIndex: 0 }); -``` - -```typescript Go Back lines -import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; - -const mfaPushList = new MfaPushList(); - -// Navigate back to the previous screen -await mfaPushList.goBack(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="selectMfaPushDevice" type={<span>Promise<void></span>}> - Selects a registered device from the list to initiate MFA push. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaPushDeviceOptions">SelectMfaPushDeviceOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="goBack" type={<span>Promise<void></span>}> - Navigates back to the previous screen. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-push-list/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushWelcome.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushWelcome.mdx deleted file mode 100644 index f78562d0f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushWelcome.mdx +++ /dev/null @@ -1,160 +0,0 @@ ---- -title: "MfaPushWelcome" -description: "@extends Implements the mfa-push-welcome screen functionality." ---- - -<RequestExample> - -```typescript Enroll lines -import React, { useCallback } from 'react'; -import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome'; - -const MfaPushWelcomeScreen: React.FC = () => { - const mfaPushWelcome = new MfaPushWelcome(); - const { screen } = mfaPushWelcome; - - /** Button Styles */ - const buttonBase = - "py-2 px-4 font-bold rounded focus:outline-none focus:shadow-outline transition"; - const primaryButton = `${buttonBase} bg-blue-500 hover:bg-blue-700 text-white`; - const secondaryButton = `${buttonBase} bg-gray-500 hover:bg-gray-700 text-white`; - const linkStyle = "text-blue-600 hover:text-blue-800 hover:underline transition"; - - /** Handle Enroll */ - const handleEnroll = useCallback(async () => { - try { - await mfaPushWelcome.enroll(); - } catch (error) { - console.error('Failed to enroll:', error); - } - }, []); - - /** Handle Pick Authenticator */ - const handlePickAuthenticator = useCallback(async () => { - try { - await mfaPushWelcome.pickAuthenticator(); - } catch (error) { - console.error('Failed to pick authenticator:', error); - } - }, []); - - return ( - <div className="flex flex-col items-center flex-start min-h-screen bg-gray-100"> - <div className="bg-white shadow-md rounded-lg px-8 pt-6 pb-8 max-w-md w-full"> - <h2 className="text-2xl font-bold text-gray-900 mb-4"> - {screen.texts?.title ?? 'Secure Your Account'} - </h2> - <p className="text-gray-700 mb-4"> - {screen.texts?.description ?? - 'To continue, install the Auth0 Guardian app from your mobile device’s app store.'} - </p> - - {/* Buttons */} - <div className="flex space-x-4"> - <button type="button" className={primaryButton} onClick={handleEnroll}> - {screen.texts?.buttonText ?? 'Continue'} - </button> - <button type="button" className={secondaryButton} onClick={handlePickAuthenticator}> - {screen.texts?.pickAuthenticatorText ?? 'Try Another Method'} - </button> - </div> - - {/* App Download Links */} - <div className="mt-5 text-left"> - {screen.links?.ios && ( - <p> - <a href={screen.links.ios} className={linkStyle}> - Download iOS App - </a> - </p> - )} - {screen.links?.android && ( - <p> - <a href={screen.links.android} className={linkStyle}> - Download Android App - </a> - </p> - )} - </div> - </div> - </div> - ); -}; - -export default MfaPushWelcomeScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="enroll" type={<span>Promise<void></span>}> - Navigates to the enrollment screen. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="pickAuthenticator" type={<span>Promise<void></span>}> - Navigates to the authenticator selection screen. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-push-welcome/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallenge.mdx deleted file mode 100644 index fdc457eb8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallenge.mdx +++ /dev/null @@ -1,175 +0,0 @@ ---- -title: "MfaRecoveryCodeChallenge" -description: "Class implementing the MFA Recovery Code Challenge screen functionality." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState } from 'react'; -import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge'; - -const MfaRecoveryCodeChallengeScreen: React.FC = () => { - const [code, setCode] = useState(''); - const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge(); - const { screen, transaction: { errors } } = mfaRecoveryCodeChallenge; - const texts = screen.texts ?? {}; - - const handleSubmit = (e: React.FormEvent) => { - e.preventDefault(); - mfaRecoveryCodeChallenge.continue(code); - }; - - const handleTryAnotherMethod = () => { - mfaRecoveryCodeChallenge.tryAnotherMethod(); - }; - - return ( - <div className="flex flex-col items-center min-h-screen bg-gray-100 p-4"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 w-full max-w-md"> - <h2 className="text-2xl font-bold mb-4 text-center"> - {texts.title ?? 'Verify Your Identity'} - </h2> - <p className="text-sm text-gray-600 mb-6 text-center"> - {texts.description ?? 'Enter the recovery code you were provided during your initial enrollment.'} - </p> - - <form onSubmit={handleSubmit}> - <div className="mb-4"> - <label className="block text-gray-700 text-sm font-bold mb-2" htmlFor="code"> - {texts.placeholder ?? 'Enter your recovery code'} - </label> - <input - id="code" - name="code" - type="text" - placeholder={texts.placeholder ?? 'Enter your recovery code'} - value={code} - onChange={(e) => setCode(e.target.value)} - className="shadow appearance-none border rounded w-full py-2 px-3 text-gray-700 leading-tight focus:outline-none focus:shadow-outline" - required - /> - {errors && errors?.length && ( - <div className="mt-2 space-y-1"> - {errors.map((error, idx) => ( - <p key={idx} className="text-red-600 text-sm"> - {error.message} - </p> - ))} - </div> - )} - </div> - - <button - type="submit" - className="w-full bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline mb-4" - > - {texts.buttonText ?? 'Continue'} - </button> - </form> - - <button - type="button" - onClick={handleTryAnotherMethod} - className="text-sm text-blue-500 hover:underline focus:outline-none" - > - {texts.pickAuthenticatorText ?? 'Try another method'} - </button> - </div> - </div> - ); -}; - -export default MfaRecoveryCodeChallengeScreen; -``` - -```typescript Continue with Code lines -import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge'; - -const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge(); - -mfaRecoveryCodeChallenge.continue('PJVLZM6MS8DP6JYRT97XYZM2'); -``` - -```typescript Try Another Method lines -import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge'; - -const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge(); - -mfaRecoveryCodeChallenge.tryAnotherMethod(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Continues with the provided recovery code. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Navigates to the screen where the user can pick another MFA method. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-recovery-code-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallengeNewCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallengeNewCode.mdx deleted file mode 100644 index 8383cf4bc..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallengeNewCode.mdx +++ /dev/null @@ -1,213 +0,0 @@ ---- -title: "MfaRecoveryCodeChallengeNewCode" -description: "" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState, useCallback } from 'react'; -import MfaRecoveryCodeChallengeNewCode from '@auth0/auth0-acul-js/mfa-recovery-code-challenge-new-code'; - -const MfaRecoveryCodeChallengeNewCodeScreen: React.FC = () => { - // Instantiate the SDK class for the screen - const screenManager = new MfaRecoveryCodeChallengeNewCode(); - const { screen, transaction } = screenManager; - - // State to track if the user has confirmed saving the code - const [hasSavedCode, setHasSavedCode] = useState<boolean>(false); - // State for loading indicator during submission - const [isLoading, setIsLoading] = useState<boolean>(false); - // State for potential submission errors - const [error, setError] = useState<string | null>(null); - - // Get the recovery code from the screen data, provide fallback - const recoveryCode = screen?.data?.textCode ?? 'CODE-NOT-AVAILABLE'; - const texts = screen?.texts ?? {}; - - // Handler for the checkbox change - const handleCheckboxChange = (event: React.ChangeEvent<HTMLInputElement>): void => { - setHasSavedCode(event.target.checked); - setError(null); // Clear error when checkbox state changes - }; - - // Handler for the continue button click - const handleContinue = useCallback(async () => { - if (!hasSavedCode) { - setError('Please confirm you have saved the recovery code.'); - return; - } - setIsLoading(true); - setError(null); - try { - // Call the continue method - no payload needed unless passing custom options - await screenManager.continue(); - // On success, Auth0 handles the redirect automatically. - // No need to set isLoading to false here. - } catch (err: any) { - // Check for specific server-side errors if needed - const serverError = transaction.errors?.find(e => e.code === 'no-confirmation'); - if (serverError) { - setError(serverError.message); - } else { - setError(err.message || 'An unexpected error occurred. Please try again.'); - } - setIsLoading(false); // Stop loading only on error - } - }, [hasSavedCode, screenManager, transaction.errors]); - - return ( - <div className="flex flex-col items-center justify-center min-h-screen bg-gray-100 p-4"> - <div className="w-full max-w-md bg-white rounded-lg shadow-md p-8"> - <h1 className="text-2xl font-semibold text-center text-gray-800 mb-4"> - {texts.title ?? 'Save Your Recovery Code'} - </h1> - <p className="text-center text-gray-600 mb-6"> - {texts.description ?? 'Save this recovery code in a safe place. You will need it to log in if you lose access to your other multi-factor authentication methods.'} - </p> - - {/* Display the Recovery Code */} - <div className="bg-gray-100 border border-gray-300 rounded-md p-4 mb-6 text-center"> - <p className="text-lg font-mono font-semibold text-gray-800 tracking-wider break-all"> - {recoveryCode} - </p> - </div> - - {/* Confirmation Checkbox */} - <div className="flex items-center justify-center mb-6"> - <input - id="confirm-saved" - type="checkbox" - checked={hasSavedCode} - onChange={handleCheckboxChange} - className="h-4 w-4 text-blue-600 border-gray-300 rounded focus:ring-blue-500" - /> - <label htmlFor="confirm-saved" className="ml-2 block text-sm text-gray-700"> - {texts.confirmationText ?? 'I have saved this recovery code'} - </label> - </div> - - {/* Display errors (transaction errors or client-side errors) */} - {(transaction.errors?.length || error) && ( - <div className="bg-red-100 border border-red-400 text-red-700 px-4 py-3 rounded relative mb-4" role="alert"> - {error && <p>{error}</p>} - {transaction.errors?.map((err, index) => ( - <p key={`tx-err-${index}`}>{err.message}</p> - ))} - </div> - )} - - {/* Continue Button */} - <button - onClick={handleContinue} - disabled={!hasSavedCode || isLoading} - className={`w-full px-4 py-2 text-white rounded-md transition duration-150 ease-in-out ${ - !hasSavedCode || isLoading - ? 'bg-blue-300 cursor-not-allowed' - : 'bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-blue-500 focus:ring-opacity-50' - }`} - > - {isLoading ? 'Continuing...' : (texts.buttonText ?? 'Continue')} - </button> - </div> - </div> - ); -}; - -export default MfaRecoveryCodeChallengeNewCodeScreen; -``` - -```jsx Confirm Saving the Code and Continue lines -import MfaRecoveryCodeChallengeNewCode from '@auth0/auth0-acul-js/mfa-recovery-code-challenge-new-code'; - -const screenManager = new MfaRecoveryCodeChallengeNewCode(); - -// This should typically be called after the user confirms saving the code, -// e.g., by checking a box and clicking a button. -async function confirmAndContinue() { - try { - // The SDK handles sending the required 'saved=on' parameter internally. - await screenManager.continue(); - // If successful, the browser will redirect. - } catch (error) { - console.error("Failed to confirm saving the recovery code:", error); - // Handle potential errors, e.g., display error messages from screenManager.transaction.errors - if (screenManager.transaction.errors?.length) { - screenManager.transaction.errors.forEach(err => console.log(err.message)); - } - } -} - -// Example trigger (replace with actual UI interaction) -// if (userConfirmedSavingCode) { -// confirmAndContinue(); -// } -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - The unique identifier for this screen, used internally and for telemetry. -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode">ScreenMembersOnMfaRecoveryCodeChallengeNewCode</a></span>} required> - Holds the specific screen data and properties, processed by ScreenOverride. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Confirms that the user has saved the new recovery code and continues the authentication flow. This method sends a POST request to the `/u/mfa-recovery-code-challenge-new-code` endpoint with the required `state`, `action`, and `saved` parameters. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-recovery-code-challenge-new-code/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeEnrollment.mdx deleted file mode 100644 index 04f7098c8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeEnrollment.mdx +++ /dev/null @@ -1,138 +0,0 @@ ---- -title: "MfaRecoveryCodeEnrollment" -description: "Class implementing the Mfa Recovery Code Enrollment screen functionality. This screen is displayed when the user needs to enroll with a recovery code for MFA." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React from 'react'; -import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment'; - -const MfaRecoveryCodeEnrollmentScreen: React.FC = () => { - const mfaRecoveryCodeEnrollment = new MfaRecoveryCodeEnrollment(); - const { screen, transaction } = mfaRecoveryCodeEnrollment; - const texts = screen?.texts ?? {}; - - const handleContinue = async () => { - try { - await mfaRecoveryCodeEnrollment.continue(); - } catch (error) { - console.error('Failed to continue:', error); - } - }; - - return ( - <div className="flex flex-col items-center justify-center min-h-screen bg-gray-100 p-4"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 w-full max-w-md"> - <h2 className="text-2xl font-bold mb-4 text-center"> - {texts.title ?? 'MFA Recovery Code Enrollment'} - </h2> - - <p className="mb-4 text-sm text-gray-700 text-center"> - {texts.description ?? 'Please save this recovery code in a safe place:'} - </p> - - <p className="mb-6 text-center font-mono text-lg bg-gray-100 p-3 rounded"> - {screen?.data?.textCode ?? '******-******'} - </p> - - {transaction?.errors?.length && ( - <div className="mb-4 space-y-1"> - {transaction.errors.map((err, index) => ( - <p key={index} className="text-red-600 text-sm text-center"> - {err.message} - </p> - ))} - </div> - )} - - <button - className="w-full bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline" - type="button" - onClick={handleContinue} - > - {texts.buttonText ?? 'I have saved the code'} - </button> - </div> - </div> - ); -}; - -export default MfaRecoveryCodeEnrollmentScreen; -``` - -```typescript Continue lines -import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment'; - -const mfaRecoveryCodeEnrollment = new MfaRecoveryCodeEnrollment(); - -// Declare that the user saved the recovery code -await mfaRecoveryCodeEnrollment.continue(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment">ScreenMembersOnMfaRecoveryCodeEnrollment</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Declares that the user saved the recovery code. This action is triggered when the user declares that they have saved the recovery code. It redirects to the next screen in the authentication flow. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentContinueOptions">MfaRecoveryCodeEnrollmentContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-recovery-code-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsChallenge.mdx deleted file mode 100644 index a2a0df206..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsChallenge.mdx +++ /dev/null @@ -1,335 +0,0 @@ ---- -title: "MfaSmsChallenge" -description: "This class provides methods to handle the mfa-sms-challenge screen." ---- - -<RequestExample> - -```typescript resendManager lines -import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; - -const mfaSmsChallenge = new MfaSmsChallenge(); - -function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { - console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); -} - -function handleTimeout() { - console.log('Resend timeout completed'); -} - -const resendManager = mfaSmsChallenge.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleTimeout, -}); - -const { startResend } = resendManager; - -// Use startResend() to initiate the resend with cooldown -startResend(); -``` - -```jsx React Component Example with TailwindCSS lines -import { useState, useEffect, useMemo } from 'react'; -import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; - -const MfaSmsChallengeScreen = () => { - const mfaSmsChallenge = useMemo(() => new MfaSmsChallenge(), []); - const [code, setCode] = useState(''); - const [rememberDevice, setRememberDevice] = useState(false); - const [disabled, setDisabled] = useState(false); - const [remainingSeconds, setRemainingSeconds] = useState(0); - const { phoneNumber, showRememberDevice, showLinkVoice } = mfaSmsChallenge.screen.data || {}; - - function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { - setDisabled(isDisabled); - setRemainingSeconds(remainingSeconds); - } - - function handleTimeout() { - console.log('Resend timeout completed'); - } - - const resendManager = useMemo( - () => - mfaSmsChallenge.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleTimeout, - }), - [mfaSmsChallenge] - ); - - const { startResend } = resendManager; - - // Initialize form values from untrustedData - useEffect(() => { - // Use untrustedData to prepopulate form fields if available - const savedFormData = mfaSmsChallenge.untrustedData.submittedFormData; - if (savedFormData?.rememberDevice !== undefined) { - setRememberDevice(savedFormData.rememberDevice); - } - }, [mfaSmsChallenge]); - - const handleSubmit = async (e: { preventDefault: () => void; }) => { - e.preventDefault(); - try { - await mfaSmsChallenge.continueMfaSmsChallenge({ - code, - rememberDevice, - }); - } catch (error) { - console.error('MFA SMS Challenge failed:', error); - } - }; - - const handlePickSms = async () => { - try { - await mfaSmsChallenge.pickSms(); - } catch (error) { - console.error('Pick SMS failed:', error); - } - }; - - const handleResendCode = async () => { - try { - await startResend(); - } catch (error) { - console.error('Resend code failed:', error); - } - }; - - const handleTryAnotherMethod = async () => { - try { - await mfaSmsChallenge.tryAnotherMethod(); - } catch (error) { - console.error('Try another method failed:', error); - } - }; - - const handleGetACall = async () => { - try { - await mfaSmsChallenge.getACall(); - } catch (error) { - console.error('Get a call failed:', error); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - MFA SMS Challenge - </h2> - {phoneNumber && ( - <p className="mt-2 text-center text-sm text-gray-600"> - Enter the code sent to {phoneNumber} - </p> - )} - </div> - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label - htmlFor="code" - className="block text-sm font-medium text-gray-700" - > - Enter Code - </label> - <div className="mt-1"> - <input - id="code" - name="code" - type="text" - required - value={code} - onChange={(e) => setCode(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - - {showRememberDevice && ( - <div className="flex items-center"> - <input - id="rememberDevice" - name="rememberDevice" - type="checkbox" - className="h-4 w-4 text-blue-600 focus:ring-blue-500 border-gray-300 rounded" - checked={rememberDevice} - onChange={(e) => setRememberDevice(e.target.checked)} - /> - <label - htmlFor="rememberDevice" - className="ml-2 block text-sm text-gray-900" - > - Remember this device - </label> - </div> - )} - - <div> - <button - type="submit" - className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Continue - </button> - </div> - </form> - - <div className="mt-6"> - <button - onClick={handlePickSms} - className="w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50" - > - Pick SMS - </button> - <button - onClick={handleResendCode} - disabled={disabled} - className={`w-full flex justify-center py-2 px-4 border rounded-md shadow-sm text-sm font-medium mt-2 ${ - disabled - ? 'bg-gray-300 text-gray-500 cursor-not-allowed border-gray-300' - : 'border-gray-300 text-gray-700 bg-white hover:bg-gray-50' - }`} - > - {disabled ? `Resend code in ${remainingSeconds}s` : 'Resend Code'} - </button> - <button - onClick={handleTryAnotherMethod} - className="w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 mt-2" - > - Try Another Method - </button> - {showLinkVoice && ( - <button - onClick={handleGetACall} - className="w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 mt-2" - > - Get a Call - </button> - )} - </div> - </div> - </div> - </div> - ); -}; - -export default MfaSmsChallengeScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span>UntrustedDataOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continueMfaSmsChallenge" type={<span>Promise<void></span>}> - Submits the MFA SMS challenge with the provided code and rememberDevice option. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions">MfaSmsChallengeOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="pickSms" type={<span>Promise<void></span>}> - Submits the action to pick a different SMS configuration, if available. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>}> - Submits the action to resend the SMS code. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Submits the action to try another MFA method. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getACall" type={<span>Promise<void></span>}> - Submits the action to switch to voice call verification. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> - Gets resend functionality with timeout management for this screen - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-sms-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsEnrollment.mdx deleted file mode 100644 index bcbac8b53..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsEnrollment.mdx +++ /dev/null @@ -1,189 +0,0 @@ ---- -title: "MfaSmsEnrollment" -description: "Represents the MFA SMS Enrollment screen." ---- - -<RequestExample> - -```typescript Pick Country Code lines -import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; - -const mfaSmsEnrollment = new MfaSmsEnrollment(); - -// Call the pickCountryCode method -mfaSmsEnrollment.pickCountryCode(); -``` - -```typescript Continue Enrollment lines -import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; - -const mfaSmsEnrollment = new MfaSmsEnrollment(); - -// Call the continueEnrollment method with a phone number -mfaSmsEnrollment.continueEnrollment({ - phone: "1234567890" -}); -``` - -```typescript Try Another Method lines -import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; - -const mfaSmsEnrollment = new MfaSmsEnrollment(); - -// Call the tryAnotherMethod -mfaSmsEnrollment.tryAnotherMethod(); -``` - -```jsx React Component Example with TailwindCSS lines -import React, { useState } from 'react'; -import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; - -const MFASmsEnrollmentScreen = () => { - const [phone, setPhone] = useState(''); - const mfaSmsEnrollment = new MfaSmsEnrollment(); - - const handlePickCountryCode = async () => { - await mfaSmsEnrollment.pickCountryCode(); - }; - - const handleContinueEnrollment = async () => { - await mfaSmsEnrollment.continueEnrollment({ phone }); - }; - - const handleTryAnotherMethod = async () => { - await mfaSmsEnrollment.tryAnotherMethod(); - }; - - return ( - <div className="flex flex-col items-center justify-center min-h-screen bg-gray-100"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4"> - <h2 className="text-2xl font-bold mb-4">MFA SMS Enrollment</h2> - - <div className="mb-4"> - <label className="block text-gray-700 text-sm font-bold mb-2" htmlFor="phone"> - Phone Number: - </label> - <input - className="shadow appearance-none border rounded w-full py-2 px-3 text-gray-700 leading-tight focus:outline-none focus:shadow-outline" - id="phone" - type="text" - placeholder="Enter your phone number" - value={phone} - onChange={(e) => setPhone(e.target.value)} - /> - </div> - - <div className="flex items-center justify-between"> - <button - className="bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline" - type="button" - onClick={handleContinueEnrollment} - > - Continue Enrollment - </button> - <button - className="bg-green-500 hover:bg-green-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline" - type="button" - onClick={handlePickCountryCode} - > - Pick Country Code - </button> - <button - className="bg-red-500 hover:bg-red-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline" - type="button" - onClick={handleTryAnotherMethod} - > - Try Another Method - </button> - </div> - </div> - </div> - ); -}; - -export default MFASmsEnrollmentScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsEnrollment">ScreenMembersOnMfaSmsEnrollment</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="pickCountryCode" type={<span>Promise<void></span>}> - Handles the action to pick a country code for SMS enrollment. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="continueEnrollment" type={<span>Promise<void></span>}> - Continues the SMS enrollment process with the provided phone number. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentOptions">MfaSmsEnrollmentOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Handles the action to try another method for MFA. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-sms-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsList.mdx deleted file mode 100644 index d3e08659f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsList.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "MfaSmsList" -description: "Class for handling the mfa-sms-list screen." ---- - -<RequestExample> - -```typescript Select Phone Number lines -import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list'; - -const mfaSmsList = new MfaSmsList(); - -const getEnrolledPhoneNumbers = mfaSmsList.user.enrolledPhoneNumbers; -// select any phone number from list, for demonstration we will pick up first number -const selectedNumber = getEnrolledPhoneNumbers[0] - -// Select the first phone number in the list -mfaSmsList.selectPhoneNumber({index: selectedNumber}); -``` - -```typescript Back Action lines -import React from 'react'; -import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list'; - -const MFASmsListScreen: React.FC = () => { - const mfaSmsList = new MfaSmsList(); - const { user } = mfaSmsList; - - const handleSelectPhoneNumber = async (index: number) => { - try { - await mfaSmsList.selectPhoneNumber({index}); - } catch (error) { - console.error('Failed to select phone number:', error); - } - }; - - const handleBackAction = async () => { - try { - await mfaSmsList.backAction(); - } catch (error) { - console.error('Failed to go back:', error); - } - }; - - return ( - <div className="flex flex-col items-center justify-center min-h-screen bg-gray-100"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4"> - <h2 className="text-2xl font-bold mb-4">Select a Phone Number</h2> - { - user.enrolledPhoneNumbers ? ( - <ul className="mb-4"> - {user.enrolledPhoneNumbers?.map((phoneNumber, index) => ( - <li key={index} className="py-2"> - <button - onClick={() => handleSelectPhoneNumber(index)} - className="bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded" - > - {phoneNumber} - </button> - </li> - ))} - </ul> - ) : ( - <p>No phone numbers enrolled.</p> - ) - } - <button - onClick={handleBackAction} - className="bg-gray-500 hover:bg-gray-700 text-white font-bold py-2 px-4 rounded" - > - Back - </button> - </div> - </div> - ); -}; - -export default MFASmsListScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="selectPhoneNumber" type={<span>Promise<void></span>}> - Selects a phone number from the list of enrolled phone numbers. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListOptions">MfaSmsListOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="backAction" type={<span>Promise<void></span>}> - Navigates back to the previous screen. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-sms-list/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceChallenge.mdx deleted file mode 100644 index eb00e544a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceChallenge.mdx +++ /dev/null @@ -1,508 +0,0 @@ ---- -title: "MfaVoiceChallenge" -description: "MFA Voice Challenge screen implementation. This screen is displayed when a user needs to verify their identity using a voice call as part of a multi-factor authentication flow." ---- - -<RequestExample> - -```typescript Continue with Voice Code Verification lines -import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; - -const mfaVoiceChallenge = new MfaVoiceChallenge(); - -// Submit the verification code the user received via voice call -mfaVoiceChallenge.continue({ - code: '123456', - rememberDevice: true // Optional: to remember this device for 30 days -}); -``` - -```typescript Pick a Different Phone Number lines -import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; - -const mfaVoiceChallenge = new MfaVoiceChallenge(); - -// Navigate to the screen for selecting a different phone number -mfaVoiceChallenge.pickPhone(); -``` - -```typescript Switch to SMS Verification Instead lines -import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; - -const mfaVoiceChallenge = new MfaVoiceChallenge(); - -// Switch to SMS verification instead of voice call -mfaVoiceChallenge.switchToSms(); -``` - -```typescript Resend Voice Call with Verification Code lines -import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; - -const mfaVoiceChallenge = new MfaVoiceChallenge(); - -// Request a new voice call with verification code -mfaVoiceChallenge.resendCode(); -``` - -```typescript Try Another MFA Method lines -import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; - -const mfaVoiceChallenge = new MfaVoiceChallenge(); - -// Navigate to the screen for selecting an alternative MFA method -mfaVoiceChallenge.tryAnotherMethod(); -``` - -```typescript resendManager lines -import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; - -const mfaVoiceChallenge = new MfaVoiceChallenge(); - -function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { - console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); -} - -function handleTimeout() { - console.log('Resend timeout completed'); -} - -const resendManager = mfaVoiceChallenge.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleTimeout, -}); - -const { startResend } = resendManager; - -// Use startResend() to initiate the resend with cooldown -startResend(); -``` - -```typescript Below is a complete React component implementing the MFA Voice Challenge screen with TailwindCSS: lines -import React, { useState, useEffect, FormEvent, ChangeEvent, useMemo } from 'react'; -import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; - -/** - * MFA Voice Challenge Screen Component - * - * This component renders a form for users to submit their voice verification code - * received during multi-factor authentication. - */ -const MfaVoiceChallengeScreen: React.FC = () => { - // State for form inputs - const [code, setCode] = useState<string>(''); - const [rememberDevice, setRememberDevice] = useState<boolean>(false); - - // UI state - const [isLoading, setIsLoading] = useState<boolean>(false); - const [error, setError] = useState<string | null>(null); - const [phoneNumber, setPhoneNumber] = useState<string>(''); - const [showRememberDevice, setShowRememberDevice] = useState<boolean>(false); - const [showLinkSms, setShowLinkSms] = useState<boolean>(false); - const [disabled, setDisabled] = useState(false); - const [remainingSeconds, setRemainingSeconds] = useState(0); - - // Initialize MFA Voice Challenge SDK - const mfaVoiceChallenge = useMemo(() => new MfaVoiceChallenge(), []); - - function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { - setDisabled(isDisabled); - setRemainingSeconds(remainingSeconds); - } - - function handleTimeout() { - console.log('Resend timeout completed'); - } - - const resendManager = useMemo( - () => - mfaVoiceChallenge.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleTimeout, - }), - [mfaVoiceChallenge] - ); - - const { startResend } = resendManager; - - useEffect(() => { - // Get data from the screen when component mounts - if (mfaVoiceChallenge.screen.data) { - if (mfaVoiceChallenge.screen.data.phoneNumber) { - setPhoneNumber(mfaVoiceChallenge.screen.data.phoneNumber); - } - if (mfaVoiceChallenge.screen.data.showRememberDevice !== undefined) { - setShowRememberDevice(mfaVoiceChallenge.screen.data.showRememberDevice); - } - if (mfaVoiceChallenge.screen.data.showLinkSms !== undefined) { - setShowLinkSms(mfaVoiceChallenge.screen.data.showLinkSms); - } - } - - // Use untrustedData to prepopulate form fields if available - const savedFormData = mfaVoiceChallenge.untrustedData.submittedFormData; - if (savedFormData?.rememberDevice !== undefined) { - setRememberDevice(savedFormData.rememberDevice); - } - }, [mfaVoiceChallenge]); - - /** - * Handles the form submission to verify the voice code - */ - const handleSubmit = async (e: FormEvent<HTMLFormElement>): Promise<void> => { - e.preventDefault(); - setIsLoading(true); - setError(null); - - try { - await mfaVoiceChallenge.continue({ - code, - rememberDevice, - }); - } catch (err) { - setError(err instanceof Error ? err.message : 'Failed to verify code'); - } finally { - setIsLoading(false); - } - }; - - /** - * Handles the resend code action - */ - const handleResendCode = async (): Promise<void> => { - try { - await startResend(); - } catch (err) { - setError(err instanceof Error ? err.message : 'Failed to resend code'); - } - }; - - /** - * Handles the change event for the code input field - */ - const handleCodeChange = (e: ChangeEvent<HTMLInputElement>): void => { - setCode(e.target.value); - }; - - /** - * Handles the change event for the remember browser checkbox - */ - const handleRememberDeviceChange = ( - e: ChangeEvent<HTMLInputElement> - ): void => { - setRememberDevice(e.target.checked); - }; - - /** - * Handles switching to SMS verification - */ - const handleSwitchToSms = async (): Promise<void> => { - setIsLoading(true); - try { - await mfaVoiceChallenge.switchToSms(); - } catch (err) { - setError(err instanceof Error ? err.message : 'Failed to switch to SMS'); - setIsLoading(false); - } - }; - - /** - * Handles navigating to pick a different phone number - */ - const handlePickPhone = async (): Promise<void> => { - setIsLoading(true); - try { - await mfaVoiceChallenge.pickPhone(); - } catch (err) { - setError( - err instanceof Error - ? err.message - : 'Failed to navigate to phone selection' - ); - setIsLoading(false); - } - }; - - /** - * Handles navigating to try another MFA method - */ - const handleTryAnotherMethod = async (): Promise<void> => { - setIsLoading(true); - try { - await mfaVoiceChallenge.tryAnotherMethod(); - } catch (err) { - setError( - err instanceof Error - ? err.message - : 'Failed to navigate to method selection' - ); - setIsLoading(false); - } - }; - - return ( - <div className="min-h-screen bg-gray-50 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - Voice Verification - </h2> - <p className="mt-2 text-center text-sm text-gray-600"> - {phoneNumber ? ( - <> - We've called <span className="font-medium">{phoneNumber}</span>{' '} - with your verification code. - </> - ) : ( - "We've called your phone with a verification code." - )} - </p> - </div> - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label - htmlFor="code" - className="block text-sm font-medium text-gray-700" - > - Verification Code - </label> - <div className="mt-1"> - <input - id="code" - name="code" - type="text" - inputMode="numeric" - autoComplete="one-time-code" - required - value={code} - onChange={handleCodeChange} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500 sm:text-sm" - placeholder="Enter 6-digit code" - /> - </div> - </div> - - {showRememberDevice && ( - <div className="flex items-center"> - <input - id="remember-device" - name="remember-device" - type="checkbox" - checked={rememberDevice} - onChange={handleRememberDeviceChange} - className="h-4 w-4 text-blue-600 focus:ring-blue-500 border-gray-300 rounded" - /> - <label - htmlFor="remember-device" - className="ml-2 block text-sm text-gray-900" - > - Remember this device for 30 days - </label> - </div> - )} - - {error && ( - <div className="rounded-md bg-red-50 p-4"> - <div className="flex"> - <div className="ml-3"> - <h3 className="text-sm font-medium text-red-800">Error</h3> - <div className="text-sm text-red-700">{error}</div> - </div> - </div> - </div> - )} - - <div> - <button - type="submit" - disabled={isLoading} - className={`w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white - ${ - isLoading - ? 'bg-blue-400 cursor-not-allowed' - : 'bg-blue-600 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500' - }`} - > - {isLoading ? 'Verifying...' : 'Verify'} - </button> - </div> - </form> - - <div className="mt-6"> - <div className="relative"> - <div className="absolute inset-0 flex items-center"> - <div className="w-full border-t border-gray-300" /> - </div> - <div className="relative flex justify-center text-sm"> - <span className="px-2 bg-white text-gray-500">Options</span> - </div> - </div> - - <div className="mt-6 grid grid-cols-1 gap-3"> - <button - onClick={handleResendCode} - disabled={isLoading || disabled} - type="button" - className={`w-full inline-flex justify-center py-2 px-4 border rounded-md shadow-sm text-sm font-medium ${ - isLoading || disabled - ? 'bg-gray-300 text-gray-500 cursor-not-allowed border-gray-300' - : 'border-gray-300 bg-white text-gray-500 hover:bg-gray-50' - }`} - > - {disabled ? `Resend code in ${remainingSeconds}s` : 'Resend code'} - </button> - - {showLinkSms && ( - <button - onClick={handleSwitchToSms} - disabled={isLoading} - type="button" - className="w-full inline-flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm bg-white text-sm font-medium text-gray-500 hover:bg-gray-50" - > - Send a text message instead - </button> - )} - - <button - onClick={handlePickPhone} - disabled={isLoading} - type="button" - className="w-full inline-flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm bg-white text-sm font-medium text-gray-500 hover:bg-gray-50" - > - Use a different phone - </button> - - <button - onClick={handleTryAnotherMethod} - disabled={isLoading} - type="button" - className="w-full inline-flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm bg-white text-sm font-medium text-gray-500 hover:bg-gray-50" - > - Try another method - </button> - </div> - </div> - </div> - </div> - </div> - ); -}; - -export default MfaVoiceChallengeScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - Screen identifier for validation and telemetry -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - Screen-specific properties and data. -</ParamField> - -<ParamField path="untrustedData" type={<span>UntrustedDataOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Submits the voice verification code to validate the MFA challenge. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeContinueOptions">MfaVoiceChallengeContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="pickPhone" type={<span>Promise<void></span>}> - Navigates to the screen for selecting a different phone number. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="switchToSms" type={<span>Promise<void></span>}> - Switches to SMS verification method instead of voice call. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>}> - Requests a new voice call with a verification code. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Navigates to the screen for selecting an alternative MFA method. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> - Gets resend functionality with timeout management for this screen - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-voice-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceEnrollment.mdx deleted file mode 100644 index 6bdbf6466..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceEnrollment.mdx +++ /dev/null @@ -1,205 +0,0 @@ ---- -title: "MfaVoiceEnrollment" -description: "Class implementing the mfa-voice-enrollment screen functionality." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState } from 'react'; -import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; - -const MfaVoiceEnrollmentScreen: React.FC = () => { - const [phone, setPhone] = useState(''); - const mfaVoiceEnrollment = new MfaVoiceEnrollment(); - const { screen, transaction: { errors } } = mfaVoiceEnrollment; - const texts = screen.texts ?? {}; - - const handlePickCountryCode = async () => { - await mfaVoiceEnrollment.selectPhoneCountryCode(); - }; - - const handleContinueEnrollment = async () => { - await mfaVoiceEnrollment.continue({ phone }); - }; - - const handleTryAnotherMethod = async () => { - await mfaVoiceEnrollment.tryAnotherMethod(); - }; - - return ( - <div className="flex flex-col items-center min-h-screen bg-gray-100 p-4"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 w-full max-w-md"> - <h2 className="text-2xl font-bold mb-4 text-center"> - {texts.title ?? 'Secure Your Account'} - </h2> - <p className="text-sm text-gray-600 mb-6 text-center"> - {texts.description ?? 'Enter your phone number below. A voice call will be placed on that number with a code to enter on the next screen.'} - </p> - - <button - className="w-full mb-4 bg-green-500 hover:bg-green-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline" - type="button" - onClick={handlePickCountryCode} - > - {texts.pickCountryCodeButtonText ?? 'Pick Country Code'} - </button> - - <div className="mb-4"> - <label className="block text-gray-700 text-sm font-bold mb-2" htmlFor="phone"> - {texts.placeholder ?? 'Enter your phone number'} - </label> - <input - className="shadow appearance-none border rounded w-full py-2 px-3 text-gray-700 leading-tight focus:outline-none focus:shadow-outline" - id="phone" - type="text" - placeholder={texts.placeholder ?? 'Enter your phone number'} - value={phone} - onChange={(e) => setPhone(e.target.value)} - /> - {errors?.length > 0 && ( - <div className="mt-2 space-y-1"> - {errors.map((error, idx) => ( - <p key={idx} className="text-red-600 text-sm"> - {error.message} - </p> - ))} - </div> - )} - </div> - - <button - className="w-full bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline mb-4" - type="button" - onClick={handleContinueEnrollment} - > - {texts.buttonText ?? 'Continue'} - </button> - - <button - className="text-sm text-blue-500 hover:underline focus:outline-none" - type="button" - onClick={handleTryAnotherMethod} - > - {texts.pickAuthenticatorText ?? 'Try another method'} - </button> - </div> - </div> - ); -}; - -export default MfaVoiceEnrollmentScreen; -``` - -```typescript Pick Country Code lines -import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; - -const mfaVoiceEnrollment = new MfaVoiceEnrollment(); - -// Call the pickCountryCode method -mfaVoiceEnrollment.selectPhoneCountryCode(); -``` - -```typescript Continue Enrollment lines -import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; - -const mfaVoiceEnrollment = new MfaVoiceEnrollment(); - -// Call the continue method with a phone number -mfaVoiceEnrollment.continue({ - phone: "1234567890" -}); -``` - -```typescript Try Another Method lines -import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; - -const mfaVoiceEnrollment = new MfaVoiceEnrollment(); - -// Call the tryAnotherMethod -mfaVoiceEnrollment.tryAnotherMethod(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Continues with the default action. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows trying another authentication method - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="selectPhoneCountryCode" type={<span>Promise<void></span>}> - Allows picking a country code for the phone number - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-voice-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnChangeKeyNickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnChangeKeyNickname.mdx deleted file mode 100644 index 50a9e4a8c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnChangeKeyNickname.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "MfaWebAuthnChangeKeyNickname" -description: "" ---- - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - Holds the specific screen data and properties for this screen, processed by `ScreenOverride`. This includes the current `nickname` of the key. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continueWithNewNickname" type={<span>Promise<void></span>}> - Submits the new nickname provided by the user for their WebAuthn security key. This method prepares and posts the form data, including the new `nickname` and the required `action: "default"`, to the `/u/mfa-webauthn-change-key-nickname` endpoint. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-change-key-nickname/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnEnrollmentSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnEnrollmentSuccess.mdx deleted file mode 100644 index a21056937..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnEnrollmentSuccess.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "MfaWebAuthnEnrollmentSuccess" -description: "" ---- - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - static -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - Holds the specific screen data and properties for this screen, processed by `ScreenOverride`. This includes the enrolled authenticator's `nickname` and `webauthnType`. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Allows the user to continue the authentication flow after a successful WebAuthn enrollment. This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` endpoint with the action set to "default", indicating the user is proceeding from this success screen. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-enrollment-success/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnError.mdx deleted file mode 100644 index 2c45f40f2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnError.mdx +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "MfaWebAuthnError" -description: "" ---- - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - static -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - Holds the specific screen data and properties, processed by `ScreenOverride` for the MFA WebAuthn Error screen. This includes details like `errorType` and `webauthnType`. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="tryAgain" type={<span>Promise<void></span>}> - Allows the user to retry the previous WebAuthn operation. This action typically redirects the user to the screen where the WebAuthn process was initially attempted (e.g., back to the MFA challenge or enrollment screen for WebAuthn). - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="usePassword" type={<span>Promise<void></span>}> - Allows the user to attempt authentication using their password, if this alternative is configured and appropriate for the current flow (e.g., if password was a prior authentication step or is a valid MFA bypass). - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows the user to choose a different Multi-Factor Authentication method. This action navigates the user to a screen where they can select from other available/enrolled MFA factors. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="noThanks" type={<span>Promise<void></span>}> - Allows the user to decline the current WebAuthn operation (e.g., refuse to add a device during enrollment). This action signifies the user's choice not to proceed with the WebAuthn step at this time. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-error/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnNotAvailableError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnNotAvailableError.mdx deleted file mode 100644 index 3561ac962..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnNotAvailableError.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "MfaWebAuthnNotAvailableError" -description: "" ---- - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - static -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows the user to select a different Multi-Factor Authentication method because WebAuthn is not available or supported on their current device/browser. This action navigates the user to a screen where they can choose from other available/enrolled MFA factors. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-not-available-error/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-not-available-error/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformChallenge.mdx deleted file mode 100644 index 5b0529eb5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformChallenge.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "MfaWebAuthnPlatformChallenge" -description: "" ---- - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - static -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - Holds the specific screen data and properties for this screen, processed by `ScreenOverride`. This includes `publicKey` for the WebAuthn API call and `showRememberDevice`. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="verify" type={<span>Promise<void></span>}> - Initiates the WebAuthn platform authenticator challenge. Internally, this method retrieves the challenge options from `this.screen.publicKey`, calls `navigator.credentials.get()` (via the `getPasskeyCredentials` utility), and then submits the resulting credential assertion to the Auth0 server. - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifyPlatformAuthenticatorOptions">VerifyPlatformAuthenticatorOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="reportBrowserError" type={<span>Promise<void></span>}> - Reports a browser-side error encountered during the WebAuthn `navigator.credentials.get()` operation. This method should be called when `verify()` fails due to a WebAuthn API error (e.g., user cancellation). It sends the error details to the server with a specific action format. - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions">ReportBrowserErrorOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate the user to an MFA factor selection screen. - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-platform-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformEnrollment.mdx deleted file mode 100644 index a902f38e9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformEnrollment.mdx +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "MfaWebAuthnPlatformEnrollment" -description: "" ---- - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - static -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - Holds the specific screen data and properties, processed by `ScreenOverride` for the MFA WebAuthn Platform Enrollment screen. This includes convenient access to `screen.publicKey`. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="submitPasskeyCredential" type={<span>Promise<void></span>}> - Initiates the WebAuthn platform credential creation process using the public key options available on `this.screen.publicKey` and submits the resulting credential to the server. This method internally calls `createPasskeyCredentials` (which wraps `navigator.credentials.create()`). - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitPasskeyCredentialOptions">SubmitPasskeyCredentialOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="reportBrowserError" type={<span>Promise<void></span>}> - Reports a browser-side error encountered during the WebAuthn `navigator.credentials.create()` operation. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions">ReportBrowserErrorOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="snoozeEnrollment" type={<span>Promise<void></span>}> - Allows the user to choose to snooze the WebAuthn platform enrollment. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="refuseEnrollmentOnThisDevice" type={<span>Promise<void></span>}> - Allows the user to refuse WebAuthn platform enrollment on the current device. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-platform-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingChallenge.mdx deleted file mode 100644 index bbeff9e9e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingChallenge.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: "MfaWebAuthnRoamingChallenge" -description: "" ---- - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - static -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - Holds the specific screen data and properties, processed by `ScreenOverride`. This includes `publicKeyChallengeOptions` for the WebAuthn API call. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="verify" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifySecurityKeyOptions">VerifySecurityKeyOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="reportWebAuthnError" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportWebAuthnErrorOptions">ReportWebAuthnErrorOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-roaming-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingEnrollment.mdx deleted file mode 100644 index 2fd81ffba..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingEnrollment.mdx +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "MfaWebAuthnRoamingEnrollment" -description: "Class implementing the mfa-webauthn-roaming-enrollment screen functionality. This screen is displayed when a user needs to enroll a WebAuthn roaming authenticator (like a security key)." ---- - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="enroll" type={<span>Promise<void></span>}> - Initiates the WebAuthn credential creation and submits the result to the server. This corresponds to the user interacting with the FIDO Security Keys prompt. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="showError" type={<span>Promise<void></span>}> - Submits details about a WebAuthn browser error to the server. This is used when the browser's WebAuthn API encounters an error. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions">ShowErrorOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows the user to try another MFA method. This corresponds to the "Try Another Method" button. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/mfa-webauthn-roaming-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Organization.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Organization.mdx deleted file mode 100644 index 33471930a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Organization.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "Organization" -description: "" ---- - -## Properties - -<ParamField path="id" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a>['id']</span>} required> - The unique identifier of the organization -</ParamField> - -<ParamField path="name" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a>['name']</span>} required> - The name of the organization -</ParamField> - -<ParamField path="usage" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a>['usage']</span>} required> - How the organization is used in the authentication flow -</ParamField> - -<ParamField path="displayName" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a>['displayName']</span>} required> - The display name of the organization -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a>['branding']</span>} required> - Organization-specific branding settings -</ParamField> - -<ParamField path="metadata" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a>['metadata']</span>} required> - @property | null} metadata - Custom metadata associated with the organization -</ParamField> - ---- - -**File:** [src/models/organization.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/organization.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationPicker.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationPicker.mdx deleted file mode 100644 index 815320969..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationPicker.mdx +++ /dev/null @@ -1,164 +0,0 @@ ---- -title: "OrganizationPicker" -description: "Class implementing the organization-picker screen functionality. This screen allows users to select an organization from a list of available organizations." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React from 'react'; -import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; - -const OrganizationPickerScreen: React.FC = () => { - const organizationPicker = new OrganizationPicker(); - const { screen, user } = organizationPicker; - - const handleSelectOrganization = async (organizationId: string) => { - try { - await organizationPicker.selectOrganization({ organization: organizationId, state: organizationPicker.transaction.state }); - } catch (error) { - console.error('Failed to select organization:', error); - } - }; - - const handleSkipOrganization = async () => { - try { - await organizationPicker.skipOrganizationSelection(); - } catch (error) { - console.error('Failed to skip organization selection:', error); - } - }; - - return ( - <div className="flex flex-col items-center min-h-screen bg-gray-100"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4"> - <h2 className="text-2xl font-bold mb-4">{ `${ screen.texts?.title ?? 'Choose an Organization' }` }</h2> - <p>{ `${ user.email } ${ screen.texts?.loggedInText ?? 'is used as a personal account and is a part of multiple organizations.' }` } </p> - { - user.organizations ? ( - <ul className="mb-4"> - {user.organizations.map((org) => ( - <li key={org.organizationId} className="py-2"> - <button - onClick={() => handleSelectOrganization(org.organizationId ?? '')} - className="bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded" - > - {org.displayName || org.organizationName} - </button> - </li> - ))} - </ul> - ) : ( - <p>No organizations available.</p> - ) - } - <button - onClick={handleSkipOrganization} - className="bg-gray-500 hover:bg-gray-700 text-white font-bold py-2 px-4 rounded" - > - { `${ screen?.texts?.continueTextB2C ?? 'Continue with Personal Account' }` } - </button> - </div> - </div> - ); -}; - -export default OrganizationPickerScreen; -``` - -```typescript Select Organization lines -import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; - -const organizationPicker = new OrganizationPicker(); - -// Select an organization -await organizationPicker.selectOrganization({ - organization: 'org_1234567890123456', - state: organizationPicker.transaction.state -}); -``` - -```typescript Skip Organization Selection lines -import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; - -const organizationPicker = new OrganizationPicker(); - -// Skip organization selection -await organizationPicker.skipOrganizationSelection(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - Screen identifier for validation and telemetry -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="selectOrganization" type={<span>Promise<void></span>}> - Submits the selected organization ID. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectOrganizationOptions">SelectOrganizationOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="skipOrganizationSelection" type={<span>Promise<void></span>}> - Submits the action to skip the organization selection. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/organization-picker/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/organization-picker/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationSelection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationSelection.mdx deleted file mode 100644 index 6c8c1767c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationSelection.mdx +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: "OrganizationSelection" -description: "Class implementing the organization-selection screen functionality. This screen allows users to select an organization to continue with." ---- - -<RequestExample> - -```jsx React Component Example with TailwindCSS lines -import React, { useState } from 'react'; -import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection'; - -const OrganizationSelectionScreen = () => { - const [organizationName, setOrganizationName] = useState(''); - const organizationSelectionManager = new OrganizationSelection(); - - const { screen } = organizationSelectionManager; - - const handleSubmit = async (e: React.FormEvent<HTMLFormElement>) => { - e.preventDefault(); - try { - await organizationSelectionManager.continueWithOrganizationName({ - organizationName, - }); - } catch (error) { - console.error('Organization Selection failed:', error); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - { `${ screen?.texts?.title ?? 'Select Organization' }` } - </h2> - <p className="mt-3">{ `${ screen?.texts?.description ?? 'Enter your xxxxx-xxxxxx Organization Name to continue' }`}</p> - </div> - - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label htmlFor="organizationName" className="block text-sm font-medium text-gray-700"> - Organization Name - </label> - <div className="mt-1"> - <input - id="organizationName" - name="organizationName" - type="text" - required - value={organizationName} - onChange={(e) => setOrganizationName(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - - <div> - <button - type="submit" - className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - { `${ screen?.texts?.buttonText ?? 'Continue' }` } - </button> - </div> - </form> - </div> - </div> - </div> - ); -}; - -export default OrganizationSelectionScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - Screen identifier for validation and telemetry -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continueWithOrganizationName" type={<span>Promise<void></span>}> - Continues with the selected organization name. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithOrganizationNameOptions">ContinueWithOrganizationNameOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/organization-selection/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/organization-selection/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollment.mdx deleted file mode 100644 index e44108c69..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollment.mdx +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: "PasskeyEnrollment" -description: "" ---- - -<RequestExample> - -```typescript Enroll with Passkey local lines -import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; - -const passkeyEnrollment = new PasskeyEnrollment(); -passkeyEnrollment.continuePasskeyEnrollment(); -``` - -```typescript Abort passkey enrolment local lines -import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; - -const passkeyEnrollment = new PasskeyEnrollment(); -passkeyEnrollment.abortPasskeyEnrollment(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continuePasskeyEnrollment" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="abortPasskeyEnrollment" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/passkey-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollmentLocal.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollmentLocal.mdx deleted file mode 100644 index 6e09a7351..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollmentLocal.mdx +++ /dev/null @@ -1,187 +0,0 @@ ---- -title: "PasskeyEnrollmentLocal" -description: "" ---- - -<RequestExample> - -```typescript continuePasskeyEnrollment lines -import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment-local'; - -// Create an instance of PasskeyEnrollment to handle the enrollment process -const passkeyEnrollment = new PasskeyEnrollment(); - -// Begin the passkey enrollment process for local authentication -// This will trigger the necessary flow for the user to enroll their passkey -passkeyEnrollment.continuePasskeyEnrollment(); -``` - -```typescript Abort local passkey enrolment lines -import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment-local'; - -const passkeyEnrollment = new PasskeyEnrollmentLocal(); -passkeyEnrollment.abortPasskeyEnrollment({ - doNotShowAgain: <boolean> -}); -``` - -```typescript PasskeyEnrollmentLocal React Example lines -import React, { useState } from 'react'; -import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local'; - -const PasskeyEnrollmentLocalScreen: React.FC = () => { - const [error, setError] = useState(''); - const [success, setSuccess] = useState(false); - const [aborted, setAborted] = useState(false); - const [doNotShowAgain, setDoNotShowAgain] = useState(false); - - const passkeyEnrollment = new PasskeyEnrollmentLocal(); - - const handleContinue = async (e) => { - e.preventDefault(); - setError(''); - setSuccess(false); - setAborted(false); - try { - await passkeyEnrollment.continuePasskeyEnrollment(); - setSuccess(true); - } catch (err) { - setError('Failed to enroll passkey. Please try again.'); - } - }; - - const handleAbort = async (e) => { - e.preventDefault(); - setError(''); - setSuccess(false); - setAborted(false); - try { - await passkeyEnrollment.abortPasskeyEnrollment({ doNotShowAgain }); - setAborted(true); - } catch (err) { - setError('Failed to abort enrollment. Please try again.'); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - Passkey Enrollment (Local) - </h2> - </div> - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleContinue}> - <div className="flex flex-col gap-2"> - <button - type="submit" - className="w-full py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Continue Passkey Enrollment - </button> - </div> - </form> - <form className="space-y-6 mt-4" onSubmit={handleAbort}> - <div className="flex items-center"> - <input - id="doNotShowAgain" - name="doNotShowAgain" - type="checkbox" - checked={doNotShowAgain} - onChange={(e) => setDoNotShowAgain(e.target.checked)} - className="h-4 w-4 text-blue-600 focus:ring-blue-500 border-gray-300 rounded" - /> - <label htmlFor="doNotShowAgain" className="ml-2 block text-sm text-gray-900"> - Do not show again - </label> - </div> - <button - type="submit" - className="w-full py-2 px-4 border border-red-600 rounded-md shadow-sm text-sm font-medium text-red-600 bg-white hover:bg-red-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-red-500" - > - Abort Enrollment - </button> - </form> - {error && <div className="text-red-600 text-sm mt-2">{error}</div>} - {success && <div className="text-green-600 text-sm mt-2">Passkey enrollment successful!</div>} - {aborted && <div className="text-blue-600 text-sm mt-2">Passkey enrollment aborted.</div>} - </div> - </div> - </div> - ); -}; - -export default PasskeyEnrollmentLocalScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continuePasskeyEnrollment" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="abortPasskeyEnrollment" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AbortEnrollmentOptions">AbortEnrollmentOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/passkey-enrollment-local/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierChallenge.mdx deleted file mode 100644 index a99441731..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierChallenge.mdx +++ /dev/null @@ -1,299 +0,0 @@ ---- -title: "PhoneIdentifierChallenge" -description: "" ---- - -<RequestExample> - -```typescript submitPhoneChallenge lines -import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; - -const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); -phoneIdentifierChallenge.submitPhoneChallenge({ - code:"dummyCode" -}); -``` - -```typescript resendCode lines -import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; - -const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); -phoneIdentifierChallenge.resendCode(); -``` - -```typescript returnToPrevious lines -import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; - -const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); -phoneIdentifierChallenge.returnToPrevious(); -``` - -```typescript resendManager lines -import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; - -const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); - -function handleStatusChange(remainingSeconds: number) { - console.log('Remaining seconds:', remainingSeconds); -} - -function handleTimeout() { - console.log('Resend timeout completed'); -} - -const resendManager = phoneIdentifierChallenge.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleTimeout, -}); - -const { startResend } = resendManager; - -// Use startResend() to initiate the resend with cooldown -startResend(); -``` - -```typescript PhoneIdentifierChallenge React Example lines -import React, { useState, useMemo } from 'react'; -import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; - -const PhoneIdentifierChallengeScreen: React.FC = () => { - const [code, setCode] = useState(''); - const [error, setError] = useState(''); - const [success, setSuccess] = useState(false); - const [resent, setResent] = useState(false); - const [returned, setReturned] = useState(false); - const [disabled, setDisabled] = useState(false); - - const phoneIdentifierChallenge = useMemo(() => new PhoneIdentifierChallenge(), []); - - function handleStatusChange(remainingSeconds: number) { - setDisabled(remainingSeconds > 0); - } - - function handleTimeout() { - console.log('Resend timeout completed'); - } - - const resendManager = useMemo( - () => - phoneIdentifierChallenge.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleonTimeout, - }), - [phoneIdentifierChallenge] - ); - - const { startResend } = resendManager; - - const handleSubmit = async (e: React.FormEvent) => { - e.preventDefault(); - setError(''); - setSuccess(false); - setResent(false); - setReturned(false); - - if (!code) { - setError('Code is required.'); - return; - } - try { - await phoneIdentifierChallenge.submitPhoneChallenge({ code }); - setSuccess(true); - } catch { - setError('Invalid code. Please try again.'); - } - }; - - const handleResend = async (e: React.FormEvent) => { - e.preventDefault(); - try { - await startResend(); - setResent(true); - } catch (err: any) { - setError(err.message || 'Failed to resend code.'); - } - }; - - const handleReturn = async (e: React.FormEvent) => { - e.preventDefault(); - setError(''); - setSuccess(false); - setResent(false); - setReturned(false); - - try { - await phoneIdentifierChallenge.returnToPrevious(); - setReturned(true); - } catch { - setError('Failed to return to previous step. Please try again later.'); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - Phone Identifier Challenge - </h2> - </div> - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label htmlFor="code" className="block text-sm font-medium text-gray-700"> - Code - </label> - <div className="mt-1"> - <input - id="code" - name="code" - type="text" - required - value={code} - onChange={(e) => setCode(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - <button - type="submit" - className="w-full py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Submit Challenge - </button> - </form> - {/* ✅ Resend with cooldown */} - <form className="space-y-6 mt-4" onSubmit={handleResend}> - <button - type="submit" - disabled={disabled} - className={`w-full py-2 px-4 border rounded-md shadow-sm text-sm font-medium - ${disabled ? 'bg-gray-300 text-gray-500 cursor-not-allowed' : 'bg-white text-blue-600 border-blue-600 hover:bg-blue-50'} - `} - > - {disabled ? `Resend limit has been reached` : 'Resend Code'} - </button> - </form> - <form className="space-y-6 mt-4" onSubmit={handleReturn}> - <button - type="submit" - className="w-full py-2 px-4 border border-gray-400 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-gray-500" - > - Return to Previous - </button> - </form> - {error && <div className="text-red-600 text-sm mt-2">{error}</div>} - {success && <div className="text-green-600 text-sm mt-2">Challenge submitted successfully!</div>} - {resent && <div className="text-blue-600 text-sm mt-2">Code resent to your phone.</div>} - {returned && <div className="text-blue-600 text-sm mt-2">Returned to previous step.</div>} - </div> - </div> - </div> - ); -}; - -export default PhoneIdentifierChallengeScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="submitPhoneChallenge" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneChallengeOptions">PhoneChallengeOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="returnToPrevious" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="switchToVoice" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="switchToText" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> - Gets resend functionality with timeout management for this screen - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/phone-identifier-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierEnrollment.mdx deleted file mode 100644 index ef644ee5d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierEnrollment.mdx +++ /dev/null @@ -1,183 +0,0 @@ ---- -title: "PhoneIdentifierEnrollment" -description: "" ---- - -<RequestExample> - -```typescript continuePhoneEnrollment lines -import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment'; - -const phoneIdentifierEnrollment = new PhoneIdentifierEnrollment(); -phoneIdentifierChallenge.continuePhoneEnrollment({ - type:"<text' | 'voice>" -}); -``` - -```typescript returnToPrevious lines -import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment'; - -const phoneIdentifierEnrollment = new PhoneIdentifierEnrollment(); -phoneIdentifierChallenge.returnToPrevious(); -``` - -```typescript PhoneIdentifierEnrollment React Example lines -import React, { useState } from 'react'; -import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment'; - -const PhoneIdentifierEnrollmentScreen: React.FC = () => { - const [type, setType] = useState('text'); - const [error, setError] = useState(''); - const [success, setSuccess] = useState(false); - const [returned, setReturned] = useState(false); - - const phoneIdentifierEnrollment = new PhoneIdentifierEnrollment(); - - const handleContinue = async (e) => { - e.preventDefault(); - setError(''); - setSuccess(false); - setReturned(false); - try { - await phoneIdentifierEnrollment.continuePhoneEnrollment({ type }); - setSuccess(true); - } catch (err) { - setError('Failed to continue phone enrollment. Please try again.'); - } - }; - - const handleReturn = async (e) => { - e.preventDefault(); - setError(''); - setSuccess(false); - setReturned(false); - try { - await phoneIdentifierEnrollment.returnToPrevious(); - setReturned(true); - } catch (err) { - setError('Failed to return to previous step. Please try again.'); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - Phone Identifier Enrollment - </h2> - </div> - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleContinue}> - <div> - <label htmlFor="type" className="block text-sm font-medium text-gray-700"> - Enrollment Type - </label> - <select - id="type" - name="type" - value={type} - onChange={(e) => setType(e.target.value)} - className="mt-1 block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm focus:outline-none focus:ring-blue-500 focus:border-blue-500" - > - <option value="text">Text</option> - <option value="voice">Voice</option> - </select> - </div> - <button - type="submit" - className="w-full py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Continue Enrollment - </button> - </form> - <form className="space-y-6 mt-4" onSubmit={handleReturn}> - <button - type="submit" - className="w-full py-2 px-4 border border-blue-600 rounded-md shadow-sm text-sm font-medium text-blue-600 bg-white hover:bg-blue-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Return to Previous - </button> - </form> - {error && <div className="text-red-600 text-sm mt-2">{error}</div>} - {success && <div className="text-green-600 text-sm mt-2">Phone enrollment continued successfully!</div>} - {returned && <div className="text-blue-600 text-sm mt-2">Returned to previous step.</div>} - </div> - </div> - </div> - ); -}; - -export default PhoneIdentifierEnrollmentScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continuePhoneEnrollment" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneEnrollmentOptions">PhoneEnrollmentOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="returnToPrevious" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/phone-identifier-enrollment/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Prompt.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Prompt.mdx deleted file mode 100644 index 208ded864..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Prompt.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Prompt" -description: "" ---- - -## Properties - -<ParamField path="name" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a>['name']</span>} required> - The name of the prompt (e.g., 'login', 'signup') -</ParamField> - ---- - -**File:** [src/models/prompt.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/prompt.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/RedeemTicket.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/RedeemTicket.mdx deleted file mode 100644 index 3d7be46a9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/RedeemTicket.mdx +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: "RedeemTicket" -description: "Implements the redeem-ticket screen functionality." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React from 'react'; -import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; - -const RedeemTicketScreen: React.FC = () => { - const redeemTicketManager = new RedeemTicket(); - const { screen, transaction } = redeemTicketManager; - const texts = screen?.texts ?? {}; - const prompt = screen?.data?.prompt; - - const getDescription = () => { - switch (prompt) { - case 'email-verification': - return texts.descriptionEmailVerify ?? 'Click Continue to Verify Your Email'; - case 'passwordless-auth': - return texts.descriptionPasswordlessVerify ?? 'Click Continue to Sign In'; - case 'mfa-enrollment': - return texts.description ?? 'Click Continue to Enroll in Multi-Factor Authentication'; - default: - return texts.description ?? 'Click Continue to proceed'; - } - }; - - const handleContinue = async () => { - try { - await redeemTicketManager.continue(); - } catch (error) { - console.error('Failed to continue:', error); - } - }; - - return ( - <div className="flex flex-col items-center justify-center min-h-screen bg-gray-100 p-4"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 w-full max-w-md text-center"> - <h2 className="text-2xl font-bold mb-4"> - {texts.pageTitle ?? 'Redeem Ticket'} - </h2> - <p className="text-sm text-gray-700 mb-6"> - {getDescription()} - </p> - - {transaction?.errors?.length && ( - <div className="mb-4 space-y-1"> - {transaction.errors.map((err, index) => ( - <p key={index} className="text-red-600 text-sm"> - {err.message} - </p> - ))} - </div> - )} - - <button - className="w-full bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline" - type="button" - onClick={handleContinue} - > - {texts.buttonText ?? 'Continue'} - </button> - </div> - </div> - ); -}; - -export default RedeemTicketScreen; -``` - -```typescript Continue lines -import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; - -const redeemTicket = new RedeemTicket(); - -// Continue with the default action -await redeemTicket.continue(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Performs the default action on the redeem-ticket screen, usually continuing the flow. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/redeem-ticket/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/redeem-ticket/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPassword.mdx deleted file mode 100644 index ca9d31f4f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPassword.mdx +++ /dev/null @@ -1,205 +0,0 @@ ---- -title: "ResetPassword" -description: "" ---- - -<RequestExample> - -```typescript resetPassword lines -import React, { useRef, useState } from "react"; -import { useResetPasswordManager } from './hooks/useResetPasswordManager'; -import { Logo } from "../../components/Logo"; -import { Title } from './components/Title'; -import { ErrorMessages } from './components/ErrorMessages'; -import Button from '../../components/Button'; // Adjust the path if needed - -const ResetPasswordScreen: React.FC = () => { - const { resetPasswordManager, handleResetPassword } = useResetPasswordManager(); - - const newPasswordRef = useRef<HTMLInputElement>(null); - const confirmPasswordRef = useRef<HTMLInputElement>(null); - const captchaRef = useRef<HTMLInputElement>(null); - - const [isValid, setIsValid] = useState(true); - const [errors, setErrors] = useState<Array<{ code: string; message: string }>>([]); - const [isValidConfirmPassword, setIsValidConfirmPassword] = useState(true); - const [confirmPasswordErrors, setConfirmPasswordErrors] = useState<Array<{ code: string; message: string }>>([]); - - const getFormValues = () => ({ - newPassword: newPasswordRef.current?.value || '', - confirmPassword: confirmPasswordRef.current?.value || '', - captcha: captchaRef.current?.value || '', - }); - - const onLoginClick = () => { - const { newPassword, confirmPassword, captcha } = getFormValues(); - - const { isValid, errors } = resetPasswordManager.validatePassword(newPassword); - const { isValid: isValidConfirmPassword, errors: confirmPasswordErrors } = - resetPasswordManager.validatePassword(confirmPassword); - - setIsValid(isValid); - setErrors(errors); - setIsValidConfirmPassword(isValidConfirmPassword); - setConfirmPasswordErrors(confirmPasswordErrors); - - if (!isValid || !isValidConfirmPassword) { - return; - } - - handleResetPassword(newPassword, confirmPassword, captcha); - }; - - return ( - <div className="prompt-container"> - <Logo /> - <Title screenTexts={resetPasswordManager.screen.texts!} /> - - <div className="input-container"> - {/* New Password */} - <label>Enter your new password</label> - <input - type="password" - id="newPassword" - ref={newPasswordRef} - aria-invalid={!isValid} - placeholder="Enter your password" - required - className={`input w-full border px-4 py-2 rounded ${ - !isValid ? 'border-red-500' : 'border-gray-300' - }`} - /> - {!isValid && ( - <ul className="text-red-500 text-sm list-disc list-inside"> - {errors.map((err) => ( - <li key={err.code}>{err.message}</li> - ))} - </ul> - )} - - {/* Confirm Password */} - <label>Confirm your new password</label> - <input - type="password" - id="password" - ref={confirmPasswordRef} - aria-invalid={!isValidConfirmPassword} - placeholder="Re-enter your password" - required - className={`input w-full border px-4 py-2 rounded ${ - !isValidConfirmPassword ? 'border-red-500' : 'border-gray-300' - }`} - /> - {!isValidConfirmPassword && ( - <ul className="text-red-500 text-sm list-disc list-inside"> - {confirmPasswordErrors.map((err) => ( - <li key={err.code}>{err.message}</li> - ))} - </ul> - )} - - {/* Captcha */} - {resetPasswordManager.screen.isCaptchaAvailable && ( - <div className="captcha-container"> - <img src={resetPasswordManager.screen.captchaImage ?? ""} alt="Captcha" /> - <label>Enter the captcha</label> - <input - type="text" - id="captcha" - ref={captchaRef} - placeholder="Enter the captcha" - /> - </div> - )} - - {/* Submit Button */} - <div className="button-container"> - <Button id="continue" onClick={onLoginClick}> - Continue - </Button> - </div> - </div> - - {/* Transaction Errors */} - {resetPasswordManager.transaction.hasErrors && resetPasswordManager.transaction.errors && ( - <ErrorMessages errors={resetPasswordManager.transaction.errors!} /> - )} - </div> - ); -}; - -export default ResetPasswordScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="transaction" type={<span>TransactionOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="resetPassword" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordOptions">ResetPasswordOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="validatePassword" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> - @param password - - <Expandable title="parameters"> - <ParamField path="password" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/reset-password/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordEmail.mdx deleted file mode 100644 index 6b33529e2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordEmail.mdx +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: "ResetPasswordEmail" -description: "" ---- - -<RequestExample> - -```typescript typescript lines -import ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email'; - -const resetPasswordEmail = new ResetPasswordEmail(); -resetPasswordEmail.resendEmail(); -``` - -```jsx React Component Example with TailwindCSS lines -import ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email'; - -const ResetPasswordEmailScreen = () => { - const resetPasswordEmail = new ResetPasswordEmail(); - - - return ( - <div className="w-[100vw] min-h-screen bg-gray-100 flex items-center justify-center p-4"> - <div className="w-full max-w-md"> - <h2 className="text-3xl font-bold text-center mb-8"> - Resend Email - </h2> - - <div className="bg-white p-8 rounded-lg shadow"> - <form> - <div className="space-y-3"> - <button - type="button" - onClick={() => resetPasswordEmail?.resendEmail()} - className="w-full py-2 px-4 border text-gray-700 rounded-md hover:bg-gray-50" - > - Resend Email - </button> - </div> - </form> - </div> - </div> - </div> - ); -}; - -export default ResetPasswordEmailScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="resendEmail" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/reset-password-email/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-email/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordError.mdx deleted file mode 100644 index 4dafd4075..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordError.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: "ResetPasswordError" -description: "" ---- - -<RequestExample> - -```js js lines -import ResetPasswordError from '@auth0/auth0-acul-js/reset-password-error'; -const resetPasswordError = new ResetPasswordError(); - -const { screen } = resetPasswordError; -const data = screen.texts?.description; -console.log(data); -``` - -```typescript React Component Example with TailwindCSS lines -import React from 'react'; -import ResetPasswordError from '@auth0/auth0-acul-js/reset-password-error'; - -const ResetPasswordErrorComponent: React.FC = () => { - const resetPasswordSuccessManager = new ResetPasswordError(); - const { screen } = resetPasswordErrorManager; - const data = screen.texts?.description; - - return ( - <div className="w-[100vw] flex flex-col items-center justify-center min-h-screen bg-gray-100"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4 flex flex-col"> - <h2 className="text-2xl font-bold mb-6">Reset Password Error Screen</h2> - {data && ( - <div className="mb-4"> - <p>Message: {data}</p> - </div> - )} - </div> - </div> - ); -}; - -export default ResetPasswordErrorComponent; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/reset-password-error/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-error/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaEmailChallenge.mdx deleted file mode 100644 index 91c5fafa7..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaEmailChallenge.mdx +++ /dev/null @@ -1,262 +0,0 @@ ---- -title: "ResetPasswordMfaEmailChallenge" -description: "Class implementing the reset-password-mfa-email-challenge screen functionality" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState, useMemo } from 'react'; -import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; - -const ResetPasswordMfaEmailChallengeScreen: React.FC = () => { - const [code, setCode] = useState(''); - const [disabled, setDisabled] = useState(false); - const [remainingSeconds, setRemainingSeconds] = useState(0); - - const resetPasswordMfaEmailChallenge = useMemo(() => new ResetPasswordMfaEmailChallenge(), []); - const { screen, transaction } = resetPasswordMfaEmailChallenge; - - function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { - setDisabled(isDisabled); - setRemainingSeconds(remainingSeconds); - } - - function handleTimeout() { - console.log('Resend timeout completed'); - } - - const resendManager = useMemo( - () => - resetPasswordMfaEmailChallenge.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleTimeout, - }), - [resetPasswordMfaEmailChallenge] - ); - - const { startResend } = resendManager; - - const handleSubmit = async (e: React.FormEvent) => { - e.preventDefault(); - await resetPasswordMfaEmailChallenge.continue({ - code - }); - }; - - const handleResendCode = async () => { - try { - await startResend(); - } catch (error) { - console.error('Failed to resend code:', error); - } - }; - - const handleTryAnotherMethod = async () => { - await resetPasswordMfaEmailChallenge.tryAnotherMethod(); - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - { screen?.texts?.title ?? 'Verify Your Identity' } - </h2> - <p className="mt-2 text-center text-sm text-gray-600"> - { (screen?.texts?.description ?? 'We\'ve sent an email with your code to') + screen.data?.email } - </p> - </div> - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label htmlFor="code" className="block text-sm font-medium text-gray-700"> - { screen?.texts?.placeholder ?? 'Enter the code' } - </label> - <div className="mt-1"> - <input - id="code" - name="code" - type="text" - required - placeholder={ screen?.texts?.placeholder ?? 'Enter the code' } - value={code} - onChange={(e) => setCode(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - {transaction?.errors?.length && ( - <div className="mt-2 mb-4"> - {transaction?.errors.map((err, index) => ( - <p key={index} className="text-red-500"> - {err.message} - </p> - ))} - </div> - )} - </div> - - <div> - <button - type="submit" - className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Verify Code - </button> - </div> - </form> - - <div className="mt-6"> - <div className="flex justify-between"> - <button - onClick={handleResendCode} - disabled={disabled} - className={`text-sm ${ - disabled - ? "text-gray-400 cursor-not-allowed" - : "text-blue-600 hover:text-blue-500" - }`} - > - {disabled - ? `${screen?.texts?.resendActionText ?? 'Resend Code'} (${remainingSeconds}s)` - : screen?.texts?.resendActionText ?? 'Resend Code' - } - </button> - <button - onClick={handleTryAnotherMethod} - className="text-sm text-blue-600 hover:text-blue-500" - > - { screen?.texts?.pickAuthenticatorText ?? 'Try another method' } - </button> - </div> - </div> - </div> - </div> - </div> - ); -}; - -export default ResetPasswordMfaEmailChallengeScreen; -``` - -```typescript Continue with Code lines -import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; - -const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); - -resetPasswordMfaEmailChallenge.continue({ - code: '123456', - rememberDevice: true, -}); -``` - -```typescript Resend Code lines -import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; - -const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); - -resetPasswordMfaEmailChallenge.resendCode(); -``` - -```typescript Try Another Method lines -import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; - -const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); - -resetPasswordMfaEmailChallenge.tryAnotherMethod(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Continues with the email challenge using the provided code. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>}> - Resends the email code. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions">ResendCodeOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows the user to try another MFA method. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> - Gets resend functionality with timeout management for this screen - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-email-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaOtpChallenge.mdx deleted file mode 100644 index 6330e561d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaOtpChallenge.mdx +++ /dev/null @@ -1,193 +0,0 @@ ---- -title: "ResetPasswordMfaOtpChallenge" -description: "Class implementing the reset-password-mfa-otp-challenge screen functionality" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState } from 'react'; -import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge'; - -const ResetPasswordMfaOtpChallengeScreen: React.FC = () => { - const [code, setCode] = useState(''); - // const [rememberDevice, setRememberDevice] = useState(false); - - const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge(); - const { screen, transaction } = resetPasswordMfaOtpChallenge; - - const handleSubmit = async (e: React.FormEvent) => { - e.preventDefault(); - await resetPasswordMfaOtpChallenge.continue({ - code, - }); - }; - - const handleTryAnotherMethod = async () => { - await resetPasswordMfaOtpChallenge.tryAnotherMethod(); - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - { screen?.texts?.title ?? 'Verify Your Identity' } - </h2> - <p className="mt-2 text-center text-sm text-gray-600"> - { screen?.texts?.description ?? 'Check your preferred one-time password authenticator app for the code.' } - </p> - </div> - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label htmlFor="code" className="block text-sm font-medium text-gray-700"> - {screen?.texts?.placeholder ?? 'Enter your one-time code'} - </label> - <div className="mt-1"> - <input - id="code" - name="code" - type="text" - placeholder={screen?.texts?.placeholder ?? 'Enter your one-time code'} - required - value={code} - onChange={(e) => setCode(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - - {transaction?.errors?.length && ( - <div className="mt-2 mb-4"> - {transaction?.errors.map((err, index) => ( - <p key={index} className="text-red-500"> - {err.message} - </p> - ))} - </div> - )} - - <div> - <button - type="submit" - className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Verify Code - </button> - </div> - </form> - - <div className="mt-6"> - <div className="flex justify-center"> - <button - onClick={handleTryAnotherMethod} - className="text-sm text-blue-600 hover:text-blue-500" - > - { screen?.texts?.tryAnotherMethod ?? 'Try another method' } - </button> - </div> - </div> - </div> - </div> - </div> - ); -}; - -export default ResetPasswordMfaOtpChallengeScreen; -``` - -```typescript Continue with Code lines -import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge'; - -const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge(); - -resetPasswordMfaOtpChallenge.continue({ - code: '123456', -}); -``` - -```typescript Try Another Method lines -import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge'; - -const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge(); - -resetPasswordMfaOtpChallenge.tryAnotherMethod(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - Screen identifier for validation and telemetry -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Continues with the OTP challenge using the provided code. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows the user to try another MFA method. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-otp-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPhoneChallenge.mdx deleted file mode 100644 index 92e7c476c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPhoneChallenge.mdx +++ /dev/null @@ -1,273 +0,0 @@ ---- -title: "ResetPasswordMfaPhoneChallenge" -description: "" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState } from 'react'; -import ResetPasswordMfaPhoneChallenge, { - type ContinueOptions, - type TryAnotherMethodOptions -} from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; - -const ResetPasswordMfaPhoneChallengeScreen: React.FC = () => { - // Instantiate the SDK class for the screen - const screenManager = new ResetPasswordMfaPhoneChallenge(); - const { screen, transaction } = screenManager; - - // State to manage loading indicators and potential errors - const [isLoading, setIsLoading] = useState<boolean>(false); - const [error, setError] = useState<string | null>(null); - // State to track the user's choice (needed for tryAnotherMethod) - // Default to 'sms' or 'voice' based on initial view, or let user select first - const [currentChallengeType, setCurrentChallengeType] = useState<'sms' | 'voice'>('sms'); // Example default - - /** - * Handles the action when the user chooses SMS or Voice Call. - * @param {'sms' | 'voice'} type - The selected delivery method. - */ - const handleContinue = async (type: ContinueOptions['type']) => { - setIsLoading(true); - setError(null); - setCurrentChallengeType(type); // Update the current type - try { - await screenManager.continue({ type }); - // On success, Auth0 usually handles the redirect to the next step (code entry). - } catch (err: any) { - setError(err.message || 'Failed to send verification code. Please try again.'); - setIsLoading(false); // Only stop loading on error - } - }; - - /** - * Handles the action when the user wants to try a different MFA method. - */ - const handleTryAnotherMethod = async () => { - setIsLoading(true); - setError(null); - try { - // Pass the current challenge type the user was viewing - await screenManager.tryAnotherMethod({ type: currentChallengeType }); - // On success, Auth0 usually handles the redirect to the authenticator selection screen. - } catch (err: any) { - setError(err.message || 'Failed to switch MFA methods. Please try again.'); - setIsLoading(false); // Only stop loading on error - } - }; - - // Extract texts for UI elements, providing default fallbacks - const texts = screen?.texts ?? {}; - const title = texts.title ?? 'Verify Your Identity'; - // Example: Modify description to include phone number securely - const description = texts.description ?? `To continue resetting your password, please verify your identity. How would you like to get the verification code sent to ${screen.data?.phoneNumber ?? 'your phone'}?`; - const smsButtonText = texts.smsButtonText ?? 'Send code via SMS'; - const voiceButtonText = texts.voiceButtonText ?? 'Send code via Voice Call'; - const tryAnotherMethodText = texts.pickAuthenticatorText ?? 'Try Another Method'; // Assuming this text key exists - - return ( - <div className="flex items-center justify-center min-h-screen bg-gray-100 p-4"> - <div className="w-full max-w-md bg-white rounded-lg shadow-md p-8"> - <h1 className="text-2xl font-semibold text-center text-gray-800 mb-4"> - {title} - </h1> - <p className="text-center text-gray-600 mb-6"> - {description} - </p> - - {/* Display errors from the transaction object (e.g., invalid state) */} - {transaction.errors && transaction.errors.length > 0 && ( - <div className="bg-red-100 border border-red-400 text-red-700 px-4 py-3 rounded relative mb-4" role="alert"> - <strong className="font-bold">Error: </strong> - {transaction.errors.map((err, index) => ( - <span key={`tx-error-${index}`} className="block sm:inline">{err.message}</span> - ))} - </div> - )} - - {/* Display errors caught during form submission */} - {error && ( - <div className="bg-red-100 border border-red-400 text-red-700 px-4 py-3 rounded relative mb-4" role="alert"> - <strong className="font-bold">Error: </strong> - <span className="block sm:inline">{error}</span> - </div> - )} - - <div className="space-y-4"> - {/* SMS Button */} - <button - onClick={() => handleContinue('sms')} - disabled={isLoading} - className={`w-full px-4 py-2 text-white bg-blue-600 rounded-md transition duration-150 ease-in-out ${isLoading ? 'opacity-50 cursor-not-allowed' : 'hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-blue-500 focus:ring-opacity-50'}`} - > - {isLoading && currentChallengeType === 'sms' ? 'Sending SMS...' : smsButtonText} - </button> - - {/* Voice Call Button */} - <button - onClick={() => handleContinue('voice')} - disabled={isLoading} - className={`w-full px-4 py-2 text-white bg-green-600 rounded-md transition duration-150 ease-in-out ${isLoading ? 'opacity-50 cursor-not-allowed' : 'hover:bg-green-700 focus:outline-none focus:ring-2 focus:ring-green-500 focus:ring-opacity-50'}`} - > - {isLoading && currentChallengeType === 'voice' ? 'Initiating Call...' : voiceButtonText} - </button> - </div> - - {/* Separator */} - <div className="my-6 border-t border-gray-300"></div> - - {/* Try Another Method Button */} - <button - onClick={handleTryAnotherMethod} - disabled={isLoading} - className={`w-full px-4 py-2 text-gray-700 bg-gray-200 rounded-md transition duration-150 ease-in-out ${isLoading ? 'opacity-50 cursor-not-allowed' : 'hover:bg-gray-300 focus:outline-none focus:ring-2 focus:ring-gray-400 focus:ring-opacity-50'}`} - > - {isLoading ? 'Loading...' : tryAnotherMethodText} - </button> - </div> - </div> - ); -}; - -export default ResetPasswordMfaPhoneChallengeScreen; -``` - -```typescript Initialize the SDK Class lines -import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; - -const screenManager = new ResetPasswordMfaPhoneChallenge(); - -// Access screen data like the phone number -const phoneNumber = screenManager.screen.data?.phoneNumber; -console.log('Phone number for challenge:', phoneNumber); // e.g., "+1******7890" - -// Access transaction details like errors -const errors = screenManager.transaction.errors; -if (errors) { - console.error('Transaction errors:', errors); -} -``` - -```typescript Send Code via SMS lines -import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; - -const screenManager = new ResetPasswordMfaPhoneChallenge(); - -try { - await screenManager.continue({ type: 'sms' }); - // On success, the user will typically be redirected to the code entry screen. -} catch (error) { - console.error('Failed to request SMS code:', error); - // Handle the error, e.g., display a message to the user. -} -``` - -```typescript Send Code via Voice Call lines -import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; - -const screenManager = new ResetPasswordMfaPhoneChallenge(); - -try { - await screenManager.continue({ type: 'voice' }); - // On success, the user will typically be redirected to the code entry screen. -} catch (error) { - console.error('Failed to request voice call:', error); - // Handle the error. -} -``` - -```typescript Try Another MFA Method lines -import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; - -const screenManager = new ResetPasswordMfaPhoneChallenge(); - -// You need to know which option ('sms' or 'voice') was presented or last selected by the user. -// Let's assume 'sms' was the context. -const currentType: 'sms' | 'voice' = 'sms'; - -try { - await screenManager.tryAnotherMethod({ type: currentType }); - // On success, the user will be redirected to the authenticator selection screen. -} catch (error) { - console.error('Failed to switch MFA method:', error); - // Handle the error. -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - The unique identifier for this screen, used internally and for telemetry. -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - Holds the specific screen data and properties, processed by ScreenOverride. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Sends the verification code to the user's phone via the selected method (SMS or Voice). Corresponds to the 'Continue' action in the OpenAPI definition (action: 'default'). - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Initiates the process for the user to select a different MFA authenticator. Corresponds to the 'Try Another Method' action in the OpenAPI definition (action: 'pick-authenticator'). - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-phone-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPushChallengePush.mdx deleted file mode 100644 index 43668c84d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPushChallengePush.mdx +++ /dev/null @@ -1,241 +0,0 @@ ---- -title: "ResetPasswordMfaPushChallengePush" -description: "Class representing the reset-password-mfa-push-challenge-push screen functionality This screen is shown when a push notification has been sent to the user's device during password reset" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React from 'react'; -import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; - -const ResetPasswordMfaPushChallengePushScreen: React.FC = () => { - const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); - const { deviceName } = resetPasswordMfaPushChallengePush.screen.data || {}; - const { screen, transaction } = resetPasswordMfaPushChallengePush - - - const handleContinue = async () => { - await resetPasswordMfaPushChallengePush.continue(); - }; - - const handleResend = async () => { - await resetPasswordMfaPushChallengePush.resendPushNotification(); - }; - - const handleEnterCodeManually = async () => { - await resetPasswordMfaPushChallengePush.enterCodeManually(); - }; - - const handleTryAnotherMethod = async () => { - await resetPasswordMfaPushChallengePush.tryAnotherMethod(); - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - { screen?.texts?.title ?? 'Verify Your Identity' } - </h2> - <p className="mt-3 text-center text-sm text-gray-600"> - { screen?.texts?.description ?? 'We\'ve sent a notification to the following device via Auth0 Guardian app.' + `Device: ${screen.data?.deviceName}` } - {deviceName && <span className="font-medium"> ({deviceName})</span>} - </p> - </div> - - <div className="mt-6 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <div className="space-y-4"> - <p className="text-center text-sm text-gray-500"> - Waiting for you to accept the push notification... - </p> - <div className="flex items-center justify-center"> - <div className="animate-spin rounded-full h-12 w-12 border-b-2 border-blue-500" /> - </div> - - <button - onClick={handleContinue} - className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 disabled:opacity-50" - > - { screen?.texts?.continueTextB2C ?? 'I\'ve responded on my device' } - </button> - - <button - onClick={handleResend} - className="w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 disabled:opacity-50" - > - { screen?.texts?.resendActionText ?? 'Resend Code Manually' } - </button> - - <button - onClick={handleEnterCodeManually} - className="w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 disabled:opacity-50" - > - { screen?.texts?.enterOtpCode ?? 'Enter Code Manually' } - </button> - - <button - onClick={handleTryAnotherMethod} - className="w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 disabled:opacity-50" - > - { screen?.texts?.tryAnotherMethod ?? 'Try Another Method' } - </button> - </div> - - {transaction?.errors?.length && ( - <div className="mt-2 mb-4"> - {transaction?.errors.map((err, index) => ( - <p key={index} className="text-red-500"> - {err.message} - </p> - ))} - </div> - )} - </div> - </div> - </div> - ); -}; - -export default ResetPasswordMfaPushChallengePushScreen; -``` - -```typescript Continue (Poll for Push Notification Acceptance) lines -import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; - -const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); - -// Poll for push notification acceptance -const pollInterval = setInterval(async () => { - try { - await resetPasswordMfaPushChallengePush.continue(); - // If successful, the page will redirect - clearInterval(pollInterval); - } catch (error) { - // Ignore polling errors - } -}, 5000); -``` - -```typescript Resend Push Notification lines -import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; - -const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); -resetPasswordMfaPushChallengePush.resendPushNotification(); -``` - -```typescript Enter Code Manually lines -import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; - -const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); -resetPasswordMfaPushChallengePush.enterCodeManually(); -``` - -```typescript Try Another Method lines -import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; - -const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); -resetPasswordMfaPushChallengePush.tryAnotherMethod(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Continues with the push notification challenge - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendPushNotification" type={<span>Promise<void></span>}> - Re-sends the push notification - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="enterCodeManually" type={<span>Promise<void></span>}> - Switches to entering the verification code manually - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows trying another authentication method - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="pollingManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> - Starts and manages polling for an MFA push challenge. Creates a polling session that repeatedly checks the MFA push challenge endpoint at the specified interval until the challenge is approved or an error occurs. When the approval condition is met, the provided callback is invoked and polling stops automatically. Use the returned to start, stop, or check the status of the polling process at any time. - - <Expandable title="parameters"> - <ParamField path="options" type={<span>MfaPollingOptions</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-push-challenge-push/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx deleted file mode 100644 index 08c88b2a9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx +++ /dev/null @@ -1,177 +0,0 @@ ---- -title: "ResetPasswordMfaRecoveryCodeChallenge" -description: "Class implementing the Reset Password MFA Recovery Code Challenge screen functionality." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState } from 'react'; -import ResetPasswordMfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/reset-password-mfa-recovery-code-challenge'; - -const ResetPasswordMfaRecoveryCodeChallengeScreen: React.FC = () => { - const [code, setCode] = useState(''); - const resetPasswordMfaRecoveryCodeChallengeManager = new ResetPasswordMfaRecoveryCodeChallenge(); - const { screen, transaction: { errors } } = resetPasswordMfaRecoveryCodeChallengeManager; - const texts = screen.texts ?? {}; - - const handleSubmit = async () => { - try { - await resetPasswordMfaRecoveryCodeChallengeManager.continue(code); - } catch (error) { - console.error('Failed to submit recovery code:', error); - } - }; - - const handleTryAnotherMethod = async () => { - try { - await resetPasswordMfaRecoveryCodeChallengeManager.tryAnotherMethod(); - } catch (error) { - console.error('Failed to try another method:', error); - } - }; - - return ( - <div className="flex flex-col items-center min-h-screen bg-gray-100 p-4"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 w-full max-w-md"> - <h2 className="text-2xl font-bold mb-4 text-center"> - {texts.title ?? 'Enter Recovery Code'} - </h2> - <p className="text-sm text-gray-700 mb-4 text-center"> - {texts.description ?? 'Please enter the recovery code from your authenticator app.'} - </p> - - <input - className="shadow appearance-none border rounded w-full py-2 px-3 text-gray-700 leading-tight focus:outline-none focus:shadow-outline mb-3" - id="code" - type="text" - placeholder={texts.placeholder ?? 'Enter your recovery code'} - value={code} - onChange={(e) => setCode(e.target.value)} - /> - - {errors?.length && ( - <div className="mb-4 space-y-1"> - {errors.map((err, index) => ( - <p key={index} className="text-red-600 text-sm"> - {err.message} - </p> - ))} - </div> - )} - - <button - className="w-full bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline mb-4" - type="button" - onClick={handleSubmit} - > - {texts.buttonText ?? 'Continue'} - </button> - - <button - className="text-blue-600 hover:underline text-sm text-center w-full" - type="button" - onClick={handleTryAnotherMethod} - > - {texts.pickAuthenticatorText ?? 'Try another method'} - </button> - </div> - </div> - ); -}; - -export default ResetPasswordMfaRecoveryCodeChallengeScreen; -``` - -```typescript Continue with Code lines -import ResetPasswordMfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/reset-password-mfa-recovery-code-challenge'; - -const resetPasswordMfaRecoveryCodeChallenge = new ResetPasswordMfaRecoveryCodeChallenge(); - -resetPasswordMfaRecoveryCodeChallenge.continue('PJVLZM6MS8DP6JYRT97XYZM2'); -``` - -```typescript Try Another Method lines -import ResetPasswordMfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/reset-password-mfa-recovery-code-challenge'; - -const resetPasswordMfaRecoveryCodeChallenge = new ResetPasswordMfaRecoveryCodeChallenge(); - -resetPasswordMfaRecoveryCodeChallenge.tryAnotherMethod(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Continues with the provided recovery code. - - <Expandable title="parameters"> - <ParamField path="code" type={<span>string</span>} required> - </ParamField> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Navigates to the screen where the user can pick another MFA method. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-recovery-code-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaSmsChallenge.mdx deleted file mode 100644 index 41fd423a2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaSmsChallenge.mdx +++ /dev/null @@ -1,259 +0,0 @@ ---- -title: "ResetPasswordMfaSmsChallenge" -description: "This class provides methods to handle the reset-password-mfa-sms-challenge screen." ---- - -<RequestExample> - -```jsx React Component Example with TailwindCSS lines -import { useState, useMemo } from 'react'; -import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; - -const ResetPasswordMfaSmsChallengeScreen = () => { - const resetPasswordMfaSmsChallenge = useMemo(() => new ResetPasswordMfaSmsChallenge(), []); - const [code, setCode] = useState(''); - const [disabled, setDisabled] = useState(false); - const [remainingSeconds, setRemainingSeconds] = useState(0); - - const { screen, transaction } = resetPasswordMfaSmsChallenge; - - function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { - setDisabled(isDisabled); - setRemainingSeconds(remainingSeconds); - } - - function handleTimeout() { - console.log('Resend timeout completed'); - } - - const resendManager = useMemo( - () => - resetPasswordMfaSmsChallenge.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleTimeout, - }), - [resetPasswordMfaSmsChallenge] - ); - - const { startResend } = resendManager; - - const handleSubmit = async (e: React.FormEvent) => { - e.preventDefault(); - await resetPasswordMfaSmsChallenge.continueMfaSmsChallenge({ - code, - }); - }; - - const handleResendCode = async () => { - try { - await startResend(); - } catch (error) { - console.error('Failed to resend code:', error); - } - }; - - const handleTryAnotherMethod = async () => { - await resetPasswordMfaSmsChallenge.tryAnotherMethod(); - }; - - const handleGetACall = async () => { - try { - await resetPasswordMfaSmsChallenge.getACall(); - } catch (error) { - console.error('Get a call failed:', error); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - { screen?.texts?.title ?? 'Verify Your Identity' } - </h2> - <p className="mt-4"> - { screen?.texts?.description ?? 'Enter the code sent to your phone number' + screen.data?.phoneNumber } - </p> - </div> - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label htmlFor="code" className="block text-sm font-medium text-gray-700"> - { screen?.texts?.placeholder ?? 'Enter the 6-digit code' } - </label> - <div className="mt-1"> - <input - id="code" - name="code" - type="text" - placeholder={ screen?.texts?.placeholder ?? 'Enter the 6-digit code' } - required - value={code} - onChange={(e) => setCode(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - - <div> - <button - type="submit" - className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - { screen?.texts?.buttonText ?? 'Continue' } - </button> - </div> - - {transaction?.errors?.length && ( - <div className="mt-2 mb-4"> - {transaction?.errors.map((err, index) => ( - <p key={index} className="text-red-500"> - {err.message} - </p> - ))} - </div> - )} - </form> - - <div className="mt-6"> - <button - onClick={handleResendCode} - disabled={disabled} - className={`w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium mt-2 ${ - disabled - ? "text-gray-400 bg-gray-100 cursor-not-allowed" - : "text-gray-700 bg-white hover:bg-gray-50" - }`} - > - {disabled - ? `${screen?.texts?.resendActionText ?? 'Resend Code'} (${remainingSeconds}s)` - : screen?.texts?.resendActionText ?? 'Resend Code' - } - </button> - <button - onClick={handleTryAnotherMethod} - className="w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 mt-2" - > - { screen?.texts?.pickAuthenticatorText ?? 'Try Another Method' } - </button> - { screen.data?.showLinkVoice && ( - <button - onClick={handleGetACall} - className="w-full flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50 mt-2" - > - { screen?.texts?.resendVoiceActionText ?? 'Get a Call' } - </button> - )} - </div> - </div> - </div> - </div> - ); -}; - -export default ResetPasswordMfaSmsChallengeScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continueMfaSmsChallenge" type={<span>Promise<void></span>}> - Submits the MFA SMS challenge with the provided code. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions">MfaSmsChallengeOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>}> - Submits the action to resend the SMS code. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Submits the action to try another MFA method. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getACall" type={<span>Promise<void></span>}> - Submits the action to switch to voice call verification. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> - Gets resend functionality with timeout management for this screen - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-sms-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaVoiceChallenge.mdx deleted file mode 100644 index 6b6d4e286..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaVoiceChallenge.mdx +++ /dev/null @@ -1,301 +0,0 @@ ---- -title: "ResetPasswordMfaVoiceChallenge" -description: "Class implementing the reset-password-mfa-voice-challenge screen functionality." ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState, useMemo } from 'react'; -import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge'; - -const ResetPasswordMfaVoiceChallengeScreen: React.FC = () => { - const [code, setCode] = useState(''); - const [showLinkSms, setShowLinkSms] = useState(false); - const [disabled, setDisabled] = useState(false); - const [remainingSeconds, setRemainingSeconds] = useState(0); - - const resetPasswordMfaVoiceChallenge = useMemo(() => new ResetPasswordMfaVoiceChallenge(), []); - - const { screen, transaction } = resetPasswordMfaVoiceChallenge; - const texts = screen?.texts ?? {}; - - function handleStatusChange(remainingSeconds: number, isDisabled: boolean) { - setDisabled(isDisabled); - setRemainingSeconds(remainingSeconds); - } - - function handleTimeout() { - console.log('Resend timeout completed'); - } - - const resendManager = useMemo( - () => - resetPasswordMfaVoiceChallenge.resendManager({ - timeoutSeconds: 15, - onStatusChange: handleStatusChange, - onTimeout: handleTimeout, - }), - [resetPasswordMfaVoiceChallenge] - ); - - const { startResend } = resendManager; - - // Initialize state from screen data - React.useEffect(() => { - if (screen?.data?.showLinkSms !== undefined) { - setShowLinkSms(screen.data.showLinkSms); - } - }, [screen?.data]); - - const handleSubmit = async (e: React.FormEvent) => { - e.preventDefault(); - try { - await resetPasswordMfaVoiceChallenge.continue({ code }); - } catch (error) { - console.error('Submit error:', error); - } - }; - - const handleSwitchToSms = async () => { - try { - await resetPasswordMfaVoiceChallenge.switchToSms(); - } catch (error) { - console.error('Switch to SMS failed:', error); - } - }; - - const handleResendCode = async () => { - try { - await startResend(); - } catch (error) { - console.error('Failed to resend code:', error); - } - }; - - const handleTryAnotherMethod = async () => { - try { - await resetPasswordMfaVoiceChallenge.tryAnotherMethod(); - } catch (error) { - console.error('Try another method failed:', error); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col items-center p-4"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 w-full max-w-md"> - <h2 className="text-2xl font-bold mb-4 text-center"> - {texts.title ?? 'Verify Your Identity'} - </h2> - <p className="text-sm text-gray-700 mb-4 text-center"> - {texts.description ?? `Enter the code sent to your phone number ending in ${screen?.data?.phoneNumber}`} - </p> - - <form onSubmit={handleSubmit}> - <input - id="code" - name="code" - type="text" - required - placeholder={texts.placeholder ?? 'Enter your code'} - value={code} - onChange={(e) => setCode(e.target.value)} - className="mb-3 shadow appearance-none border rounded w-full py-2 px-3 text-gray-700 leading-tight focus:outline-none focus:shadow-outline" - /> - - {transaction?.errors?.length && ( - <div className="mb-4 space-y-1"> - {transaction.errors.map((err, index) => ( - <p key={index} className="text-red-600 text-sm"> - {err.message} - </p> - ))} - </div> - )} - - <button - type="submit" - className="w-full bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded focus:outline-none focus:shadow-outline mb-4" - > - {texts.buttonText ?? 'Verify Code'} - </button> - </form> - - <div className="flex flex-col space-y-2 text-sm text-center"> - <button - onClick={handleResendCode} - disabled={disabled} - className={`${ - disabled - ? "text-gray-400 cursor-not-allowed" - : "text-blue-600 hover:underline" - }`} - type="button" - > - {disabled - ? `${texts.resendActionText ?? 'Call Again'} (${remainingSeconds}s)` - : texts.resendActionText ?? 'Call Again' - } - </button> - - {showLinkSms && ( - <button - onClick={handleSwitchToSms} - className="text-blue-600 hover:underline" - type="button" - > - {texts.resendSmsActionText ?? 'Send a text'} - </button> - )} - - <button - onClick={handleTryAnotherMethod} - className="text-blue-600 hover:underline" - type="button" - > - {texts.pickAuthenticatorText ?? 'Try another method'} - </button> - </div> - </div> - </div> - ); -}; - -export default ResetPasswordMfaVoiceChallengeScreen; -``` - -```typescript Continue with Code lines -import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge'; - -const resetPasswordMfaVoiceChallenge = new ResetPasswordMfaVoiceChallenge(); - -resetPasswordMfaVoiceChallenge.continue({ - code: '123456', -}); -``` - -```typescript Switch to SMS lines -import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge'; - -const resetPasswordMfaVoiceChallenge = new ResetPasswordMfaVoiceChallenge(); - -resetPasswordMfaVoiceChallenge.switchToSms(); -``` - -```typescript Resend Code lines -import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge'; - -const resetPasswordMfaVoiceChallenge = new ResetPasswordMfaVoiceChallenge(); - -resetPasswordMfaVoiceChallenge.resendCode(); -``` - -```typescript Try Another Method lines -import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge'; - -const resetPasswordMfaVoiceChallenge = new ResetPasswordMfaVoiceChallenge(); - -resetPasswordMfaVoiceChallenge.tryAnotherMethod(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continue" type={<span>Promise<void></span>}> - Continues with the voice challenge using the provided code. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions">ContinueOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="switchToSms" type={<span>Promise<void></span>}> - Switches to SMS verification. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>}> - Resends the code via voice call. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows the user to try another MFA method. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> - Gets resend functionality with timeout management for this screen - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-voice-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx deleted file mode 100644 index 4f40f9894..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "ResetPasswordMfaWebAuthnPlatformChallenge" -description: "" ---- - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - static -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - Holds the specific screen data and properties for this screen, processed by `ScreenOverride`. This includes `publicKey` (for the WebAuthn challenge) and `showRememberDevice`. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="continueWithPasskey" type={<span>Promise<void></span>}> - Initiates the WebAuthn platform authenticator challenge by calling `navigator.credentials.get()` using the challenge options provided in `screen.publicKey`. If successful, it submits the resulting credential assertion to Auth0 with `action: "default"`. - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithPasskeyOptions">ContinueWithPasskeyOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="reportBrowserError" type={<span>Promise<void></span>}> - Reports a browser-side error that occurred during the `navigator.credentials.get()` API call. This is used to inform Auth0 about issues like user cancellation (`NotAllowedError`), timeout, or other WebAuthn API specific errors. It submits the error details with `action: "showError::"`. - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions">ReportBrowserErrorOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows the user to opt-out of the WebAuthn platform authenticator challenge and select a different MFA method for verifying their identity during password reset. This action submits `action: "pick-authenticator"` to Auth0, which should navigate the user to an MFA factor selection screen. - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx deleted file mode 100644 index 8cde2492c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "ResetPasswordMfaWebAuthnRoamingChallenge" -description: "" ---- - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> - The unique identifier for this screen, used for internal SDK logic and telemetry. -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> - Holds the specific screen data and properties for this screen, (for the WebAuthn challenge) and `showRememberDevice`. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="useSecurityKey" type={<span>Promise<void></span>}> - Initiates the WebAuthn security key challenge. This method internally calls `navigator.credentials.get()` using the challenge options provided in `this.screen.publicKey`. If the user successfully authenticates with their security key, the resulting `PublicKeyCredential` is stringified and submitted to Auth0 with `action: "default"`. - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UseSecurityKeyOptions">UseSecurityKeyOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="showError" type={<span>Promise<void></span>}> - Reports a client-side WebAuthn API error (from `navigator.credentials.get()`) to Auth0. This method is intended to be called when (or a direct call to `navigator.credentials.get()`) fails due to a standard WebAuthn API error (e.g., `NotAllowedError` if the user cancels, `NotFoundError`, `SecurityError`, timeout). It submits the error details with `action: "showError::"` and an empty `response`. - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions">ShowErrorOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>}> - Allows the user to opt-out of the WebAuthn roaming authenticator challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate the user to an MFA factor selection screen. - - <Expandable title="parameters"> - <ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions">TryAnotherMethodOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordRequest.mdx deleted file mode 100644 index 1ae7bff09..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordRequest.mdx +++ /dev/null @@ -1,144 +0,0 @@ ---- -title: "ResetPasswordRequest" -description: "" ---- - -<RequestExample> - -```jsx React Component Example with TailwindCSS lines -import React, { useState } from 'react'; -import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request'; - -const ResetPasswordRequestScreen = () => { - const [username, setUsername] = useState(''); - const resetPasswordRequest = new ResetPasswordRequest(); - - const handleSubmit = async (e: React.FormEvent) => { - e.preventDefault(); - await resetPasswordRequest.resetPassword({ username }); - }; - - return ( - <div className="w-[100vw] min-h-screen bg-gray-100 flex items-center justify-center p-4"> - <div className="w-full max-w-md"> - <h2 className="text-3xl font-bold text-center mb-8"> - Reset your password - </h2> - - <div className="bg-white p-8 rounded-lg shadow"> - <form onSubmit={handleSubmit} className="space-y-6"> - <div> - <label htmlFor="username" className="text-sm font-medium text-gray-700"> - Username - </label> - <input - id="username" - type="text" - required - value={username} - onChange={(e) => setUsername(e.target.value)} - className="mt-1 w-full p-2 border rounded-md focus:ring-2 focus:ring-blue-500" - placeholder="Enter your username" - /> - </div> - <div className="space-y-3"> - <button - type="submit" - className="w-full py-2 px-4 bg-blue-600 text-gray-700 rounded-md hover:bg-blue-700" - > - Continue - </button> - - <button - type="button" - onClick={() => resetPasswordRequest?.backToLogin()} - className="w-full py-2 px-4 border text-gray-700 rounded-md hover:bg-gray-50" - > - Back to Login - </button> - </div> - </form> - </div> - </div> - </div> - ); -}; - -export default ResetPasswordRequestScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="transaction" type={<span>TransactionOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="resetPassword" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions">ResetPasswordRequestOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="backToLogin" type={<span>Promise<void></span>}> - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions">CustomOptions</a></span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getLoginIdentifiers" type={<span>IdentifierType[] | null</span>}> - Gets the active identifier types for the reset-password-request screen - -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/reset-password-request/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-request/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordSuccess.mdx deleted file mode 100644 index 03d310d67..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordSuccess.mdx +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: "ResetPasswordSuccess" -description: "" ---- - -<RequestExample> - -```typescript React Component Example with TailwindCSS lines -import React from 'react'; -import ResetPasswordSuccess from '@auth0/auth0-acul-js/reset-password-success'; - -const ResetPasswordSuccessComponent: React.FC = () => { - const resetPasswordSuccessManager = new ResetPasswordSuccess(); - const { screen } = resetPasswordSuccessManager; - const data = screen.texts?.description; - - return ( - <div className="w-[100vw] flex flex-col items-center justify-center min-h-screen bg-gray-100"> - <div className="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4 flex flex-col"> - <h2 className="text-2xl font-bold mb-6">Reset Password Success Screen</h2> - {data && ( - <div className="mb-4"> - <p>Message: {data}</p> - </div> - )} - </div> - </div> - ); -}; - -export default ResetPasswordSuccessComponent; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/reset-password-success/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-success/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SDKUsageError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SDKUsageError.mdx deleted file mode 100644 index 733c36707..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SDKUsageError.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "SDKUsageError" -description: "" ---- - -## Properties - -<ParamField path="code" type={<span>any</span>} required> -</ParamField> - -<ParamField path="field" type={<span>string</span>}> -</ParamField> - ---- - -**File:** [src/utils/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Screen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Screen.mdx deleted file mode 100644 index 5263d92ba..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Screen.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "Screen" -description: "" ---- - -## Properties - -<ParamField path="name" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['name']</span>} required> - The name of the current screen -</ParamField> - -<ParamField path="captchaImage" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captchaImage']</span>} required> - URL to the captcha image if available -</ParamField> - -<ParamField path="captchaSiteKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captchaSiteKey']</span>} required> - The site key for captcha integration -</ParamField> - -<ParamField path="captchaProvider" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captchaProvider']</span>} required> - The provider of the captcha service -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['isCaptchaAvailable']</span>} required> - Indicates if captcha is available on this screen -</ParamField> - -<ParamField path="data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['data']</span>} required> - Screen-specific data for rendering or logic -</ParamField> - -<ParamField path="links" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['links']</span>} required> - Navigation links available on this screen -</ParamField> - -<ParamField path="texts" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['texts']</span>} required> - Text content for UI elements -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captcha']</span>} required> - Complete captcha configuration -</ParamField> - -## Methods - -<ParamField path="getScreenData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['data']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getScreenLinks" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['links']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [src/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride.mdx deleted file mode 100644 index 5ebda389c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "ScreenOverride" -description: "" ---- - -## Properties - -<ParamField path="loginLink" type={<span>OverrideOptions['loginLink']</span>} required> -</ParamField> - -<ParamField path="editLink" type={<span>OverrideOptions['editLink']</span>} required> -</ParamField> - -<ParamField path="data" type={<span>OverrideOptions['data']</span>} required> -</ParamField> - -<ParamField path="getScreenData" type={<span>any</span>} required> -</ParamField> - -<ParamField path="name" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['name']</span>} required> - The name of the current screen -</ParamField> - -<ParamField path="captchaImage" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captchaImage']</span>} required> - URL to the captcha image if available -</ParamField> - -<ParamField path="captchaSiteKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captchaSiteKey']</span>} required> - The site key for captcha integration -</ParamField> - -<ParamField path="captchaProvider" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captchaProvider']</span>} required> - The provider of the captcha service -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['isCaptchaAvailable']</span>} required> - Indicates if captcha is available on this screen -</ParamField> - -<ParamField path="links" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['links']</span>} required> - Navigation links available on this screen -</ParamField> - -<ParamField path="texts" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['texts']</span>} required> - Text content for UI elements -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['captcha']</span>} required> - Complete captcha configuration -</ParamField> - -## Methods - -<ParamField path="getScreenLinks" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a>['links']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [src/screens/signup-password/screen-override.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/signup-password/screen-override.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Signup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Signup.mdx deleted file mode 100644 index 294d4120b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Signup.mdx +++ /dev/null @@ -1,317 +0,0 @@ ---- -title: "Signup" -description: "" ---- - -<RequestExample> - -```tsx React Component Example with TailwindCSS lines -import React, { useState, useRef } from 'react'; -import LoginInstance from "@auth0/auth0-acul-js/signup"; -import { withWindowDebug } from "../../../utils"; -import { Logo } from '../../components/Logo'; -import { Title } from './components/Title'; -import { FederatedLogin } from './components/FederatedLogin'; -import { Links } from './components/Links'; -import { ErrorMessages } from './components/ErrorMessages'; -import Button from '../../components/Button'; - -const SignupScreen: React.FC = () => { - const [password, setPassword] = useState(''); - const [username, setUsername] = useState(''); - const [phone, setPhone] = useState(''); - const [ email, setEmail] = useState(''); - const [captcha, setCaptcha] = useState(''); - - // Initialize signupManager once - const [signupManager] = useState(() => new LoginInstance()); - - const identifiers = signupManager.getEnabledIdentifiers(); - - const {isValid, results} = signupManager.validatePassword(password); - - // Signup button click handler - const onSignupClick = () => { - if (!isValid) return; - - const options = { - username, - email, - phoneNumber, - password, - captcha: signupManager.screen.isCaptchaAvailable ? captcha : "", - }; - signupManager.signup(options); - }; - - // Social login handler - const handleSocialSignup = (connectionName: string) => { - signupManager.federatedSignup({ connection: connectionName }); - }; - - // JSX UI part (same as before) - return ( - <div className="prompt-container"> - <Logo /> - <Title screenTexts={signupManager.screen.texts!} /> - - <div className="input-container"> - {/* Country code button */} - <button className="pick-country-code hidden" id="pick-country-code"> - Pick country code - {signupManager.transaction.countryCode}: +{signupManager.transaction.countryPrefix} - </button> - - {/* Email input */} - {identifiers?.find((id) => id.type === 'email') && ( - <> - <label htmlFor="email"> - Enter your email{' '} - {identifiers.find((id) => id.type === 'email')?.required ? ( - <span className="text-red-500">*</span> - ) : ( - <span className="text-gray-500 text-sm">(optional)</span> - )} - </label> - <input - type="email" - id="email" - value={email} - onChange = {(e) => setEmail(e.target.value)} - placeholder="Enter your email" - required={identifiers.find((id) => id.type === 'email')?.required} - /> - </> - )} - - {/* Username input */} - {identifiers?.find((id) => id.type === 'username') && ( - <> - <label htmlFor="username"> - Enter your username{' '} - {identifiers.find((id) => id.type === 'username')?.required ? ( - <span className="text-red-500">*</span> - ) : ( - <span className="text-gray-500 text-sm">(optional)</span> - )} - </label> - <input - type="text" - id="username" - value={username} - onChange = {(e) => setUsername(e.target.value)} - placeholder="Enter your username" - required={identifiers.find((id) => id.type === 'username')?.required} - /> - </> - )} - - {/* Phone input */} - {identifiers?.find((id) => id.type === 'phone') && ( - <> - <label htmlFor="phoneNumber"> - Enter your phone number{' '} - {identifiers.find((id) => id.type === 'phone')?.required ? ( - <span className="text-red-500">*</span> - ) : ( - <span className="text-gray-500 text-sm">(optional)</span> - )} - </label> - <input - type="tel" - id="phoneNumber" - value={phone} - onChange = {(e) => setPhone(e.target.value)} - placeholder="Enter your phone number" - required={identifiers.find((id) => id.type === 'phone')?.required} - /> - </> - )} - - {/* Password input */} - <label htmlFor="password"> - Enter your password <span className="text-red-500">*</span> - </label> - <input - type="password" - id="password" - value={password} - placeholder="Enter your password" - aria-invalid={!isValid} - required - className={`input w-full border px-4 py-2 rounded ${ - !isValid ? 'border-red-500' : 'border-gray-300' - }`} - onChange={(e) => setPassword(e.target.value)} - /> - - {/* Password validation hints */} - {password.length > 0 && results.length > 0 && ( - <div className="mt-2 border border-gray-300 rounded p-2 text-sm"> - <p className="text-gray-700 mb-1">Your password must contain:</p> - <ul className="list-disc ml-4"> - {results.map((rule) => ( - <li - key={rule.code} - className={rule.status === 'valid' ? 'text-green-600' : 'text-gray-700'} - > - {rule.label} - {rule.items && rule.items.length > 0 && ( - <ul className="ml-5 list-disc"> - {rule.items.map((sub) => ( - <li - key={sub.code} - className={sub.status === 'valid' ? 'text-green-600' : 'text-gray-700'} - > - {sub.label} - </li> - ))} - </ul> - )} - </li> - ))} - </ul> - </div> - )} - - {/* Captcha input */} - {signupManager.screen.isCaptchaAvailable && ( - <div className="captcha-container"> - <img src={signupManager.screen.captchaImage ?? ''} alt="Captcha" /> - <label htmlFor="captcha">Enter the captcha</label> - <input - type="text" - id="captcha" - ref={captchaRef} - placeholder="Enter the captcha" - /> - </div> - )} - - {/* Signup button */} - <div className="button-container mt-4"> - <Button onClick={onSignupClick}>Continue</Button> - </div> - </div> - - {/* Social login buttons */} - <FederatedLogin - connections={signupManager.transaction.alternateConnections!} - onFederatedLogin={handleSocialSignup} - /> - - {/* Links */} - {signupManager.screen.links && ( - <Links loginLink={signupManager.screen.links.loginLink!} /> - )} - - {/* Error messages */} - {signupManager.transaction.hasErrors && signupManager.transaction.errors && ( - <ErrorMessages errors={signupManager.transaction.errors!} /> - )} - </div> - ); -}; - -export default SignupScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="transaction" type={<span>TransactionOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="signup" type={<span>Promise<void></span>}> - This method handles the submission of the signup form. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions">SignupOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="federatedSignup" type={<span>Promise<void></span>}> - This method is similar to the method but is used for social signups. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions">FederatedSignupOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="pickCountryCode" type={<span>Promise<void></span>}> -</ParamField> - -<ParamField path="validatePassword" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> - @param password - - <Expandable title="parameters"> - <ParamField path="password" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getSignupIdentifiers" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier">Identifier[]</a> | null</span>}> - Returns the list of enabled identifiers for the signup form, marking each as required or optional based on transaction config. - -</ParamField> - -<ParamField path="validateUsername" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}> - Validates a given username against the current username policy defined in the transaction context. - - <Expandable title="parameters"> - <ParamField path="username" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/signup/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/signup/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupId.mdx deleted file mode 100644 index bdb7903b3..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupId.mdx +++ /dev/null @@ -1,333 +0,0 @@ ---- -title: "SignupId" -description: "" ---- - -<RequestExample> - -```typescript signup lines -import SignupId from "@auth0/auth0-acul-js/signup-id"; - const signupIdManager = new SignupId(); - - //get mandatory & optional identifiers required for signup - const { transaction } = signupIdManager; - const mandatoryIdentifier = transaction.getRequiredIdentifiers(); // eg: email - const optionalIdentifiers = transaction.getOptionalIdentifiers() // eg: phone - - /* Based on mandatory & optional identifiers users can render corresponding field on signup-id screen */ - - const signupParams = { - email : "testEmail", - phone : "+91923456789" - } - - signupIdManager.signup(signupParams); -``` - -```typescript socialSignup lines -import SignupId from "@auth0/auth0-acul-js/signup-id"; - - const signupIdManager = new SignupId(); - const { transaction } = signupIdManager; - - //get social connections - const socialConnection = transaction.alternateConnections; //eg: "google-oauth2" - const signupParams = { - connection : socialConnection[0].name, // "google-oauth2" - }; - - signupIdManager.federatedSignup(signupParams); -``` - -```typescript signupId Example lines -import React, { useState, useEffect } from 'react'; -import SignupId from '@auth0/auth0-acul-js/signup-id'; -import { Logo } from '../../components/Logo'; -import Button from '../../components/Button'; - -const SignupIdScreen: React.FC = () => { - const [email, setEmail] = useState(''); - const [phone, setPhone] = useState(''); - const [username, setUsername] = useState(''); - const [error, setError] = useState(''); - const [success, setSuccess] = useState(false); - const [identifiers, setIdentifiers] = useState<Array<{ type: string; required: boolean }>>([]); - - const signupIdManager = new SignupId(); - - const title = signupIdManager.screen.texts?.title || ''; - const description = signupIdManager.screen.texts?.description || ''; - const federatedConnections = signupIdManager.transaction.alternateConnections ?? []; - const links = signupIdManager.screen.links ?? {}; - - const { isValid, errors } = signupIdManager.validateUsername(username); - - - useEffect(() => { - const enabledIds = signupIdManager.getSignupIdentifiers(); - setIdentifiers(enabledIds ?? []); - }, []); - - const handleSignup = async (e: React.FormEvent) => { - e.preventDefault(); - setError(''); - setSuccess(false); - - const emailRequired = identifiers.find((id) => id.type === 'email')?.required; - const phoneRequired = identifiers.find((id) => id.type === 'phone')?.required; - const usernameRequired = identifiers.find((id) => id.type === 'username')?.required; - - if (emailRequired && !email) { - setError('Email is required.'); - return; - } - if (phoneRequired && !phone) { - setError('Phone number is required.'); - return; - } - if (usernameRequired && !username) { - setError('Username is required.'); - return; - } - - if(!isValid){ - setError(errors[0].message); - return; - } - - try { - await signupIdManager.signup({ - email, - phone, - username, - }); - setSuccess(true); - } catch { - setError('Signup failed. Please try again later.'); - } - }; - - const handleFederatedSignup = (connectionName: string) => { - signupIdManager.federatedSignup({ connection: connectionName }); - }; - - return ( - <div className="prompt-container"> - <Logo /> - {/* Title Section */} - <div className="title-container"> - <h1 className="mt-6 text-center text-3xl font-extrabold text-gray-900">{title}</h1> - <div> - <p className="mt-2 text-center text-sm text-gray-600">{description}</p> - </div> - </div> - - {/* Form Section */} - <div className="input-container"> - <form onSubmit={handleSignup}> - {/* Email */} - {identifiers.find((id) => id.type === 'email') && ( - <div> - <label>Email {identifiers.find((id) => id.type === 'email')?.required && '*'}</label> - <input - type="email" - id="email" - placeholder="Enter your email" - value={email} - onChange={(e) => setEmail(e.target.value)} - className="input-field" - /> - </div> - )} - - {/* Phone */} - {identifiers.find((id) => id.type === 'phone') && ( - <div> - <label>Phone {identifiers.find((id) => id.type === 'phone')?.required && '*'}</label> - <input - type="tel" - id="phone" - placeholder="Enter your phone number" - value={phone} - onChange={(e) => setPhone(e.target.value)} - className="input-field" - /> - </div> - )} - - {/* Username */} - {identifiers.find((id) => id.type === 'username') && ( - <div> - <label>Username {identifiers.find((id) => id.type === 'username')?.required && '*'}</label> - <input - type="text" - id="username" - placeholder="Enter your username" - value={username} - onChange={(e) => setUsername(e.target.value)} - className={`input-field ${username && !isValid ? 'border-red-500' : 'border-gray-300' - }`} - /> - - {username.length > 0 && errors.length > 0 && ( - <ul className="mt-1 text-sm text-red-500"> - {errors.map((err, i) => ( - <li key={i}>{err.message}</li> - ))} - </ul> - )} - </div> - )} - - {/* Error & Success Messages */} - {error && ( - <div className="error-container"> - <p>{error}</p> - </div> - )} - {success && ( - <div className="success-message"> - Signup successful! Please check your email to verify your account. - </div> - )} - - {/* Submit Button */} - <div className="button-container"> - <Button onClick={() => handleSignup}> - Sign Up - </Button> - </div> - </form> - - {/* Login Link */} - {links?.login && ( - <div className="mt-6 text-center text-sm"> - <span> - Already have an account? - </span> - <a - href={links.loginLink} - className="text-indigo-600 hover:underline" - > - Log in - </a> - </div> - )} - {/* OR separator */} - <div className="flex items-center my-4"> - <div className="flex-1 border-t border-gray-300"></div> - <span className="px-3 text-sm text-gray-400">OR</span> - <div className="flex-1 border-t border-gray-300"></div> - </div> - - {/* Google login */} - {federatedConnections.length > 0 && federatedConnections.map((conn: any) => ( - <button - key={conn.name} - onClick={() => handleFederatedSignup(conn.name)} - className="w-full flex items-center justify-center gap-2 rounded-md border border-gray-300 bg-white px-4 py-2 text-sm font-medium text-gray-700 hover:bg-gray-50" - > - {/* <img src="/google-icon.svg" alt="" className="h-4 w-4" /> */} - Continue with {conn.options?.display_name || conn.name} - </button> - ))} - - </div> - </div> - ); -}; - -export default SignupIdScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="transaction" type={<span>TransactionOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="signup" type={<span>Promise<void></span>}> - This methods handles signup-id related configuration. It allows to signup new users via different identifiers. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions">SignupOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="federatedSignup" type={<span>Promise<void></span>}> - This methods handles allows signup via different social identifiers. Eg: Google, Facebook etc. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions">FederatedSignupOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getSignupIdentifiers" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier">Identifier[]</a> | null</span>}> - Returns the list of enabled identifiers for the signup-id form, marking each as required or optional based on transaction config. - -</ParamField> - -<ParamField path="pickCountryCode" type={<span>Promise<void></span>}> -</ParamField> - -<ParamField path="validateUsername" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}> - Validates a given username against the current username policy defined in the transaction context. - - <Expandable title="parameters"> - <ParamField path="username" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/signup-id/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/signup-id/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupPassword.mdx deleted file mode 100644 index 9d1be6f37..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupPassword.mdx +++ /dev/null @@ -1,281 +0,0 @@ ---- -title: "SignupPassword" -description: "" ---- - -<RequestExample> - -```typescript signup lines -import SignupPassword from "@auth0/auth0-acul-js/signup-password"; - - const signupPasswordManager = new SignupPassword(); - const { transaction, screen } = signupPasswordManager; - - //get mandatory & optional identifiers required for signup-password screen to proceed - const mandatoryIdentifier = transaction.getRequiredIdentifiers(); //eg: email - const optionalIdentifiers = transaction.getOptionalIdentifiers() //eg: phone - - //get signup data submitted on previous screen from previous screen - const data = screen.data; //eg: email, phone - - - const signupParams = { - email : data.email, - phone : data.phone_number, - password : "********" - }; - - signupPasswordManager.signup(signupParams); -``` - -```typescript signupPassword Example using validatePassword lines -import React, { useState } from 'react'; -import SignupPassword from '@auth0/auth0-acul-js/signup-password'; -import { Logo } from '../../components/Logo'; -import Button from '../../components/Button'; - -const SignupPasswordScreen: React.FC = () => { - const [password, setPassword] = useState(''); - const [error, setError] = useState(''); - const [success, setSuccess] = useState(false); - - const signupPasswordManager = new SignupPassword(); - - const email = signupPasswordManager.screen.data?.email || ''; - const phone = signupPasswordManager.screen.data?.phoneNumber || ''; - const username = signupPasswordManager.screen.data?.username || ''; - - const title = signupPasswordManager.screen.texts?.title || ''; - const description = signupPasswordManager.screen.texts?.description || ''; - - const { isValid, results } = signupPasswordManager.validatePassword(password); - - const handleSignup = async (e: React.FormEvent) => { - e.preventDefault(); - setError(''); - setSuccess(false); - - if (!email || !password) { - setError('Email and password are required.'); - return; - } - - if (!isValid) return; - - try { - await signupPasswordManager.signup({ email, username, phone, password }); - setSuccess(true); - } catch { - setError('Signup failed. Please try again later.'); - } - }; - - return ( - <div className="prompt-container"> - <Logo /> - - {/* Title Section (inline, not imported) */} - <div className="title-container"> - <h1 className="mt-6 text-center text-3xl font-extrabold text-gray-900">{title}</h1> - <div> - <p className="mt-2 text-center text-sm text-gray-600">{description}</p> - </div> - </div> - - {/* Form */} - <div className="input-container"> - <form onSubmit={handleSignup}> - {email && ( - <div> - <label>Email</label> - <input - type="email" - id="email" - placeholder="Enter your email" - value={email} - disabled - /> - </div> - )} - - - {username && ( - <div> - <label>Username</label> - <input - type="text" - id="username" - placeholder="Enter your username" - value={username} - disabled - /> - </div> - )} - - { - phone && ( - <div> - <label>Phone</label> - <input - type="tel" - id="phone" - placeholder="Enter your phone number" - value={phone} - disabled - /> - </div> - ) - } - - - - <label>Password</label> - <input - type="password" - id="password" - placeholder="Enter your password" - value={password} - onChange={(e) => setPassword(e.target.value)} - className={!isValid && password.length > 0 ? 'error' : ''} - /> - - {/* Password Validation Rules */} - - {password.length > 0 && results.length > 0 && ( - <div className="mt-2 border border-gray-300 rounded p-2 text-sm"> - <p className="text-gray-700 mb-1">Your password must contain:</p> - <ul className="list-disc ml-4"> - {results.map((rule) => ( - <li - key={rule.code} - className={rule.status === 'valid' ? 'text-green-600' : 'text-gray-700'} - > - {rule.label} - {rule.items && rule.items.length > 0 && ( - <ul className="ml-5 list-disc"> - {rule.items.map((sub) => ( - <li - key={sub.code} - className={sub.status === 'valid' ? 'text-green-600' : 'text-gray-700'} - > - {sub.label} - </li> - ))} - </ul> - )} - </li> - ))} - </ul> - </div> - )} - {/* Error & Success messages */} - {error && ( - <div className="error-container"> - <p>{error}</p> - </div> - )} - - {success && ( - <div className="success-message"> - Signup successful! Please check your email to verify your account. - </div> - )} - - {/* Submit Button */} - <div className="button-container"> - <Button onClick={() => handleSignup}> - Sign Up - </Button> - </div> - </form> - </div> - </div> - ); -}; - -export default SignupPasswordScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="screen" type={<span>ScreenOptions</span>} required> -</ParamField> - -<ParamField path="transaction" type={<span>TransactionOptions</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - -<ParamField path="context" type={<span>UniversalLoginContext | null</span>}> -</ParamField> - -## Methods - -<ParamField path="signup" type={<span>Promise<void></span>}> - This methods handles signup-password related screen configuration. It allows to proceed with registering signup password along with signup identifiers passed in previous screen - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordOptions">SignupPasswordOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="federatedSignup" type={<span>Promise<void></span>}> - This methods handles allows signup via different social identifiers. Eg: Google, Facebook etc. - - <Expandable title="parameters"> - <ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions">FederatedSignupOptions</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="validatePassword" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> - Validates a password string against the current transaction's password policy. This method retrieves the password policy from the current transaction context and delegates the actual validation to `coreValidatePassword`. It returns an array of validation results, each containing: - `code`: the identifier of the password rule, - `policy`: a user-friendly description of the rule, - `isValid`: boolean indicating if the password passed that rule. - - <Expandable title="parameters"> - <ParamField path="password" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getContext" type={<span>UniversalLoginContext[K] | undefined</span>}> - Retrieves a specific part of the Universal Login Context. - - <Expandable title="parameters"> - <ParamField path="model" type={<span>K</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span>TransactionError[]</span>}> - Retrieves the array of transaction errors from the context, or an empty array if none exist. - -</ParamField> - ---- - -**File:** [src/screens/signup-password/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/signup-password/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Tenant.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Tenant.mdx deleted file mode 100644 index 25b3fbe58..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Tenant.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Tenant" -description: "" ---- - -## Properties - -<ParamField path="name" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a>['name']</span>} required> - The name of the tenant -</ParamField> - -<ParamField path="friendlyName" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a>['friendlyName']</span>} required> - The display name of the tenant -</ParamField> - -<ParamField path="enabledLocales" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a>['enabledLocales']</span>} required> - List of locales enabled for the tenant -</ParamField> - -<ParamField path="enabledFactors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a>['enabledFactors']</span>} required> - List of MFA factors enabled for the tenant -</ParamField> - ---- - -**File:** [src/models/tenant.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/tenant.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Transaction.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Transaction.mdx deleted file mode 100644 index dd646d239..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Transaction.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "Transaction" -description: "" ---- - -## Properties - -<ParamField path="state" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['state']</span>} required> - The current state of the authentication transaction -</ParamField> - -<ParamField path="hasErrors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['hasErrors']</span>} required> - Indicates if the transaction has errors -</ParamField> - -<ParamField path="locale" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['locale']</span>} required> - The current locale for the transaction -</ParamField> - -<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['countryCode']</span>} required> - The country code if available -</ParamField> - -<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['countryCode']</span>} required> - The phone prefix for the country -</ParamField> - -<ParamField path="connectionStrategy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['connectionStrategy']</span>} required> - The strategy of the current connection -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['errors']</span>} required> - List of errors in the transaction -</ParamField> - -<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['currentConnection']</span>} required> - The connection being used -</ParamField> - -<ParamField path="alternateConnections" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['alternateConnections']</span>} required> - Other available connections -</ParamField> - -## Methods - -<ParamField path="getErrors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['errors']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getCurrentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['currentConnection']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getAlternateConnections" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['alternateConnections']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [src/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride.mdx deleted file mode 100644 index cafeb7187..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride.mdx +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: "TransactionOverride" -description: "" ---- - -## Properties - -<ParamField path="isPasskeyEnabled" type={<span>OverrideOptions['isPasskeyEnabled']</span>} required> -</ParamField> - -<ParamField path="passwordPolicy" type={<span>OverrideOptions['passwordPolicy']</span>} required> -</ParamField> - -<ParamField path="optionalIdentifiers" type={<span>OverrideOptions['optionalIdentifiers']</span>} required> -</ParamField> - -<ParamField path="requiredIdentifiers" type={<span>OverrideOptions['requiredIdentifiers']</span>} required> -</ParamField> - -<ParamField path="state" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['state']</span>} required> - The current state of the authentication transaction -</ParamField> - -<ParamField path="hasErrors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['hasErrors']</span>} required> - Indicates if the transaction has errors -</ParamField> - -<ParamField path="locale" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['locale']</span>} required> - The current locale for the transaction -</ParamField> - -<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['countryCode']</span>} required> - The country code if available -</ParamField> - -<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['countryCode']</span>} required> - The phone prefix for the country -</ParamField> - -<ParamField path="connectionStrategy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['connectionStrategy']</span>} required> - The strategy of the current connection -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['errors']</span>} required> - List of errors in the transaction -</ParamField> - -<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['currentConnection']</span>} required> - The connection being used -</ParamField> - -<ParamField path="alternateConnections" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['alternateConnections']</span>} required> - Other available connections -</ParamField> - -## Methods - -<ParamField path="getRequiredIdentifiers" type={<span>OverrideOptions['requiredIdentifiers']</span>}> - <Expandable title="parameters"> - <ParamField path="transactionContext" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> - </ParamField> - <ParamField path="connectionStrategy" type={<span>string | null</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getErrors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['errors']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getCurrentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['currentConnection']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getAlternateConnections" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a>['alternateConnections']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [src/screens/signup-password/transaction-override.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/signup-password/transaction-override.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedData.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedData.mdx deleted file mode 100644 index cc6b1f152..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedData.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "UntrustedData" -description: "" ---- - -## Properties - -<ParamField path="submittedFormData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>['submittedFormData']</span>} required> - Form data submitted by the user -</ParamField> - -<ParamField path="authorizationParams" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>['authorizationParams']</span>} required> - Authorization parameters from the request -</ParamField> - -## Methods - -<ParamField path="getSubmittedFormData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>['submittedFormData']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a> | undefined</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getAuthorizationParams" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>['authorizationParams']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a> | undefined</span>}> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [src/models/untrusted-data.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/untrusted-data.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride.mdx deleted file mode 100644 index 005a43aea..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "UntrustedDataOverride" -description: "Untrusted data override class for the mfa-voice-challenge screen Handles remember_device field from submitted form data" ---- - -## Properties - -<ParamField path="submittedFormData" type={<span>OverrideOptions['submittedFormData']</span>} required> -</ParamField> - -<ParamField path="authorizationParams" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>['authorizationParams']</span>} required> - Authorization parameters from the request -</ParamField> - -## Methods - -<ParamField path="getSubmittedFormData" type={<span>OverrideOptions['submittedFormData']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="untrustedDataContext" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="getAuthorizationParams" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a>['authorizationParams']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a> | undefined</span>}> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [src/screens/mfa-voice-challenge/untrusted-data-overrider.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/mfa-voice-challenge/untrusted-data-overrider.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/User.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/User.mdx deleted file mode 100644 index 3bbb70ee7..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/User.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "User" -description: "" ---- - -## Properties - -<ParamField path="id" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['id']</span>} required> - The unique identifier of the user -</ParamField> - -<ParamField path="username" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['username']</span>} required> - The username of the user -</ParamField> - -<ParamField path="email" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['email']</span>} required> - The email address of the user -</ParamField> - -<ParamField path="picture" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['picture']</span>} required> - URL to the user's profile picture -</ParamField> - -<ParamField path="phoneNumber" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['phoneNumber']</span>} required> - The phone number of the user -</ParamField> - -<ParamField path="userMetadata" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['userMetadata']</span>} required> - @property | null} userMetadata - User-specific metadata that can be modified -</ParamField> - -<ParamField path="appMetadata" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['appMetadata']</span>} required> - @property | null} appMetadata - Application-specific metadata about the user -</ParamField> - -<ParamField path="enrolledFactors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['enrolledFactors']</span>} required> - List of MFA factors the user has enrolled in -</ParamField> - -<ParamField path="enrolledEmails" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['enrolledEmails']</span>} required> - List of emails the user has enrolled for MFA -</ParamField> - -<ParamField path="enrolledPhoneNumbers" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['enrolledPhoneNumbers']</span>} required> - List of phone numbers the user has enrolled for MFA -</ParamField> - -<ParamField path="enrolledDevices" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['enrolledDevices']</span>} required> - List of devices the user has enrolled for MFA -</ParamField> - -<ParamField path="organizations" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['organizations']</span>} required> - @property | undefined}> | null} organizations - Organizations the user belongs to -</ParamField> - -## Methods - -<ParamField path="getOrganizations" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a>['organizations']</span>}> - @static - - <Expandable title="parameters"> - <ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [src/models/user.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/models/user.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UserInputError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UserInputError.mdx deleted file mode 100644 index 3a28771eb..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UserInputError.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "UserInputError" -description: "" ---- - -## Properties - -<ParamField path="code" type={<span>any</span>} required> -</ParamField> - -<ParamField path="field" type={<span>string</span>}> -</ParamField> - ---- - -**File:** [src/utils/errors.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/errors.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/base64UrlToUint8Array.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/base64UrlToUint8Array.mdx deleted file mode 100644 index cfd3e4a0a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/base64UrlToUint8Array.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "base64UrlToUint8Array" -description: "" ---- - -## Parameters - -<ParamField path="base64Url" type={<span>string</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>ArrayBuffer</span>}> -</ParamField> - ---- - -**File:** [src/utils/codec.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/codec.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPasskeyCredentials.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPasskeyCredentials.mdx deleted file mode 100644 index 37ccf1572..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPasskeyCredentials.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "createPasskeyCredentials" -description: "" ---- - -## Parameters - -<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>['public_key']</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>Promise<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreateResponse">PasskeyCreateResponse</a>></span>}> -</ParamField> - ---- - -**File:** [src/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPollingControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPollingControl.mdx deleted file mode 100644 index 12535f5f5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPollingControl.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "createPollingControl" -description: "Starts polling the MFA push challenge endpoint using XHR GET requests. - Polls the given URL (or current page URL if not provided) at the specified interval. - Calls the `condition` function with the response body to determine if polling should stop. - If the condition is met, calls `onCompleted` and stops polling. - Handles rate limiting (HTTP 429) by waiting until the rate limit resets. - Calls `onError` if a non-200/429 response is received. - Returns a cancel function to stop polling." ---- - -## Parameters - -<ParamField path="options" type={<span>MfaPollingOptions</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> -</ParamField> - ---- - -**File:** [src/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createResendControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createResendControl.mdx deleted file mode 100644 index c1400662e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createResendControl.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "createResendControl" -description: "Utility function to create resend functionality with timeout management" ---- - -## Parameters - -<ParamField path="screenIdentifier" type={<span>string</span>} required> -</ParamField> - -<ParamField path="resendMethod" type={<span>() => Promise<void></span>} required> -</ParamField> - -<ParamField path="options" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions">StartResendOptions</a></span>}> -</ParamField> - -<ParamField path="resendLimitReached" type={<span>boolean</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>}> -</ParamField> - ---- - -**File:** [src/utils/resend-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/resend-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/decodePublicKey.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/decodePublicKey.mdx deleted file mode 100644 index 5826f970c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/decodePublicKey.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "decodePublicKey" -description: "" ---- - -## Parameters - -<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>['public_key']</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>PublicKeyCredentialCreationOptions</span>}> -</ParamField> - ---- - -**File:** [src/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/extractIdentifiersByStatus.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/extractIdentifiersByStatus.mdx deleted file mode 100644 index 3ad791bd3..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/extractIdentifiersByStatus.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "extractIdentifiersByStatus" -description: "Helper function that extracts identifiers based on their signup status. Used internally by getAllowedIdentifiers, getRequiredIdentifiers, and getOptionalIdentifiers." ---- - -## Parameters - -<ParamField path="connection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection">DBConnection</a> | undefined</span>}> -</ParamField> - -<ParamField path="statuses" type={<span>('required' | 'optional')[]</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>IdentifierType[] | null</span>}> -</ParamField> - ---- - -**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenBorders.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenBorders.mdx deleted file mode 100644 index a709b2520..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenBorders.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "flattenBorders" -description: "Processes and returns theme borders configuration" ---- - -## Parameters - -<ParamField path="themeBorders" type={<span>Record<string, string | boolean | number></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>Record<string, string | boolean | number></span>}> -</ParamField> - ---- - -**File:** [src/utils/branding-theme.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/branding-theme.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenColors.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenColors.mdx deleted file mode 100644 index eba0f1b6d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenColors.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "flattenColors" -description: "Flattens and merges theme colors with settings colors" ---- - -## Parameters - -<ParamField path="themeColors" type={<span>Record<string, string></span>} required> -</ParamField> - -<ParamField path="settingsColors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings">BrandingSettings</a>['colors']</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>Record<string, string></span>}> -</ParamField> - ---- - -**File:** [src/utils/branding-theme.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/branding-theme.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenFonts.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenFonts.mdx deleted file mode 100644 index fe126971b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenFonts.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "flattenFonts" -description: "Processes and returns theme fonts configuration" ---- - -## Parameters - -<ParamField path="themeFonts" type={<span>Record<string, string | boolean | object></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>Record<string, string | number | boolean | object></span>}> -</ParamField> - ---- - -**File:** [src/utils/branding-theme.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/branding-theme.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenPageBackground.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenPageBackground.mdx deleted file mode 100644 index 30d891c94..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenPageBackground.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "flattenPageBackground" -description: "Flattens and merges theme page background with settings background" ---- - -## Parameters - -<ParamField path="themeBackground" type={<span>Record<string, string></span>} required> -</ParamField> - -<ParamField path="settingsPageBackground" type={<span>string | object</span>}> - <Expandable title="properties"> - <ParamField path="type" type={<span>string</span>} required> - </ParamField> - <ParamField path="start" type={<span>string</span>} required> - </ParamField> - <ParamField path="end" type={<span>string</span>} required> - </ParamField> - <ParamField path="angleDegree" type={<span>number</span>} required> - </ParamField> - </Expandable> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>Record<string, string></span>}> -</ParamField> - ---- - -**File:** [src/utils/branding-theme.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/branding-theme.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenWidget.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenWidget.mdx deleted file mode 100644 index ded2e72b5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenWidget.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "flattenWidget" -description: "Processes and returns theme widget configuration" ---- - -## Parameters - -<ParamField path="themeWidget" type={<span>Record<string, string | number></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>Record<string, string | number></span>}> -</ParamField> - ---- - -**File:** [src/utils/branding-theme.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/branding-theme.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getActiveIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getActiveIdentifiers.mdx deleted file mode 100644 index b2aeca443..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getActiveIdentifiers.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getActiveIdentifiers" -description: "Returns the active identifiers (email, username, phone) based on the connection settings. Active identifiers are those that can be used for login." ---- - -## Parameters - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>IdentifierType[] | null</span>}> -</ParamField> - ---- - -**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getAllowedIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getAllowedIdentifiers.mdx deleted file mode 100644 index e8d5ba0e4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getAllowedIdentifiers.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getAllowedIdentifiers" -description: "Returns the allowed identifiers (email, username, phone) based on the connection settings. This includes both required and optional identifier types." ---- - -## Parameters - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId">TransactionMembersOnLoginId</a>['allowedIdentifiers'] | null</span>}> -</ParamField> - ---- - -**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBackLink.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBackLink.mdx deleted file mode 100644 index 5dd75e74f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBackLink.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getBackLink" -description: "Retrieves the back link from the screen context." ---- - -## Parameters - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>string | null</span>}> -</ParamField> - ---- - -**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBrowserCapabilities.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBrowserCapabilities.mdx deleted file mode 100644 index ec1c52131..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBrowserCapabilities.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "getBrowserCapabilities" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>Promise<object></span>}> -</ParamField> - ---- - -**File:** [src/utils/browser-capabilities.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/browser-capabilities.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreen.mdx deleted file mode 100644 index 8e0f6ab8e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreen.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "getCurrentScreen" -description: "Gets the current screen name from the authentication context" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>string | null</span>}> -</ParamField> - ---- - -**File:** [src/common/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/common/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreenOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreenOptions.mdx deleted file mode 100644 index 1d3bbf1de..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreenOptions.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "getCurrentScreenOptions" -description: "Gets the current screen options including client, organization, prompt, screen, tenant, transaction, and untrusted data" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CurrentScreenOptions">CurrentScreenOptions</a></span>}> -</ParamField> - ---- - -**File:** [src/common/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/common/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getEditIdentifierLink.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getEditIdentifierLink.mdx deleted file mode 100644 index 3d4b940ad..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getEditIdentifierLink.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getEditIdentifierLink" -description: "Retrieves the edit identifier link from the screen context." ---- - -## Parameters - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>string | null</span>}> -</ParamField> - ---- - -**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getErrors.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getErrors.mdx deleted file mode 100644 index 5bbda134e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getErrors.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "getErrors" -description: "Gets the current errors from the transaction context" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>TransactionError[] | null</span>}> -</ParamField> - ---- - -**File:** [src/common/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/common/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getForgotPasswordLink.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getForgotPasswordLink.mdx deleted file mode 100644 index 0378b18d1..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getForgotPasswordLink.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getForgotPasswordLink" -description: "Retrieves the forgot password link from the screen context." ---- - -## Parameters - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>string | null</span>}> -</ParamField> - ---- - -**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginIdentifiers.mdx deleted file mode 100644 index c4fd993d7..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginIdentifiers.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getLoginIdentifiers" -description: "Returns a list of allowed login identifiers. This function accepts an array of allowed identifier types or `null`, and returns the array if provided, or an empty array otherwise." ---- - -## Parameters - -<ParamField path="allowedIdentifiers" type={<span>Array<IdentifierType> | null</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>IdentifierType[] | null</span>}> -</ParamField> - ---- - -**File:** [src/utils/login-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/login-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginLink.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginLink.mdx deleted file mode 100644 index 770551c0b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginLink.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getLoginLink" -description: "Retrieves the login link from the screen context." ---- - -## Parameters - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>string | null</span>}> -</ParamField> - ---- - -**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getOptionalIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getOptionalIdentifiers.mdx deleted file mode 100644 index a71ce31aa..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getOptionalIdentifiers.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getOptionalIdentifiers" -description: "Returns only the optional identifiers for signup flow based on connection settings." ---- - -## Parameters - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a>['optionalIdentifiers']</span>}> -</ParamField> - ---- - -**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasskeyCredentials.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasskeyCredentials.mdx deleted file mode 100644 index f4731b981..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasskeyCredentials.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getPasskeyCredentials" -description: "" ---- - -## Parameters - -<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key']</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>Promise<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCredentialResponse">PasskeyCredentialResponse</a>></span>}> -</ParamField> - ---- - -**File:** [src/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasswordPolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasswordPolicy.mdx deleted file mode 100644 index b2a8f1d95..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasswordPolicy.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getPasswordPolicy" -description: "Retrieves the password policy configuration from the transaction context. This includes properties like minimum length and complexity requirements." ---- - -## Parameters - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy">PasswordPolicy</a> | null</span>}> -</ParamField> - ---- - -**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPublicKey.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPublicKey.mdx deleted file mode 100644 index 2f39aa5c9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPublicKey.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getPublicKey" -description: "Retrieves the public key for passkeys from the screen context." ---- - -## Parameters - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key'] | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>['public_key'] | null</span>}> -</ParamField> - ---- - -**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getRequiredIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getRequiredIdentifiers.mdx deleted file mode 100644 index 6bb873386..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getRequiredIdentifiers.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getRequiredIdentifiers" -description: "Returns only the required identifiers for signup flow based on connection settings." ---- - -## Parameters - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a>['requiredIdentifiers']</span>}> -</ParamField> - ---- - -**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getResetPasswordLink.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getResetPasswordLink.mdx deleted file mode 100644 index c4bf98f06..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getResetPasswordLink.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getResetPasswordLink" -description: "Retrieves the reset password link from the screen context." ---- - -## Parameters - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>string | null</span>}> -</ParamField> - ---- - -**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getScopes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getScopes.mdx deleted file mode 100644 index 84508b915..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getScopes.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getScopes" -description: "Retrieves and processes the scopes from the provided screen context. This function ensures that the scopes are properly formatted and validated. It provides default values for optional fields and ensures that the `values` property is always an array of strings. Invalid entries are filtered out." ---- - -## Parameters - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope">Scope[]</a></span>}> -</ParamField> - ---- - -**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getShowRememberDevice.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getShowRememberDevice.mdx deleted file mode 100644 index 3e9357625..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getShowRememberDevice.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getShowRememberDevice" -description: "Retrieves the remember device option from the screen context. This is used in MFA flows where users can choose to remember their device for future logins." ---- - -## Parameters - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>boolean</span>}> -</ParamField> - ---- - -**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupIdentifiers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupIdentifiers.mdx deleted file mode 100644 index 2ef5790aa..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupIdentifiers.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "getSignupIdentifiers" -description: "Returns a list of enabled identifiers (email, phone, or username), each with its `required` status, based on the given required and optional identifiers, and the connection strategy." ---- - -## Parameters - -<ParamField path="requiredIdentifiers" type={<span>Array<IdentifierType></span>} required> -</ParamField> - -<ParamField path="optionalIdentifiers" type={<span>Array<IdentifierType></span>} required> -</ParamField> - -<ParamField path="connectionStrategy" type={<span>string | null</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier">Identifier[]</a></span>}> -</ParamField> - ---- - -**File:** [src/utils/signup-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/signup-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupLink.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupLink.mdx deleted file mode 100644 index 648a764a9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupLink.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getSignupLink" -description: "Retrieves the signup link from the screen context." ---- - -## Parameters - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>string | null</span>}> -</ParamField> - ---- - -**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getUsernamePolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getUsernamePolicy.mdx deleted file mode 100644 index 1f7285b5f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getUsernamePolicy.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getUsernamePolicy" -description: "Retrieves the username policy configuration from the transaction context. This includes settings like minimum/maximum length and allowed formats." ---- - -## Parameters - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy">UsernamePolicy</a> | null</span>}> -</ParamField> - ---- - -**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getWebAuthnType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getWebAuthnType.mdx deleted file mode 100644 index 80cf7b272..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getWebAuthnType.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getWebAuthnType" -description: "Retrieves the WebAuthn type from the screen context." ---- - -## Parameters - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>string | null</span>}> -</ParamField> - ---- - -**File:** [src/shared/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/hasFlexibleIdentifier.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/hasFlexibleIdentifier.mdx deleted file mode 100644 index de8c5ab2d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/hasFlexibleIdentifier.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "hasFlexibleIdentifier" -description: "Checks if the connection supports flexible identifiers. A connection supports flexible identifiers if it has attributes configured." ---- - -## Parameters - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>boolean</span>}> -</ParamField> - ---- - -**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/internalPoll.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/internalPoll.mdx deleted file mode 100644 index 4a055c678..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/internalPoll.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "internalPoll" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isAuthenticatorAssertionResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isAuthenticatorAssertionResponse.mdx deleted file mode 100644 index a0a36aa3c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isAuthenticatorAssertionResponse.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "isAuthenticatorAssertionResponse" -description: "" ---- - -## Parameters - -<ParamField path="response" type={<span>AuthenticatorResponse</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>response is AuthenticatorAssertionResponse</span>}> -</ParamField> - ---- - -**File:** [src/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isBrave.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isBrave.mdx deleted file mode 100644 index 3e30ab811..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isBrave.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "isBrave" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>Promise<boolean></span>}> -</ParamField> - ---- - -**File:** [src/utils/browser-capabilities.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/browser-capabilities.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isForgotPasswordEnabled.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isForgotPasswordEnabled.mdx deleted file mode 100644 index 41b2e4c57..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isForgotPasswordEnabled.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "isForgotPasswordEnabled" -description: "Checks if forgot password is enabled for the current database connection." ---- - -## Parameters - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>boolean</span>}> -</ParamField> - ---- - -**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isJsAvailable.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isJsAvailable.mdx deleted file mode 100644 index cc27593e0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isJsAvailable.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "isJsAvailable" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>boolean</span>}> -</ParamField> - ---- - -**File:** [src/utils/browser-capabilities.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/browser-capabilities.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeyEnabled.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeyEnabled.mdx deleted file mode 100644 index a48b240e8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeyEnabled.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "isPasskeyEnabled" -description: "Checks if passkeys are enabled in the current connection configuration." ---- - -## Parameters - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>boolean</span>}> -</ParamField> - ---- - -**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeySupported.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeySupported.mdx deleted file mode 100644 index 8d0e0ea31..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeySupported.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "isPasskeySupported" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>Promise<boolean></span>}> -</ParamField> - ---- - -**File:** [src/utils/browser-capabilities.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/browser-capabilities.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isRunning.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isRunning.mdx deleted file mode 100644 index 2d57a8269..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isRunning.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "isRunning" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>boolean</span>}> -</ParamField> - ---- - -**File:** [src/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isSignupEnabled.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isSignupEnabled.mdx deleted file mode 100644 index 7ae63c9c1..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isSignupEnabled.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "isSignupEnabled" -description: "Checks if signup is enabled for the current connection." ---- - -## Parameters - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>boolean</span>}> -</ParamField> - ---- - -**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isUsernameRequired.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isUsernameRequired.mdx deleted file mode 100644 index 355351693..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isUsernameRequired.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "isUsernameRequired" -description: "Determines if a username is required for authentication based on connection settings." ---- - -## Parameters - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>boolean</span>}> -</ParamField> - ---- - -**File:** [src/shared/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/shared/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthAvailable.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthAvailable.mdx deleted file mode 100644 index e12ea1cda..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthAvailable.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "isWebAuthAvailable" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>boolean</span>}> -</ParamField> - ---- - -**File:** [src/utils/browser-capabilities.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/browser-capabilities.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthPlatformAvailable.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthPlatformAvailable.mdx deleted file mode 100644 index 6916cab79..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthPlatformAvailable.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "isWebAuthPlatformAvailable" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>Promise<boolean></span>}> -</ParamField> - ---- - -**File:** [src/utils/browser-capabilities.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/browser-capabilities.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/parseErrorMessage.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/parseErrorMessage.mdx deleted file mode 100644 index f07c74fdf..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/parseErrorMessage.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "parseErrorMessage" -description: "" ---- - -## Parameters - -<ParamField path="responseText" type={<span>string</span>} required> -</ParamField> - -<ParamField path="status" type={<span>number</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>string</span>}> -</ParamField> - ---- - -**File:** [src/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/registerPasskeyAutofill.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/registerPasskeyAutofill.mdx deleted file mode 100644 index 6b4e9910a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/registerPasskeyAutofill.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "registerPasskeyAutofill" -description: "" ---- - -## Parameters - -<ParamField path="{ - publicKey, - inputId, - onResolve, - onReject, -}" type="object" required> - <Expandable title="properties"> - <ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key']</span>} required> - </ParamField> - <ParamField path="inputId" type={<span>string</span>}> - </ParamField> - <ParamField path="onResolve" type={<span>(credential: Credential) => void | Promise<void>; onReject?: (error: unknown) => void;</span>} required> - </ParamField> - </Expandable> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>Promise<AbortController | void></span>}> -</ParamField> - ---- - -**File:** [src/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/safeBase64Url.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/safeBase64Url.mdx deleted file mode 100644 index 196a08852..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/safeBase64Url.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "safeBase64Url" -description: "" ---- - -## Parameters - -<ParamField path="buffer" type={<span>ArrayBuffer | null</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>string | null</span>}> -</ParamField> - ---- - -**File:** [src/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/startPolling.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/startPolling.mdx deleted file mode 100644 index dfe4016f9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/startPolling.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "startPolling" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/stopPolling.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/stopPolling.mdx deleted file mode 100644 index d06dbd401..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/stopPolling.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "stopPolling" -description: "" ---- - -## Parameters - -## Returns - -<ParamField path="response" type={<span>void</span>}> -</ParamField> - ---- - -**File:** [src/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/uint8ArrayToBase64Url.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/uint8ArrayToBase64Url.mdx deleted file mode 100644 index f34277d21..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/uint8ArrayToBase64Url.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "uint8ArrayToBase64Url" -description: "" ---- - -## Parameters - -<ParamField path="arraybuffer" type={<span>ArrayBufferLike</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span>string</span>}> -</ParamField> - ---- - -**File:** [src/utils/codec.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/codec.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/updatePayloadByIdentifier.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/updatePayloadByIdentifier.mdx deleted file mode 100644 index fb47f8311..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/updatePayloadByIdentifier.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "updatePayloadByIdentifier" -description: "@private" ---- - -## Parameters - -<ParamField path="payload" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions">ResetPasswordRequestOptions</a></span>} required> -</ParamField> - -<ParamField path="isFlexibleIdentifier" type={<span>boolean</span>} required> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions">ResetPasswordRequestOptions</a> | object</span>}> - <Expandable title="properties"> - <ParamField path="email" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [src/screens/reset-password-request/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/screens/reset-password-request/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validatePassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validatePassword.mdx deleted file mode 100644 index 8bdac9a9f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validatePassword.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "validatePassword" -description: "Validate a password string against an Auth0 password policy." ---- - -## Parameters - -<ParamField path="password" type={<span>string</span>} required> -</ParamField> - -<ParamField path="policy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy">PasswordPolicy</a> | null</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> -</ParamField> - ---- - -**File:** [src/utils/validate-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/validate-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validateUsername.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validateUsername.mdx deleted file mode 100644 index 23e23ff24..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validateUsername.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "validateUsername" -description: "Validates a username string against a given username policy. This function checks the username for: - Presence (if no policy is provided) - Minimum and maximum length - Email format restrictions - Phone number format restrictions If no policy is provided, it defaults to checking whether the username is non-empty." ---- - -## Parameters - -<ParamField path="username" type={<span>string</span>} required> -</ParamField> - -<ParamField path="policy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy">UsernamePolicy</a> | null</span>}> -</ParamField> - -## Returns - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}> -</ParamField> - ---- - -**File:** [src/utils/validate-username.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/src/utils/validate-username.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AbortEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AbortEnrollmentOptions.mdx deleted file mode 100644 index 5c5886bc4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AbortEnrollmentOptions.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "AbortEnrollmentOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface AbortEnrollmentOptions { - doNotShowAgain?: boolean; - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="doNotShowAgain" type={<span>boolean</span>}> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/passkey-enrollment-local.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AcceptInvitationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AcceptInvitationMembers.mdx deleted file mode 100644 index 180b2acda..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AcceptInvitationMembers.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "AcceptInvitationMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface AcceptInvitationMembers extends BaseMembers { - client: ClientMembers; - organization: OrganizationMembers; - prompt: PromptMembers; - screen: ScreenMembersOnAcceptInvitation; - transaction: TransactionMembers; - /** - * Accepts the invitation to the organization. - * @param payload Optional custom options to include with the request. - */ - acceptInvitation(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnAcceptInvitation">ScreenMembersOnAcceptInvitation</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="acceptInvitation" type={<span>Promise<void></span>} required> - Accepts the invitation to the organization. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/accept-invitation.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AllowCredential.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AllowCredential.mdx deleted file mode 100644 index 0e13b0a26..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AllowCredential.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "AllowCredential" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface AllowCredential { - type: 'public-key'; - id: Base64URLString; - transports?: AuthenticatorTransport[]; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="type" type={<span>'public-key'</span>} required> -</ParamField> - -<ParamField path="id" type={<span>Base64URLString</span>} required> -</ParamField> - -<ParamField path="transports" type={<span>AuthenticatorTransport[]</span>}> -</ParamField> - ---- - -**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail.mdx deleted file mode 100644 index 330be70fa..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "AuthorizationDetail" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface AuthorizationDetail { - type: string; - [key: string]: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="type" type={<span>string</span>} required> -</ParamField> - -<ParamField path="unknown" type={<span>string</span>} required> -</ParamField> - ---- - -**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseContext.mdx deleted file mode 100644 index 0f1a6290c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseContext.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "BaseContext" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface BaseContext { - branding?: BrandingContext; - client: ClientContext; - organization: OrganizationContext; - prompt: PromptContext; - screen: ScreenContext; - tenant?: TenantContext; - transaction: TransactionContext; - user: UserContext; - untrusted_data?: UntrustedDataContext; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext">ScreenContext</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> -</ParamField> - -<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>}> -</ParamField> - ---- - -**File:** [interfaces/models/base-context.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/base-context.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseMembers.mdx deleted file mode 100644 index f5009536f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseMembers.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "BaseMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface BaseMembers { - branding: BrandingMembers; - client: ClientMembers; - organization: OrganizationMembers; - prompt: PromptMembers; - screen: ScreenMembers; - tenant: TenantMembers; - transaction: TransactionMembers; - user: UserMembers; - untrustedData: UntrustedDataMembers; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/models/base-context.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/base-context.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Branding.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Branding.mdx deleted file mode 100644 index 7c1d53edf..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Branding.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "Branding" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface Branding { - logoUrl?: string; - colors?: { - primary?: string; - pageBackground?: string; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="logoUrl" type={<span>string</span>}> -</ParamField> - -<ParamField path="colors" type="object"> - <Expandable title="properties"> - <ParamField path="primary" type={<span>string</span>}> - </ParamField> - <ParamField path="pageBackground" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/models/organization.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/organization.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext.mdx deleted file mode 100644 index 94bade51e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: "BrandingContext" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface BrandingContext { - settings?: { - colors?: { - primary?: string; - page_background?: - | string - | { - type: string; - start: string; - end: string; - angle_deg: number; - }; - }; - favicon_url?: string; - logo_url?: string; - font?: { - url: string; - }; - }; - themes?: { - default: { - borders: Record<string, string | boolean | number>; - colors: Record<string, string>; - displayName: string; - fonts: Record<string, string | boolean | object>; - page_background: Record<string, string>; - widget: Record<string, string | number>; - }; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="settings" type="object"> - <Expandable title="properties"> - <ParamField path="colors" type="object"> - <Expandable title="properties"> - <ParamField path="primary" type={<span>string</span>}> - </ParamField> - <ParamField path="page_background" type={<span>string | object</span>}> - <Expandable title="properties"> - <ParamField path="type" type={<span>string</span>} required> - </ParamField> - <ParamField path="start" type={<span>string</span>} required> - </ParamField> - <ParamField path="end" type={<span>string</span>} required> - </ParamField> - <ParamField path="angle_deg" type={<span>number</span>} required> - </ParamField> - </Expandable> - </ParamField> - </Expandable> - </ParamField> - <ParamField path="favicon_url" type={<span>string</span>}> - </ParamField> - <ParamField path="logo_url" type={<span>string</span>}> - </ParamField> - <ParamField path="font" type="object"> - <Expandable title="properties"> - <ParamField path="url" type={<span>string</span>} required> - </ParamField> - </Expandable> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="themes" type="object"> - <Expandable title="properties"> - <ParamField path="default" type="object" required> - <Expandable title="properties"> - <ParamField path="borders" type={<span>Record<string, string | boolean | number></span>} required> - </ParamField> - <ParamField path="colors" type={<span>Record<string, string></span>} required> - </ParamField> - <ParamField path="displayName" type={<span>string</span>} required> - </ParamField> - <ParamField path="fonts" type={<span>Record<string, string | boolean | object></span>} required> - </ParamField> - <ParamField path="page_background" type={<span>Record<string, string></span>} required> - </ParamField> - <ParamField path="widget" type={<span>Record<string, string | number></span>} required> - </ParamField> - </Expandable> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/models/branding.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/branding.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers.mdx deleted file mode 100644 index 5a0c29b22..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "BrandingMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface BrandingMembers { - settings: BrandingSettings | null; - themes: BrandingThemes | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="settings" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings">BrandingSettings</a> | null</span>}> -</ParamField> - -<ParamField path="themes" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingThemes">BrandingThemes</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/models/branding.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/branding.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings.mdx deleted file mode 100644 index 281b6613a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: "BrandingSettings" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface BrandingSettings { - colors?: { - primary?: string; - pageBackground?: - | string - | { - type: string; - start: string; - end: string; - angleDegree: number; - }; - }; - faviconUrl?: string; - logoUrl?: string; - fontUrl?: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="colors" type="object"> - <Expandable title="properties"> - <ParamField path="primary" type={<span>string</span>}> - </ParamField> - <ParamField path="pageBackground" type={<span>string | object</span>}> - <Expandable title="properties"> - <ParamField path="type" type={<span>string</span>} required> - </ParamField> - <ParamField path="start" type={<span>string</span>} required> - </ParamField> - <ParamField path="end" type={<span>string</span>} required> - </ParamField> - <ParamField path="angleDegree" type={<span>number</span>} required> - </ParamField> - </Expandable> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="faviconUrl" type={<span>string</span>}> -</ParamField> - -<ParamField path="logoUrl" type={<span>string</span>}> -</ParamField> - -<ParamField path="fontUrl" type={<span>string</span>}> -</ParamField> - ---- - -**File:** [interfaces/models/branding.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/branding.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingThemes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingThemes.mdx deleted file mode 100644 index 6dc21caca..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingThemes.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "BrandingThemes" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface BrandingThemes { - default: { - borders: Record<string, string | boolean | number>; - colors: Record<string, string>; - displayName: string; - fonts: Record<string, string | boolean | object>; - pageBackground: Record<string, string>; - widget: Record<string, string | number>; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="default" type="object" required> - <Expandable title="properties"> - <ParamField path="borders" type={<span>Record<string, string | boolean | number></span>} required> - </ParamField> - <ParamField path="colors" type={<span>Record<string, string></span>} required> - </ParamField> - <ParamField path="displayName" type={<span>string</span>} required> - </ParamField> - <ParamField path="fonts" type={<span>Record<string, string | boolean | object></span>} required> - </ParamField> - <ParamField path="pageBackground" type={<span>Record<string, string></span>} required> - </ParamField> - <ParamField path="widget" type={<span>Record<string, string | number></span>} required> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/models/branding.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/branding.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureMembers.mdx deleted file mode 100644 index 183528892..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureMembers.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "BruteForceProtectionUnblockFailureMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface BruteForceProtectionUnblockFailureMembers extends BaseMembers { - screen: ScreenMembersOnBruteForceProtectionUnblockFailure; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockFailure">ScreenMembersOnBruteForceProtectionUnblockFailure</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/brute-force-protection-unblock-failure.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/brute-force-protection-unblock-failure.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureOptions.mdx deleted file mode 100644 index d97d3d099..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureOptions.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "BruteForceProtectionUnblockFailureOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface BruteForceProtectionUnblockFailureOptions { - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/brute-force-protection-unblock-failure.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/brute-force-protection-unblock-failure.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockMembers.mdx deleted file mode 100644 index 6e50f53a2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockMembers.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "BruteForceProtectionUnblockMembers" -description: "Represents the members of the BruteForceProtectionUnblock screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface BruteForceProtectionUnblockMembers extends BaseMembers { - /** - * Submits the unblock account request. - * @param {CustomOptions} [payload] - Optional payload to include with the unblock request. - * @returns {Promise<void>} A promise that resolves when the unblock request is successfully submitted. - */ - unblockAccount(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="unblockAccount" type={<span>Promise<void></span>} required> - Submits the unblock account request. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/brute-force-protection-unblock.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/brute-force-protection-unblock.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockSuccessMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockSuccessMembers.mdx deleted file mode 100644 index 441d3e311..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockSuccessMembers.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "BruteForceProtectionUnblockSuccessMembers" -description: "Represents the public interface of the Brute Force Protection Unblock Success screen. It extends the base members and includes specific properties and methods for this screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface BruteForceProtectionUnblockSuccessMembers extends BaseMembers { - /** - * Represents the screen-specific members for the brute force protection unblock success screen. - */ - screen: ScreenMembersOnBruteForceProtectionUnblockSuccess; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockSuccess">ScreenMembersOnBruteForceProtectionUnblockSuccess</a></span>} required> - Represents the screen-specific members for the brute force protection unblock success screen. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/brute-force-protection-unblock-success.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/brute-force-protection-unblock-success.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext.mdx deleted file mode 100644 index c42242972..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "CaptchaContext" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface CaptchaContext { - provider: string; - image?: string; - siteKey?: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="provider" type={<span>string</span>} required> -</ParamField> - -<ParamField path="image" type={<span>string</span>}> -</ParamField> - -<ParamField path="siteKey" type={<span>string</span>}> -</ParamField> - ---- - -**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext.mdx deleted file mode 100644 index dc84e7db4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "ClientContext" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ClientContext { - id: string; - name: string; - logo_uri?: string; - description?: string; - metadata?: { - [key: string]: string; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="id" type={<span>string</span>} required> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="logo_uri" type={<span>string</span>}> -</ParamField> - -<ParamField path="description" type={<span>string</span>}> -</ParamField> - -<ParamField path="metadata" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/models/client.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/client.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers.mdx deleted file mode 100644 index bc5a94046..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "ClientMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ClientMembers { - id: string; - name: string; - logoUrl: string | null; - description: string | null; - metadata: { [key: string]: string } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="id" type={<span>string</span>} required> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="logoUrl" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="description" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="metadata" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/models/client.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/client.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConditionalMediationCapable.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConditionalMediationCapable.mdx deleted file mode 100644 index da1b86db6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConditionalMediationCapable.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ConditionalMediationCapable" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ConditionalMediationCapable { - isConditionalMediationAvailable?: () => Promise<boolean>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="isConditionalMediationAvailable" type={<span>() => Promise<boolean></span>}> -</ParamField> - ---- - -**File:** [interfaces/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConfirmLogoutOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConfirmLogoutOptions.mdx deleted file mode 100644 index cf39a515e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConfirmLogoutOptions.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "ConfirmLogoutOptions" -description: "Options for confirming logout" ---- - -<RequestExample> - -```typescript Interface lines -export interface ConfirmLogoutOptions extends CustomOptions { - /** The authentication transaction state */ - action: 'accept' | 'deny'; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="action" type={<span>'accept' | 'deny'</span>} required> - The authentication transaction state -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/logout.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/logout.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection.mdx deleted file mode 100644 index db31070f5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "Connection" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface Connection { - name: string; - strategy: string; - metadata?: Record<string, string>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="strategy" type={<span>string</span>} required> -</ParamField> - -<ParamField path="metadata" type={<span>Record<string, string></span>}> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConsentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConsentMembers.mdx deleted file mode 100644 index ee4c90884..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConsentMembers.mdx +++ /dev/null @@ -1,117 +0,0 @@ ---- -title: "ConsentMembers" -description: "@interface ConsentMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface ConsentMembers extends BaseMembers { - /** - * Provides access to the specific properties and data of the Consent screen, - * including the list of `scopes` being requested and the `hideScopes` flag. - * @type {ScreenMembersOnConsent} - */ - screen: ScreenMembersOnConsent; - - /** - * Submits the user's decision to accept (grant) the requested permissions. - * This action posts to the `/u/consent` endpoint with `action: "accept"`. - * - * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs - * to be sent with the request. These parameters will be - * included in the form data submitted to the server. - * @returns {Promise<void>} A promise that resolves when the accept action is successfully submitted. - * On success, Auth0 typically redirects the user back to the application - * or to the next step in the authentication flow. - * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). - * Server-side errors (like "invalid_request") will be reflected in `this.transaction.errors` - * after the operation, rather than being thrown as JavaScript errors. - * - * @example - * ```typescript - * // Assuming 'consentManager' is an instance of the Consent screen SDK class - * try { - * await consentManager.accept(); - * // If successful, the page will typically redirect. - * } catch (error) { - * // Handle unexpected errors during the submission itself. - * console.error("Failed to submit consent acceptance:", error); - * } - * // After the await, check consentManager.transaction.errors for server-side validation issues. - * ``` - */ - accept(payload?: CustomOptions): Promise<void>; - - /** - * Submits the user's decision to deny (reject) the requested permissions. - * This action posts to the `/u/consent` endpoint with `action: "deny"`. - * - * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs - * to be sent with the request. These parameters will be - * included in the form data submitted to the server. - * @returns {Promise<void>} A promise that resolves when the deny action is successfully submitted. - * On success, Auth0 typically redirects the user, potentially showing an - * access denied message or returning an error to the application. - * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). - * Server-side errors are reflected in `this.transaction.errors`. - * - * @example - * ```typescript - * // Assuming 'consentManager' is an instance of the Consent screen SDK class - * try { - * await consentManager.deny({ reason: "user_declined" }); // Example custom option - * // If successful, the page will typically redirect. - * } catch (error) { - * console.error("Failed to submit consent denial:", error); - * } - * // After the await, check consentManager.transaction.errors for server-side validation issues. - * ``` - */ - deny(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnConsent">ScreenMembersOnConsent</a></span>} required> - Provides access to the specific properties and data of the Consent screen, including the list of `scopes` being requested and the `hideScopes` flag. -</ParamField> - -<ParamField path="accept" type={<span>Promise<void></span>} required> - Submits the user's decision to accept (grant) the requested permissions. This action posts to the `/u/consent` endpoint with `action: "accept"`. -</ParamField> - -<ParamField path="deny" type={<span>Promise<void></span>} required> - Submits the user's decision to deny (reject) the requested permissions. This action posts to the `/u/consent` endpoint with `action: "deny"`. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/consent.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/consent.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions.mdx deleted file mode 100644 index 95f800cbf..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "ContinueOptions" -description: "Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers." ---- - -<RequestExample> - -```typescript Interface lines -export interface ContinueOptions extends CustomOptions { - /** - * The OTP code entered by the user. - */ - code: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="code" type={<span>string</span>} required> - The OTP code entered by the user. -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-voice-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithCodeOptions.mdx deleted file mode 100644 index ca9f124cf..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithCodeOptions.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "ContinueWithCodeOptions" -description: "@interface ContinueWithCodeOptions description Options for the `continueWithCode` method on the Login Email Verification screen. This operation is used when the user submits the verification code they received via email to proceed with the authentication flow." ---- - -<RequestExample> - -```typescript Interface lines -export interface ContinueWithCodeOptions extends CustomOptions { - /** - * The verification code sent to the user's email. This is typically a short numeric - * or alphanumeric string that the user must enter into the form. - * @type {string} - * @example "123456" - * @example "ABCXYZ" - */ - code: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="code" type={<span>string</span>} required> - The verification code sent to the user's email. This is typically a short numeric or alphanumeric string that the user must enter into the form. -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-email-verification.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithOrganizationNameOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithOrganizationNameOptions.mdx deleted file mode 100644 index 47b2476c4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithOrganizationNameOptions.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "ContinueWithOrganizationNameOptions" -description: "Options for continuing with the selected organization name." ---- - -<RequestExample> - -```typescript Interface lines -export interface ContinueWithOrganizationNameOptions { - /** - * The organization name. - */ - organizationName: string; - /** - * Any additional custom options. - */ - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="organizationName" type={<span>string</span>} required> - The organization name. -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> - Any additional custom options. -</ParamField> - ---- - -**File:** [interfaces/screens/organization-selection.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/organization-selection.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithPasskeyOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithPasskeyOptions.mdx deleted file mode 100644 index e42ee32bf..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithPasskeyOptions.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "ContinueWithPasskeyOptions" -description: "@interface ContinueWithPasskeyOptions" ---- - -<RequestExample> - -```typescript Interface lines -export interface ContinueWithPasskeyOptions extends CustomOptions { - /** - * Optional. If true, and if `screen.showRememberDevice` is also true, - * this signals the server to remember this browser for MFA for a defined period. - * @type {boolean | undefined} - */ - rememberDevice?: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="rememberDevice" type={<span>boolean</span>}> - Optional. If true, and if `screen.showRememberDevice` is also true, this signals the server to remember this browser for MFA for a defined period. -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode.mdx deleted file mode 100644 index bcd77b0dd..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "CountryCode" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -interface CountryCode { - code: string; - prefix: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="code" type={<span>string</span>} required> -</ParamField> - -<ParamField path="prefix" type={<span>string</span>} required> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CredentialResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CredentialResponse.mdx deleted file mode 100644 index 715641108..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CredentialResponse.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "CredentialResponse" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface CredentialResponse { - clientDataJSON: string | null; - attestationObject: string | null; - transports?: string[]; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="clientDataJSON" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="attestationObject" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="transports" type={<span>string[]</span>}> -</ParamField> - ---- - -**File:** [interfaces/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CurrentScreenOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CurrentScreenOptions.mdx deleted file mode 100644 index dbb5041ac..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CurrentScreenOptions.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: "CurrentScreenOptions" -description: "CurrentScreenOptions details." ---- - -<RequestExample> - -```typescript Interface lines -export interface CurrentScreenOptions { - client: { - id: string; - metadata: Record<string, string> | null; - } | null; - organization: { - id: string; - metadata: Record<string, string> | null; - } | null; - prompt: { - name: string; - } | null; - screen: { - name: string; - } | null; - tenant: { - enabledLocales: string[]; - } | null; - transaction: { - errors: TransactionError[] | null; - state: string; - locale: string; - } | null; - untrustedData: { - authorizationParams: Record<string, string> | null; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="client" type="object"> - <Expandable title="properties"> - <ParamField path="id" type={<span>string</span>} required> - </ParamField> - <ParamField path="metadata" type={<span>Record<string, string> | null</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="organization" type="object"> - <Expandable title="properties"> - <ParamField path="id" type={<span>string</span>} required> - </ParamField> - <ParamField path="metadata" type={<span>Record<string, string> | null</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="prompt" type="object"> - <Expandable title="properties"> - <ParamField path="name" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="screen" type="object"> - <Expandable title="properties"> - <ParamField path="name" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="tenant" type="object"> - <Expandable title="properties"> - <ParamField path="enabledLocales" type={<span>string[]</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="transaction" type="object"> - <Expandable title="properties"> - <ParamField path="errors" type={<span>TransactionError[] | null</span>}> - </ParamField> - <ParamField path="state" type={<span>string</span>} required> - </ParamField> - <ParamField path="locale" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="untrustedData" type="object"> - <Expandable title="properties"> - <ParamField path="authorizationParams" type={<span>Record<string, string> | null</span>}> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/common/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/common/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions.mdx deleted file mode 100644 index 09837165f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "CustomOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface CustomOptions { - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/common/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/common/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomizedConsentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomizedConsentMembers.mdx deleted file mode 100644 index d1fef6859..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomizedConsentMembers.mdx +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: "CustomizedConsentMembers" -description: "@interface CustomizedConsentMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface CustomizedConsentMembers extends BaseMembers { - /** - * Provides access to the specific properties and data of the Customized Consent screen, - * including the list of `scopes` and `authorizationDetails` being requested. - * @type {ScreenMembersOnCustomizedConsent} - */ - screen: ScreenMembersOnCustomizedConsent; - - /** - * Submits the user's decision to accept (grant) the requested permissions and authorization details. - * This action posts to the `/u/customized-consent` endpoint with `action: "accept"`. - * The transaction state is automatically included. - * - * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs - * to be sent with the request. These parameters will be - * included in the form data submitted to the server. - * @returns {Promise<void>} A promise that resolves when the accept action is successfully submitted. - * On success, Auth0 typically redirects the user back to the application - * or to the next step in the authentication flow. - * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). - * Server-side errors (like "invalid_request") will be reflected in `this.transaction.errors` - * after the operation, rather than being thrown as JavaScript errors. - * - * @example - * ```typescript - * // Assuming 'customizedConsentManager' is an instance of the CustomizedConsent SDK class - * try { - * await customizedConsentManager.accept(); - * // If successful, the page will typically redirect. - * } catch (error) { - * // Handle unexpected errors during the submission itself. - * console.error("Failed to submit consent acceptance:", error); - * } - * // After the await, check customizedConsentManager.transaction.errors for server-side validation issues. - * ``` - */ - accept(payload?: CustomOptions): Promise<void>; - - /** - * Submits the user's decision to deny (reject) the requested permissions and authorization details. - * This action posts to the `/u/customized-consent` endpoint with `action: "deny"`. - * The transaction state is automatically included. - * - * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs - * to be sent with the request. These parameters will be - * included in the form data submitted to the server. - * @returns {Promise<void>} A promise that resolves when the deny action is successfully submitted. - * On success, Auth0 typically redirects the user, potentially showing an - * access denied message or returning an error to the application. - * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). - * Server-side errors are reflected in `this.transaction.errors`. - * - * @example - * ```typescript - * // Assuming 'customizedConsentManager' is an instance of the CustomizedConsent SDK class - * try { - * await customizedConsentManager.deny({ reason_code: "user_rejected_details" }); // Example custom option - * // If successful, the page will typically redirect. - * } catch (error) { - * console.error("Failed to submit consent denial:", error); - * } - * // After the await, check customizedConsentManager.transaction.errors for server-side validation issues. - * ``` - */ - deny(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnCustomizedConsent">ScreenMembersOnCustomizedConsent</a></span>} required> - Provides access to the specific properties and data of the Customized Consent screen, including the list of `scopes` and `authorizationDetails` being requested. -</ParamField> - -<ParamField path="accept" type={<span>Promise<void></span>} required> - Submits the user's decision to accept (grant) the requested permissions and authorization details. This action posts to the `/u/customized-consent` endpoint with `action: "accept"`. The transaction state is automatically included. -</ParamField> - -<ParamField path="deny" type={<span>Promise<void></span>} required> - Submits the user's decision to deny (reject) the requested permissions and authorization details. This action posts to the `/u/customized-consent` endpoint with `action: "deny"`. The transaction state is automatically included. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/customized-consent.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/customized-consent.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection.mdx deleted file mode 100644 index cfb6316cb..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection.mdx +++ /dev/null @@ -1,164 +0,0 @@ ---- -title: "DBConnection" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface DBConnection extends Connection { - options: { - signup_enabled: boolean; - flexible_identifiers_active?: boolean; - forgot_password_enabled: boolean; - username_required?: boolean; - validation?: { - username: { - max_length: number; - min_length: number; - }; - }; - attributes?: { - email?: { - signup_status: string; - identifier_active: boolean; - }; - username?: { - signup_status: string; - identifier_active: boolean; - validation?: { - max_length: number; - min_length: number; - allowed_types: { - email: boolean; - phone_number: boolean; - }; - }; - }; - phone?: { - signup_status: string; - identifier_active: boolean; - }; - }; - authentication_methods: { - password: { - enabled: boolean; - policy: string; - min_length: number; - password_security_info?: PasswordComplexityRule[]; - }; - passkey: { - enabled: boolean; - }; - }; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="options" type="object" required> - <Expandable title="properties"> - <ParamField path="signup_enabled" type={<span>boolean</span>} required> - </ParamField> - <ParamField path="flexible_identifiers_active" type={<span>boolean</span>}> - </ParamField> - <ParamField path="forgot_password_enabled" type={<span>boolean</span>} required> - </ParamField> - <ParamField path="username_required" type={<span>boolean</span>}> - </ParamField> - <ParamField path="validation" type="object"> - <Expandable title="properties"> - <ParamField path="username" type="object" required> - <Expandable title="properties"> - <ParamField path="max_length" type={<span>number</span>} required> - </ParamField> - <ParamField path="min_length" type={<span>number</span>} required> - </ParamField> - </Expandable> - </ParamField> - </Expandable> - </ParamField> - <ParamField path="attributes" type="object"> - <Expandable title="properties"> - <ParamField path="email" type="object"> - <Expandable title="properties"> - <ParamField path="signup_status" type={<span>string</span>} required> - </ParamField> - <ParamField path="identifier_active" type={<span>boolean</span>} required> - </ParamField> - </Expandable> - </ParamField> - <ParamField path="username" type="object"> - <Expandable title="properties"> - <ParamField path="signup_status" type={<span>string</span>} required> - </ParamField> - <ParamField path="identifier_active" type={<span>boolean</span>} required> - </ParamField> - <ParamField path="validation" type="object"> - <Expandable title="properties"> - <ParamField path="max_length" type={<span>number</span>} required> - </ParamField> - <ParamField path="min_length" type={<span>number</span>} required> - </ParamField> - <ParamField path="allowed_types" type="object" required> - <Expandable title="properties"> - <ParamField path="email" type={<span>boolean</span>} required> - </ParamField> - <ParamField path="phone_number" type={<span>boolean</span>} required> - </ParamField> - </Expandable> - </ParamField> - </Expandable> - </ParamField> - </Expandable> - </ParamField> - <ParamField path="phone" type="object"> - <Expandable title="properties"> - <ParamField path="signup_status" type={<span>string</span>} required> - </ParamField> - <ParamField path="identifier_active" type={<span>boolean</span>} required> - </ParamField> - </Expandable> - </ParamField> - </Expandable> - </ParamField> - <ParamField path="authentication_methods" type="object" required> - <Expandable title="properties"> - <ParamField path="password" type="object" required> - <Expandable title="properties"> - <ParamField path="enabled" type={<span>boolean</span>} required> - </ParamField> - <ParamField path="policy" type={<span>string</span>} required> - </ParamField> - <ParamField path="min_length" type={<span>number</span>} required> - </ParamField> - <ParamField path="password_security_info" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule">PasswordComplexityRule[]</a></span>}> - </ParamField> - </Expandable> - </ParamField> - <ParamField path="passkey" type="object" required> - <Expandable title="properties"> - <ParamField path="enabled" type={<span>boolean</span>} required> - </ParamField> - </Expandable> - </ParamField> - </Expandable> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="strategy" type={<span>string</span>} required> -</ParamField> - -<ParamField path="metadata" type={<span>Record<string, string></span>}> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationAllowedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationAllowedMembers.mdx deleted file mode 100644 index c7809dec6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationAllowedMembers.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "DeviceCodeActivationAllowedMembers" -description: "Interface describing the members of the Device Code Activation Allowed screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface DeviceCodeActivationAllowedMembers extends BaseMembers {} -``` - -</RequestExample> - -## Properties - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/device-code-activation-allowed.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/device-code-activation-allowed.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationDeniedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationDeniedMembers.mdx deleted file mode 100644 index efc89a450..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationDeniedMembers.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "DeviceCodeActivationDeniedMembers" -description: "Interface describing the members of the Device Code Activation Denied screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface DeviceCodeActivationDeniedMembers extends BaseMembers {} -``` - -</RequestExample> - -## Properties - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/device-code-activation-denied.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/device-code-activation-denied.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationMembers.mdx deleted file mode 100644 index aa2867360..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationMembers.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: "DeviceCodeActivationMembers" -description: "Interface describing the members of the Device Code Activation screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface DeviceCodeActivationMembers extends BaseMembers { - /** - * Submits the device code entered by the user. - * This action is triggered when the user enters the code displayed on their device and submits the form. - * - * @param {object} payload - An object containing the code entered by the user and any custom payload. - * @param {string} payload.code - The device code entered by the user. - * - * @returns {Promise<void>} A promise that resolves when the code is successfully submitted. - * Rejects with an error if the submission fails. - */ - continue(payload: ContinueOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Submits the device code entered by the user. This action is triggered when the user enters the code displayed on their device and submits the form. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/device-code-activation.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/device-code-activation.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeConfirmationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeConfirmationMembers.mdx deleted file mode 100644 index 7816c9e8e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeConfirmationMembers.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "DeviceCodeConfirmationMembers" -description: "Interface describing the members of the Device Code Confirmation screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface DeviceCodeConfirmationMembers extends BaseMembers { - screen: ScreenMembersOnDeviceCodeConfirmation; - - /** - * Confirms the device code. - * @param payload Optional custom options to include with the request. - */ - confirm(payload?: CustomOptions): Promise<void>; - - /** - * Cancels the device code flow. - * @param payload Optional custom options to include with the request. - */ - cancel(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnDeviceCodeConfirmation">ScreenMembersOnDeviceCodeConfirmation</a></span>} required> -</ParamField> - -<ParamField path="confirm" type={<span>Promise<void></span>} required> - Confirms the device code. -</ParamField> - -<ParamField path="cancel" type={<span>Promise<void></span>} required> - Cancels the device code flow. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/device-code-confirmation.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailChallengeOptions.mdx deleted file mode 100644 index 9f212391a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailChallengeOptions.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "EmailChallengeOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface EmailChallengeOptions { - code: string; - captcha?: string; - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="code" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captcha" type={<span>string</span>}> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/email-identifier-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailIdentifierChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailIdentifierChallengeMembers.mdx deleted file mode 100644 index c1d9a9b7f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailIdentifierChallengeMembers.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "EmailIdentifierChallengeMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface EmailIdentifierChallengeMembers extends BaseMembers { - screen: ScreenMembersOnEmailIdentifierChallenge; - submitEmailChallenge(payload: EmailChallengeOptions): Promise<void>; - resendCode(payload?: CustomOptions): Promise<void>; - resendManager(payload?: StartResendOptions): ResendControl; - returnToPrevious(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailIdentifierChallenge">ScreenMembersOnEmailIdentifierChallenge</a></span>} required> -</ParamField> - -<ParamField path="submitEmailChallenge" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> -</ParamField> - -<ParamField path="returnToPrevious" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/email-identifier-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailOTPChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailOTPChallengeMembers.mdx deleted file mode 100644 index b35e0b0c0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailOTPChallengeMembers.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "EmailOTPChallengeMembers" -description: "Represents the Email OTP Challenge screen interface." ---- - -<RequestExample> - -```typescript Interface lines -export interface EmailOTPChallengeMembers extends BaseMembers { - screen: ScreenMembersOnEmailOTPChallenge; - /** - * Submits the OTP code entered by the user. - * @param options Optional parameters to include in the submission. - */ - submitCode(options: OtpCodeOptions): Promise<void>; - /** - * Requests a new OTP code to be sent to the user's email. - * @param options Optional parameters to include in the resend request. - */ - resendCode(options?: CustomOptions): Promise<void>; - /** - * Gets resend functionality with timeout management for this screen - * @param options Configuration options for resend functionality - */ - resendManager(options?: StartResendOptions): ResendControl; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailOTPChallenge">ScreenMembersOnEmailOTPChallenge</a></span>} required> -</ParamField> - -<ParamField path="submitCode" type={<span>Promise<void></span>} required> - Submits the OTP code entered by the user. -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>} required> - Requests a new OTP code to be sent to the user's email. -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> - Gets resend functionality with timeout management for this screen -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/email-otp-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailVerificationResultMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailVerificationResultMembers.mdx deleted file mode 100644 index d6881fbc5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailVerificationResultMembers.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "EmailVerificationResultMembers" -description: "@interface EmailVerificationResultMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface EmailVerificationResultMembers extends BaseMembers { - /** - * Provides access to the specific properties and data of the Email Verification Result screen, - * including the verification `status` and the `login` link. - * @type {ScreenMembersOnEmailVerificationResult} - */ - screen: ScreenMembersOnEmailVerificationResult; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailVerificationResult">ScreenMembersOnEmailVerificationResult</a></span>} required> - Provides access to the specific properties and data of the Email Verification Result screen, including the verification `status` and the `login` link. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/email-verification-result.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice.mdx deleted file mode 100644 index e1f7d734f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "EnrolledDevice" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface EnrolledDevice { - id: number; - device: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="id" type={<span>number</span>} required> -</ParamField> - -<ParamField path="device" type={<span>string</span>} required> -</ParamField> - ---- - -**File:** [interfaces/models/user.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/user.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail.mdx deleted file mode 100644 index 21e8228b6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "EnrolledEmail" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface EnrolledEmail { - id: number; - email: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="id" type={<span>number</span>} required> -</ParamField> - -<ParamField path="email" type={<span>string</span>} required> -</ParamField> - ---- - -**File:** [interfaces/models/user.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/user.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber.mdx deleted file mode 100644 index 24643e0fe..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "EnrolledPhoneNumber" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface EnrolledPhoneNumber { - id: number; - phoneNumber: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="id" type={<span>number</span>} required> -</ParamField> - -<ParamField path="phoneNumber" type={<span>string</span>} required> -</ParamField> - ---- - -**File:** [interfaces/models/user.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/user.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection.mdx deleted file mode 100644 index 37c81c70f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "EnterpriseConnection" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface EnterpriseConnection extends Connection { - options: { - iconUrl?: string; - displayName?: string; - showAsButton: boolean; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="options" type="object" required> - <Expandable title="properties"> - <ParamField path="iconUrl" type={<span>string</span>}> - </ParamField> - <ParamField path="displayName" type={<span>string</span>}> - </ParamField> - <ParamField path="showAsButton" type={<span>boolean</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="strategy" type={<span>string</span>} required> -</ParamField> - -<ParamField path="metadata" type={<span>Record<string, string></span>}> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext.mdx deleted file mode 100644 index 4573627a9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "EnterpriseConnectionContext" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface EnterpriseConnectionContext extends Connection { - options: { - icon_url?: string; - display_name?: string; - show_as_button: boolean; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="options" type="object" required> - <Expandable title="properties"> - <ParamField path="icon_url" type={<span>string</span>}> - </ParamField> - <ParamField path="display_name" type={<span>string</span>}> - </ParamField> - <ParamField path="show_as_button" type={<span>boolean</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="strategy" type={<span>string</span>} required> -</ParamField> - -<ParamField path="metadata" type={<span>Record<string, string></span>}> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error.mdx deleted file mode 100644 index a35660b3a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "Error" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface Error { - code: string; - field?: string; - message: string; - rules?: PasswordComplexityRule[]; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="code" type={<span>string</span>} required> -</ParamField> - -<ParamField path="field" type={<span>string</span>}> -</ParamField> - -<ParamField path="message" type={<span>string</span>} required> -</ParamField> - -<ParamField path="rules" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule">PasswordComplexityRule[]</a></span>}> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext.mdx deleted file mode 100644 index 2e8c37e81..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "ExtendedScreenContext" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -interface ExtendedScreenContext extends ScreenContext { - links: { - login: string; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="links" type="object" required> - <Expandable title="properties"> - <ParamField path="login" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a></span>}> -</ParamField> - -<ParamField path="data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData">ScreenData</a></span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string></span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/signup-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext.mdx deleted file mode 100644 index dff5e9cfe..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "ExtendedUntrustedDataContext" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -interface ExtendedUntrustedDataContext extends UntrustedDataContext { - submitted_form_data?: { - /* this object is opt-in */ - email?: string; - phone?: string; - username?: string; - [key: string]: string | undefined; // keys like "ulp_xxx" are allowed - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="submitted_form_data" type="object"> - <Expandable title="properties"> - <ParamField path="phone" type={<span>string</span>}> - </ParamField> - <ParamField path="username" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="authorization_params" type="object"> - <Expandable title="properties"> - <ParamField path="login_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="screen_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="ui_locales" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/screens/signup-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions.mdx deleted file mode 100644 index e99e1b0f4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "FederatedLoginOptions" -description: "Options for performing social login operations" ---- - -<RequestExample> - -```typescript Interface lines -export interface FederatedLoginOptions { - /** The social connection name to use */ - connection: string; - /** Any additional custom options */ - [key: string]: string | number | boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="connection" type={<span>string</span>} required> - The social connection name to use -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean</span>} required> - Any additional custom options -</ParamField> - ---- - -**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions.mdx deleted file mode 100644 index 547259757..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "FederatedSignupOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface FederatedSignupOptions { - connection: string; - [key: string]: string | number | boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="connection" type={<span>string</span>} required> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean</span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/signup.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FlattenedTheme.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FlattenedTheme.mdx deleted file mode 100644 index 262e33dbc..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FlattenedTheme.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "FlattenedTheme" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface FlattenedTheme { - colors: Record<string, string>; - fonts: Record<string, string | number | boolean | object>; - borders: Record<string, string | number | boolean>; - pageBackground: Record<string, string>; - widget: Record<string, string | number>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="colors" type={<span>Record<string, string></span>} required> -</ParamField> - -<ParamField path="fonts" type={<span>Record<string, string | number | boolean | object></span>} required> -</ParamField> - -<ParamField path="borders" type={<span>Record<string, string | number | boolean></span>} required> -</ParamField> - -<ParamField path="pageBackground" type={<span>Record<string, string></span>} required> -</ParamField> - -<ParamField path="widget" type={<span>Record<string, string | number></span>} required> -</ParamField> - ---- - -**File:** [interfaces/common/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/common/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FormOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FormOptions.mdx deleted file mode 100644 index 838c5416f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FormOptions.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "FormOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface FormOptions { - state: string; - telemetry: Array<string>; - useBrowserCapabilities?: boolean; - route?: string; - [key: string]: string | number | boolean | null | undefined | Array<string>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="telemetry" type={<span>Array<string></span>} required> -</ParamField> - -<ParamField path="useBrowserCapabilities" type={<span>boolean</span>}> -</ParamField> - -<ParamField path="route" type={<span>string</span>}> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | null | undefined | Array<string></span>}> -</ParamField> - ---- - -**File:** [interfaces/utils/form-handler.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/form-handler.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier.mdx deleted file mode 100644 index d24a59f9f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "Identifier" -description: "Describes a configured identifier field (e.g. email, phone, or username) for use in a signup form or authentication flow." ---- - -<RequestExample> - -```typescript Interface lines -export interface Identifier { - /** - * The type of identifier, such as `'email'`, `'phone'`, or `'username'`. - * - * @see IdentifierType - */ - type: IdentifierType; - - /** - * Whether this identifier is required for signup. - */ - required: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="type" type={<span>IdentifierType</span>} required> - The type of identifier, such as `'email'`, `'phone'`, or `'username'`. -</ParamField> - -<ParamField path="required" type={<span>boolean</span>} required> - Whether this identifier is required for signup. -</ParamField> - ---- - -**File:** [interfaces/utils/signup-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/InterstitialCaptchaMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/InterstitialCaptchaMembers.mdx deleted file mode 100644 index 96265b6f8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/InterstitialCaptchaMembers.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "InterstitialCaptchaMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface InterstitialCaptchaMembers extends BaseMembers { - submitCaptcha: (payload: SubmitCaptchaOptions) => void; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="submitCaptcha" type={<span>(payload: <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCaptchaOptions">SubmitCaptchaOptions</a>) => void</span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/interstitial-captcha.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Login.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Login.mdx deleted file mode 100644 index dec91fc21..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Login.mdx +++ /dev/null @@ -1,233 +0,0 @@ ---- -title: "Login" -description: "Login screen interface extending base context" ---- - -<RequestExample> - -```typescript Interface lines -export interface Login extends BaseContext { - screen: ScreenContextOnLogin; - transaction: TransactionContextOnLogin; -} -``` - -```typescript Basic Login with Username/Password -import Login from '@auth0/auth0-acul-js/login'; - -const loginManager = new Login(); - -// Handle form submission and error handling -const errors = loginManager.getErrors(); -const handleSubmit = async (e: React.FormEvent) => { - e.preventDefault(); - - try { - await loginManager.login({ - username: 'user@example.com', - password: 'myPassword123' - }); - } catch (error) { - console.error('Login failed:', error); - } -}; - -return ( - <div> - {/* Render the login ID screen content */} - <button onclick={handleLogin}>Continue<button> - {loginIdManager.transaction.hasErrors && errors && ( - // A custom React component that renders a <div> with error details - <ErrorMessages errors={errors} /> - )} - ) -``` - -```typescript Login with Social Provider -import Login from '@auth0/auth0-acul-js/login'; - -const loginManager = new Login(); - -// Handle social login -const handleSocialLogin = async (connection: string) => { - try { - await loginManager.federatedLogin({ - connection: connection // e.g. 'google-oauth2' - }); - } catch (error) { - console.error('Social login failed:', error); - } -}; -``` - -```tsx React Component Example with TailwindCSS -import React, { useState } from 'react'; -import Login from '@auth0/auth0-acul-js/login'; - -const LoginScreen: React.FC = () => { - const [username, setUsername] = useState(''); - const [password, setPassword] = useState(''); - const [error, setError] = useState(''); - - const loginManager = new Login(); - const { transaction } = loginManager; - const activeIdentifiers = useMemo(() => loginManager.getActiveIdentifiers(), []); - - const getIdentifierLabel = () => { - if (activeIdentifiers?.length === 1) return `Enter your ${activeIdentifiers[0]}`; - return `Enter your ${activeIdentifiers?.join(" or ")}`; - }; - - const handleSubmit = async (e: React.FormEvent) => { - e.preventDefault(); - setError(''); - - try { - await loginManager.login({ - username, - password - }); - } catch (error) { - setError('Login failed. Please check your credentials.'); - } - }; - - const handleSocialLogin = async (connection: string) => { - try { - await loginManager.federatedLogin({ connection }); - } catch (error) { - setError('Social login failed. Please try again.'); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - Sign in to your account - </h2> - </div> - - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleSubmit}> - <div> - <label htmlFor="username" className="block text-sm font-medium text-gray-700"> - {getIdentifierLabel()} - </label> - <div className="mt-1"> - <input - id="username" - name="username" - type="text" - required - value={username} - onChange={(e) => setUsername(e.target.value)} - placeholder= {getIdentifierLabel()} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - - <div> - <label htmlFor="password" className="block text-sm font-medium text-gray-700"> - Password - </label> - <div className="mt-1"> - <input - id="password" - name="password" - type="password" - required - value={password} - onChange={(e) => setPassword(e.target.value)} - className="appearance-none block w-full px-3 py-2 border border-gray-300 rounded-md shadow-sm placeholder-gray-400 focus:outline-none focus:ring-blue-500 focus:border-blue-500" - /> - </div> - </div> - - {error && ( - <div className="text-red-600 text-sm"> - {error} - </div> - )} - - <div> - <button - type="submit" - className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Sign in - </button> - </div> - </form> - - {transaction.alternateConnections && transaction.alternateConnections.length > 0 && ( - <div className="mt-6"> - <div className="relative"> - <div className="absolute inset-0 flex items-center"> - <div className="w-full border-t border-gray-300" /> - </div> - <div className="relative flex justify-center text-sm"> - <span className="px-2 bg-white text-gray-500"> - Or continue with - </span> - </div> - </div> - - <div className="mt-6 grid grid-cols-3 gap-3"> - {transaction.alternateConnections.map((connection) => ( - <button - key={connection.name} - onClick={() => handleSocialLogin(connection.name)} - className="w-full inline-flex justify-center py-2 px-4 border border-gray-300 rounded-md shadow-sm bg-white text-sm font-medium text-gray-500 hover:bg-gray-50" - > - {connection.name} - </button> - ))} - </div> - </div> - )} - </div> - </div> - </div> - ); -}; - -export default LoginScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLogin">ScreenContextOnLogin</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLogin">TransactionContextOnLogin</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> -</ParamField> - -<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEmailVerificationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEmailVerificationMembers.mdx deleted file mode 100644 index 6e44163f6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEmailVerificationMembers.mdx +++ /dev/null @@ -1,149 +0,0 @@ ---- -title: "LoginEmailVerificationMembers" -description: "@interface LoginEmailVerificationMembers description Defines the members (properties and methods) available for interacting with the Login Email Verification screen. This screen is a crucial part of email verification processes, typically during login, where a user must prove ownership of an email address by providing a one-time code. The SDK facilitates submitting this code or requesting a new one. The `universal_login_context` for this screen (`window.universal_login_context`) will contain: - `client`: Information about the Auth0 application. - `organization` (optional): Details if the authentication is for a specific organization. - `prompt`: Context of the current authentication prompt (e.g., 'login'). - `screen`: UI texts and general screen information. No screen-specific `data` fields are uniquely defined for `login-email-verification` beyond standard ones. - `transaction`: Details of the ongoing transaction, including state and any errors from previous attempts (e.g., \"invalid-code\")." ---- - -<RequestExample> - -```typescript Interface lines -export interface LoginEmailVerificationMembers extends BaseMembers { - /** - * Submits the email verification code entered by the user. - * This action corresponds to the user entering the code they received via email and - * clicking a "Continue" or "Verify" button. The SDK will then POST this code - * to the Auth0 `/u/login-email-verification` endpoint. - * - * If the code is valid, Auth0 will typically redirect the user to the next step in the - * authentication flow. If the code is invalid, expired, or another error occurs, - * Auth0 will usually re-render the login-email-verification screen, and the - * `transaction.errors` array in the SDK's context will be updated with details - * about the failure (e.g., error code `invalid-code`). - * - * @param {ContinueWithCodeOptions} payload - An object containing the `code` string entered by the user. - * It can also include any `CustomOptions` for extensibility. - * @returns {Promise<void>} A promise that resolves when the form submission is initiated. - * It does not return data directly upon resolution, as a redirect or - * page re-render is the common outcome. - * @throws {Error} Throws an error if `payload.code` is not provided or is not a string, - * or if the `FormHandler` encounters an unrecoverable issue during submission (e.g., network error). - * Validation errors from Auth0 (like an invalid code) are not thrown as JavaScript errors - * but are reflected in `this.transaction.errors` after the operation. - * - * @example - * ```typescript - * // Assuming 'manager' is an instance of LoginEmailVerification - * const userInputCode = "123456"; - * try { - * await manager.continueWithCode({ code: userInputCode }); - * // If successful, page redirects. No further client-side action needed here. - * } catch (error) { - * // This catch is for unexpected errors, not for Auth0 validation errors. - * console.error("Failed to submit the verification code:", error); - * } - * // After the await, always check manager.transaction.errors for server-side validation issues. - * if (manager.transaction.errors && manager.transaction.errors.length > 0) { - * manager.transaction.errors.forEach(err => { - * if (err.code === 'invalid-code') { - * // Display "The code you entered is invalid" to the user. - * } - * }); - * } - * ``` - */ - continueWithCode(payload: ContinueWithCodeOptions): Promise<void>; - - /** - * Requests a new verification code to be sent to the user's email address. - * This action is typically invoked when the user clicks a "Resend Code" button, perhaps because - * they didn't receive the first email, the code expired, or they suspect an issue. - * The SDK will POST to the Auth0 `/u/login-email-verification` endpoint with an action indicating - * a resend request. - * - * Upon successful submission of this request, Auth0 attempts to send a new email. - * The page may re-render. If there are issues (e.g., too many resend attempts for the same email, - * identified by error code `too-many-emails`), `transaction.errors` will be updated. - * - * @param {ResendCodeOptions} [payload] - Optional. An object for `CustomOptions` if any - * additional parameters need to be sent with the request. - * @returns {Promise<void>} A promise that resolves when the resend request is initiated. - * Like `continueWithCode`, this usually results in a page re-render or state update - * rather than direct data in the promise resolution. - * @throws {Error} Throws if the `FormHandler` encounters an unrecoverable issue (e.g., network error). - * Server-side errors (like rate limits) are reflected in `this.transaction.errors`. - * - * @example - * ```typescript - * // Assuming 'manager' is an instance of LoginEmailVerification - * try { - * await manager.resendCode(); - * // Optionally, update UI to inform the user a new code has been sent. - * alert("A new verification code has been dispatched to your email."); - * } catch (error) { - * console.error("Failed to request a new code:", error); - * } - * // After the await, check manager.transaction.errors for server-side issues. - * if (manager.transaction.errors && manager.transaction.errors.length > 0) { - * manager.transaction.errors.forEach(err => { - * if (err.code === 'too-many-emails') { - * // Display "You have requested too many emails. Please wait a few minutes." - * } - * }); - * } - * ``` - */ - resendCode(payload?: ResendCodeOptions): Promise<void>; - - /** - * Gets resend functionality with timeout management for this screen - * @param options Configuration options for resend functionality - */ - resendManager(options?: StartResendOptions): ResendControl; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="continueWithCode" type={<span>Promise<void></span>} required> - Submits the email verification code entered by the user. This action corresponds to the user entering the code they received via email and clicking a "Continue" or "Verify" button. The SDK will then POST this code to the Auth0 `/u/login-email-verification` endpoint. If the code is valid, Auth0 will typically redirect the user to the next step in the authentication flow. If the code is invalid, expired, or another error occurs, Auth0 will usually re-render the login-email-verification screen, and the `transaction.errors` array in the SDK's context will be updated with details about the failure (e.g., error code `invalid-code`). -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>} required> - Requests a new verification code to be sent to the user's email address. This action is typically invoked when the user clicks a "Resend Code" button, perhaps because they didn't receive the first email, the code expired, or they suspect an issue. The SDK will POST to the Auth0 `/u/login-email-verification` endpoint with an action indicating a resend request. Upon successful submission of this request, Auth0 attempts to send a new email. The page may re-render. If there are issues (e.g., too many resend attempts for the same email, identified by error code `too-many-emails`), `transaction.errors` will be updated. -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> - Gets resend functionality with timeout management for this screen -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/login-email-verification.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEnrollOptions.mdx deleted file mode 100644 index 72e01047a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEnrollOptions.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "LoginEnrollOptions" -description: "Options for continuing with a selected MFA factor" ---- - -<RequestExample> - -```typescript Interface lines -export interface LoginEnrollOptions { - /** The action indicating which factor to use for login */ - action: MfaLoginFactorType; - /** Any additional custom options */ - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="action" type={<span>MfaLoginFactorType</span>} required> - The action indicating which factor to use for login -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> - Any additional custom options -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-login-options.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginId.mdx deleted file mode 100644 index 543f08eac..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginId.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: "LoginId" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface LoginId extends BaseContext { - screen: ExtendedScreenContext; - untrustedData?: ExtendedUntrustedDataContext; -} -``` - -```typescript login -import LoginId from "@auth0/auth0-acul-js/login-id" - -const loginIdManager = new LoginId(); - -loginIdManager.login({ - username: "testUser" -}) -``` - -```typescript error handling -import LoginId from "@auth0/auth0-acul-js/login-id" - -const loginIdManager = new LoginId(); -const errors = loginIdManager.getErrors(); - -loginIdManager.login({ - username: "testUser" -}) - -return ( - <div> - {/* Render the login ID screen content */} - <button onclick={handleLogin}>Continue<button> - {loginIdManager.transaction.hasErrors && errors && ( - // A custom React component that renders a <div> with error details - <ErrorMessages errors={errors} /> - )} -) -``` - -```typescript federatedLogin -import LoginId from "@auth0/auth0-acul-js/login-id"; -const loginIdManager = new LoginId(); - -// Check if alternateConnections is available and has at least one item -if (!loginIdManager.transaction.alternateConnections) { - console.error('No alternate connections available.'); -} - -// Select the first available connection (users can select any available connection) -const selectedConnection = alternateConnections[0]; - -// Log the chosen connection for debugging or informational purposes -console.log(`Selected connection: ${selectedConnection.name}`); - -// Proceed with federated login using the selected connection -loginIdManager.federatedLogin({ - connection: selectedConnection.name, -}) -``` - -```typescript passkeyLogin -import LoginId from "@auth0/auth0-acul-js/login-id"; -const loginIdManager = new LoginId(); - -// it internally maps users available passkey config provided from auth0 server -loginIdManager.passkeyLogin(); -``` - -```typescript pickCountryCode -import LoginId from "@auth0/auth0-acul-js/login-id"; -const loginIdManager = new LoginId(); - -loginIdManager.pickCountryCode(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext">ExtendedScreenContext</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext">ExtendedUntrustedDataContext</a></span>}> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> -</ParamField> - -<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginIdMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginIdMembers.mdx deleted file mode 100644 index d2ec6b97e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginIdMembers.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "LoginIdMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface LoginIdMembers extends BaseMembers { - screen: ScreenMembersOnLoginId; - transaction: TransactionMembersOnLoginId; - login(payload: LoginOptions): Promise<void>; - federatedLogin(payload: FederatedLoginOptions): Promise<void>; - passkeyLogin(payload?: CustomOptions): Promise<void>; - pickCountryCode(payload?: CustomOptions): Promise<void>; - getLoginIdentifiers(): IdentifierType[] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginId">ScreenMembersOnLoginId</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId">TransactionMembersOnLoginId</a></span>} required> -</ParamField> - -<ParamField path="login" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="federatedLogin" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="passkeyLogin" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="pickCountryCode" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="getLoginIdentifiers" type={<span>IdentifierType[] | null</span>}> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/login-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginMembers.mdx deleted file mode 100644 index 4fb07600a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginMembers.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "LoginMembers" -description: "Login screen members interface extending base members" ---- - -<RequestExample> - -```typescript Interface lines -export interface LoginMembers extends BaseMembers { - screen: ScreenMembersOnLogin; - transaction: TransactionMembersOnLogin; - /** - * Performs login with username/password - * @param payload The login options - */ - login(payload: LoginOptions): Promise<void>; - /** - * Performs login with social provider - * @param payload The social login options - */ - federatedLogin(payload: FederatedLoginOptions): Promise<void>; - /** - * Picks country code for phone number input - * @param payload Optional custom options - */ - pickCountryCode(payload?: CustomOptions): Promise<void>; - /** - * Gets the active identifier types for the login screen - * @returns An array of active identifier types or null if none are active - * @utilityFeature - */ - getLoginIdentifiers(): IdentifierType[] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLogin">ScreenMembersOnLogin</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLogin">TransactionMembersOnLogin</a></span>} required> -</ParamField> - -<ParamField path="login" type={<span>Promise<void></span>} required> - Performs login with username/password -</ParamField> - -<ParamField path="federatedLogin" type={<span>Promise<void></span>} required> - Performs login with social provider -</ParamField> - -<ParamField path="pickCountryCode" type={<span>Promise<void></span>} required> - Picks country code for phone number input -</ParamField> - -<ParamField path="getLoginIdentifiers" type={<span>IdentifierType[] | null</span>}> - Gets the active identifier types for the login screen -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions.mdx deleted file mode 100644 index 0ab04b08e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "LoginOptions" -description: "Options for performing login operations" ---- - -<RequestExample> - -```typescript Interface lines -export interface LoginOptions { - /** The username/email to login with */ - username: string; - /** The password for authentication */ - password: string; - /** Optional captcha value if required */ - captcha?: string; - /** Any additional custom options */ - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="username" type={<span>string</span>} required> - The username/email to login with -</ParamField> - -<ParamField path="password" type={<span>string</span>} required> - The password for authentication -</ParamField> - -<ParamField path="captcha" type={<span>string</span>}> - Optional captcha value if required -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> - Any additional custom options -</ParamField> - ---- - -**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPassword.mdx deleted file mode 100644 index dca537541..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPassword.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "LoginPassword" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface LoginPassword extends BaseContext { - screen: ScreenContextOnLoginPassword; - transaction: TransactionContextOnLoginPassword; -} -``` - -```typescript login -import LoginPassword from "@auth0/auth0-acul-js/login-password" - -const loginPasswordManager = new LoginPassword(); - -loginPasswordManager.login({ - username: "testUser", - password: "******" -}); -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPassword">ScreenContextOnLoginPassword</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLoginPassword">TransactionContextOnLoginPassword</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> -</ParamField> - -<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordMembers.mdx deleted file mode 100644 index 4c009dce3..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordMembers.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "LoginPasswordMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface LoginPasswordMembers extends BaseMembers { - screen: ScreenMembersOnLoginPassword; - transaction: TransactionMembersOnLoginPassword; - login(payload: LoginPasswordOptions): Promise<void>; - federatedLogin(payload: FederatedLoginOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPassword">ScreenMembersOnLoginPassword</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPassword">TransactionMembersOnLoginPassword</a></span>} required> -</ParamField> - -<ParamField path="login" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="federatedLogin" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/login-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordOptions.mdx deleted file mode 100644 index f65b04f59..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordOptions.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "LoginPasswordOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface LoginPasswordOptions { - username: string; - password: string; - captcha?: string; - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="username" type={<span>string</span>} required> -</ParamField> - -<ParamField path="password" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captcha" type={<span>string</span>}> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessEmailCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessEmailCodeMembers.mdx deleted file mode 100644 index d344de95a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessEmailCodeMembers.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "LoginPasswordlessEmailCodeMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface LoginPasswordlessEmailCodeMembers extends BaseMembers { - screen: ScreenMembersOnLoginPasswordlessEmailCode; - transaction: TransactionMembersOnLoginPasswordlessEmailCode; - submitCode(payload: SubmitCodeOptions): Promise<void>; - resendCode(payload?: CustomOptions): Promise<void>; - resendManager(options?: StartResendOptions): ResendControl; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessEmailCode">ScreenMembersOnLoginPasswordlessEmailCode</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessEmailCode">TransactionMembersOnLoginPasswordlessEmailCode</a></span>} required> -</ParamField> - -<ParamField path="submitCode" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/login-passwordless-email-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessSmsOtpMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessSmsOtpMembers.mdx deleted file mode 100644 index 155770b9c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessSmsOtpMembers.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "LoginPasswordlessSmsOtpMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface LoginPasswordlessSmsOtpMembers extends BaseMembers { - screen: ScreenMembersOnLoginPasswordlessSmsOtp; - transaction: TransactionMembersOnLoginPasswordlessSmsOtp; - submitOTP(payload: SubmitOTPOptions): Promise<void>; - resendOTP(payload?: CustomOptions): Promise<void>; - /** - * Gets resend functionality with timeout management for this screen - * @param options Configuration options for resend functionality - */ - resendManager(options?: StartResendOptions): ResendControl; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp">ScreenMembersOnLoginPasswordlessSmsOtp</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp">TransactionMembersOnLoginPasswordlessSmsOtp</a></span>} required> -</ParamField> - -<ParamField path="submitOTP" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="resendOTP" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> - Gets resend functionality with timeout management for this screen -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/login-passwordless-sms-otp.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutAbortedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutAbortedMembers.mdx deleted file mode 100644 index 79475f02b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutAbortedMembers.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "LogoutAbortedMembers" -description: "Interface defining the available methods and properties for the logout-aborted screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface LogoutAbortedMembers extends BaseMembers {} -``` - -</RequestExample> - -## Properties - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/logout-aborted.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/logout-aborted.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutCompleteMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutCompleteMembers.mdx deleted file mode 100644 index b92cdc904..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutCompleteMembers.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "LogoutCompleteMembers" -description: "Interface defining the available methods and properties for the logout-complete screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface LogoutCompleteMembers extends BaseMembers {} -``` - -</RequestExample> - -## Properties - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/logout-complete.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/logout-complete.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutMembers.mdx deleted file mode 100644 index 66d8ca257..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutMembers.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "LogoutMembers" -description: "Interface defining the available methods and properties for the logout screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface LogoutMembers extends BaseMembers { - /** - * Confirms the logout action (accept or deny) - * @param payload The options containing the action to perform - */ - confirmLogout(payload: ConfirmLogoutOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="confirmLogout" type={<span>Promise<void></span>} required> - Confirms the logout action (accept or deny) -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/logout.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/logout.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaBeginEnrollOptionsMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaBeginEnrollOptionsMembers.mdx deleted file mode 100644 index db4cda74c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaBeginEnrollOptionsMembers.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "MfaBeginEnrollOptionsMembers" -description: "MFA Begin Enroll Options screen members interface" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaBeginEnrollOptionsMembers extends BaseMembers { - /** - * Continues the enrollment process with the selected factor - * @param payload The enrollment options including the selected factor - */ - enroll(payload: MfaEnrollOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="enroll" type={<span>Promise<void></span>} required> - Continues the enrollment process with the selected factor -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-begin-enroll-options.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaCountryCodesMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaCountryCodesMembers.mdx deleted file mode 100644 index 72ff74d26..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaCountryCodesMembers.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "MfaCountryCodesMembers" -description: "Interface defining the available methods and properties for the mfa-country-codes screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaCountryCodesMembers extends BaseMembers { - screen: ScreenMembersOnMfaCountryCodes; - /** - * Selects a country code from the available options - * @param payload The options containing the country code selection action - */ - selectCountryCode(payload: SelectCountryCodeOptions): Promise<void>; - /** - * Navigates back to the previous screen - * @param payload Optional custom options to include with the request - */ - goBack(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaCountryCodes">ScreenMembersOnMfaCountryCodes</a></span>} required> -</ParamField> - -<ParamField path="selectCountryCode" type={<span>Promise<void></span>} required> - Selects a country code from the available options -</ParamField> - -<ParamField path="goBack" type={<span>Promise<void></span>} required> - Navigates back to the previous screen -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-country-codes.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx deleted file mode 100644 index db7cfcc0a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "MfaDetectBrowserCapabilitiesMembers" -description: "Interface defining the available methods and properties for the mfa-detect-browser-capabilities screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaDetectBrowserCapabilitiesMembers extends BaseMembers { - /** - * Picks an authenticator based on browser capabilities - * @param payload The options containing browser capability flags - * @example - * ```typescript - * const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); - * await mfaDetectBrowserCapabilities.detectCapabilities(); - * ``` - */ - detectCapabilities(payload: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="detectCapabilities" type={<span>Promise<void></span>} required> - Picks an authenticator based on browser capabilities -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-detect-browser-capabilities.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-detect-browser-capabilities.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailChallengeMembers.mdx deleted file mode 100644 index 4d262ec8e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailChallengeMembers.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: "MfaEmailChallengeMembers" -description: "Interface defining the available methods and properties for the mfa-email-challenge screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaEmailChallengeMembers extends BaseMembers { - screen: ScreenMembersOnMfaEmailChallenge; - untrustedData: UntrustedDataMembersOnMfaEmailChallenge; - - /** - * Continues with the email challenge using the provided code - * @param payload The options containing the code and rememberDevice flag - */ - continue(payload: ContinueOptions): Promise<void>; - - /** - * Resends the email code - * @param payload Optional custom options to include with the request - */ - resendCode(payload?: ResendCodeOptions): Promise<void>; - - /** - * Allows the user to try another MFA method - * @param payload Optional custom options to include with the request - */ - tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; - - /** - * Submits the action to pick a different Email configuration, if available - * @param payload Optional custom options to include with the request - */ - pickEmail(payload?: CustomOptions): Promise<void>; - - /** - * Gets resend functionality with timeout management for this screen - * @param options Configuration options for resend functionality - */ - resendManager(options?: StartResendOptions): ResendControl; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailChallenge">ScreenMembersOnMfaEmailChallenge</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaEmailChallenge">UntrustedDataMembersOnMfaEmailChallenge</a></span>} required> -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Continues with the email challenge using the provided code -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>} required> - Resends the email code -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows the user to try another MFA method -</ParamField> - -<ParamField path="pickEmail" type={<span>Promise<void></span>} required> - Submits the action to pick a different Email configuration, if available -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> - Gets resend functionality with timeout management for this screen -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-email-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailListMembers.mdx deleted file mode 100644 index bfd36ede8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailListMembers.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "MfaEmailListMembers" -description: "Interface defining the available methods and properties for the mfa-email-list screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaEmailListMembers extends BaseMembers { - screen: ScreenMembersOnMfaEmailList; - /** - * Selects an enrolled email address from the list - * @param payload The options containing the selection action - */ - selectMfaEmail(payload: SelectMfaEmailOptions): Promise<void>; - /** - * Navigates back to the previous screen - * @param payload Optional custom options to include with the request - */ - goBack(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailList">ScreenMembersOnMfaEmailList</a></span>} required> -</ParamField> - -<ParamField path="selectMfaEmail" type={<span>Promise<void></span>} required> - Selects an enrolled email address from the list -</ParamField> - -<ParamField path="goBack" type={<span>Promise<void></span>} required> - Navigates back to the previous screen -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-email-list.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollOptions.mdx deleted file mode 100644 index d44e97b08..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollOptions.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "MfaEnrollOptions" -description: "Options for continuing with factor enrollment" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaEnrollOptions { - /** The action indicating which factor to enroll */ - action: MfaEnrollFactorType; - /** Any additional custom options */ - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="action" type={<span>MfaEnrollFactorType</span>} required> - The action indicating which factor to enroll -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> - Any additional custom options -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-begin-enroll-options.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollResultMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollResultMembers.mdx deleted file mode 100644 index c2c348247..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollResultMembers.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "MfaEnrollResultMembers" -description: "@interface MfaEnrollResultMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaEnrollResultMembers extends BaseMembers { - /** - * Provides access to the specific properties and data of the MFA Enroll Result screen, - * including the enrollment `status` (via `screen.data.status`). - * @type {ScreenMembersOnMfaEnrollResult} - */ - screen: ScreenMembersOnMfaEnrollResult; - - // No specific operations (methods) are typically defined for this screen as it's informational. - // The user might be automatically redirected or provided a button to continue, - // which would usually be a simple navigation handled by the page template or a default action. -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEnrollResult">ScreenMembersOnMfaEnrollResult</a></span>} required> - Provides access to the specific properties and data of the MFA Enroll Result screen, including the enrollment `status` (via `screen.data.status`). -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-enroll-result.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaLoginOptionsMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaLoginOptionsMembers.mdx deleted file mode 100644 index 86998b2e0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaLoginOptionsMembers.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "MfaLoginOptionsMembers" -description: "Interface defining the available methods and properties for the mfa-login-options screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaLoginOptionsMembers extends BaseMembers { - screen: ScreenMembersOnMfaLoginOptions; - /** - * Continues the login process with the selected MFA factor - * @param payload The options containing the selected factor - * @example - * ```typescript - * const mfaLoginOptions = new MfaLoginOptions(); - * await mfaLoginOptions.enroll({ - * action: 'push-notification' - * }); - * ``` - */ - enroll(payload: LoginEnrollOptions): Promise<void>; - /** - * Returns to the previous screen in the authentication flow - * @param payload Optional custom options - * @example - * ```typescript - * const mfaLoginOptions = new MfaLoginOptions(); - * await mfaLoginOptions.returnToPrevious(); - * ``` - */ - returnToPrevious(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaLoginOptions">ScreenMembersOnMfaLoginOptions</a></span>} required> -</ParamField> - -<ParamField path="enroll" type={<span>Promise<void></span>} required> - Continues the login process with the selected MFA factor -</ParamField> - -<ParamField path="returnToPrevious" type={<span>Promise<void></span>} required> - Returns to the previous screen in the authentication flow -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-login-options.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpChallengeMembers.mdx deleted file mode 100644 index 14d6bbf6b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpChallengeMembers.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "MfaOtpChallengeMembers" -description: "Interface defining the available methods and properties for the mfa-otp-challenge screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaOtpChallengeMembers extends BaseMembers { - screen: ScreenMembersOnMfaOtpChallenge; - untrustedData: UntrustedDataMembersOnMfaOtpChallenge; - - /** - * Continues with the OTP challenge using the provided code - * @param payload The options containing the code and rememberDevice flag - */ - continue(payload: ContinueOptions): Promise<void>; - - /** - * Allows the user to try another MFA method - * @param payload Optional custom options to include with the request - */ - tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpChallenge">ScreenMembersOnMfaOtpChallenge</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaOtpChallenge">UntrustedDataMembersOnMfaOtpChallenge</a></span>} required> -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Continues with the OTP challenge using the provided code -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows the user to try another MFA method -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-otp-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentCodeMembers.mdx deleted file mode 100644 index e83fb1cda..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentCodeMembers.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "MfaOtpEnrollmentCodeMembers" -description: "Interface defining the available methods and properties for the mfa-otp-enrollment-code screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaOtpEnrollmentCodeMembers extends BaseMembers { - /** - * The screen properties for the mfa-otp-enrollment-code screen. - */ - screen: ScreenMembersOnMfaOtpEnrollmentCode; - - /** - * Continues the MFA OTP enrollment process by submitting the OTP code. - * @param payload The options containing the OTP code. - */ - continue(payload: ContinueOptions): Promise<void>; - - /** - * Allows the user to try another MFA method. - * @param payload Optional custom options to include with the request. - */ - tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentCode">ScreenMembersOnMfaOtpEnrollmentCode</a></span>} required> - The screen properties for the mfa-otp-enrollment-code screen. -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Continues the MFA OTP enrollment process by submitting the OTP code. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows the user to try another MFA method. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-otp-enrollment-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentQrMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentQrMembers.mdx deleted file mode 100644 index 57e7a135d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentQrMembers.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "MfaOtpEnrollmentQrMembers" -description: "Interface defining the available methods and properties for the mfa-otp-enrollment-qr screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaOtpEnrollmentQrMembers extends BaseMembers { - screen: ScreenMembersOnMfaOtpEnrollmentQr; - - /** - * Toggles the view. - * @param payload Optional custom options to include with the request - */ - toggleView(payload?: CustomOptions): Promise<void>; - - /** - * Continues with the default action. - * @param payload Payload containing code and optional custom options - */ - continue(payload: ContinueOptions): Promise<void>; - - /** - * Allows trying another authentication method - * @param payload Optional custom options to include with the request - */ - tryAnotherMethod(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentQr">ScreenMembersOnMfaOtpEnrollmentQr</a></span>} required> -</ParamField> - -<ParamField path="toggleView" type={<span>Promise<void></span>} required> - Toggles the view. -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Continues with the default action. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows trying another authentication method -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-otp-enrollment-qr.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneChallengeMembers.mdx deleted file mode 100644 index 58ba9d8ff..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneChallengeMembers.mdx +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: "MfaPhoneChallengeMembers" -description: "@interface MfaPhoneChallengeMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaPhoneChallengeMembers extends BaseMembers { - /** - * @property {ScreenMembersOnMfaPhoneChallenge} screen - Specific screen information for the MFA Phone Challenge. - */ - screen: ScreenMembersOnMfaPhoneChallenge; - - /** - * continue - * Submits the choice of MFA delivery method (SMS or Voice) to proceed with the challenge. - * This will trigger sending the verification code to the user's phone. - * - * @param {ContinueOptions} payload - The options specifying the delivery type ('sms' or 'voice'). - * @returns {Promise<void>} A promise that resolves when the action is submitted. - * @throws {Error} Throws an error if the submission fails. - * @example - * ```typescript - * import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; - * - * const mfaPhoneChallenge = new MfaPhoneChallenge(); - * - * // To send the code via SMS - * await mfaPhoneChallenge.continue({ type: 'sms' }); - * - * // To send the code via Voice Call - * await mfaPhoneChallenge.continue({ type: 'voice' }); - * ``` - */ - continue(payload: ContinueOptions): Promise<void>; - - /** - * pickPhone - * Initiates the action to pick a different phone number. - * This typically redirects the user to a screen where they can select from multiple enrolled phone numbers, if applicable. - * - * @param {PickPhoneOptions} [payload] - Optional custom options to include with the request. - * @returns {Promise<void>} A promise that resolves when the action is submitted. - * @throws {Error} Throws an error if the submission fails. - * @example - * ```typescript - * import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; - * - * const mfaPhoneChallenge = new MfaPhoneChallenge(); - * await mfaPhoneChallenge.pickPhone(); - * ``` - */ - pickPhone(payload?: PickPhoneOptions): Promise<void>; - - /** - * tryAnotherMethod - * Initiates the action to select a different MFA factor/authenticator. - * This redirects the user to a screen where they can choose an alternative MFA method (e.g., OTP app, recovery code). - * - * @param {PickAuthenticatorOptions} [payload] - Optional custom options to include with the request. - * @returns {Promise<void>} A promise that resolves when the action is submitted. - * @throws {Error} Throws an error if the submission fails. - * @example - * ```typescript - * import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; - * - * const mfaPhoneChallenge = new MfaPhoneChallenge(); - * await mfaPhoneChallenge.tryAnotherMethod(); - * ``` - */ - tryAnotherMethod(payload?: PickAuthenticatorOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPhoneChallenge">ScreenMembersOnMfaPhoneChallenge</a></span>} required> - Specific screen information for the MFA Phone Challenge. -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - continue Submits the choice of MFA delivery method (SMS or Voice) to proceed with the challenge. This will trigger sending the verification code to the user's phone. -</ParamField> - -<ParamField path="pickPhone" type={<span>Promise<void></span>} required> - pickPhone Initiates the action to pick a different phone number. This typically redirects the user to a screen where they can select from multiple enrolled phone numbers, if applicable. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - tryAnotherMethod Initiates the action to select a different MFA factor/authenticator. This redirects the user to a screen where they can choose an alternative MFA method (e.g., OTP app, recovery code). -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-phone-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneEnrollmentMembers.mdx deleted file mode 100644 index 826c499ad..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneEnrollmentMembers.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: "MfaPhoneEnrollmentMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaPhoneEnrollmentMembers extends BaseMembers { - client: ClientMembers; - organization: OrganizationMembers; - prompt: PromptMembers; - screen: ScreenMembers; - transaction: TransactionMembers; - - /** - * Selects the country code for the phone number. - * @param payload Optional custom options to include with the request. - */ - pickCountryCode(payload?: CustomOptions): Promise<void>; - - /** - * Continues the enrollment process with the provided phone number and type (SMS or voice). - * @param payload The phone number, type, and optional custom options. - */ - continueEnrollment(payload: ContinueOptions): Promise<void>; - - /** - * Allows the user to try another MFA method. - * @param payload Optional custom options to include with the request. - */ - tryAnotherMethod(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="pickCountryCode" type={<span>Promise<void></span>} required> - Selects the country code for the phone number. -</ParamField> - -<ParamField path="continueEnrollment" type={<span>Promise<void></span>} required> - Continues the enrollment process with the provided phone number and type (SMS or voice). -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows the user to try another MFA method. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-phone-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushChallengePushMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushChallengePushMembers.mdx deleted file mode 100644 index 1cbe85632..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushChallengePushMembers.mdx +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: "MfaPushChallengePushMembers" -description: "Interface defining the available methods and properties for the mfa-push-challenge-push screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaPushChallengePushMembers extends BaseMembers { - screen: ScreenMembersOnMfaPushChallengePush; - untrustedData: UntrustedDataMembersOnMfaPushChallengePush; - - /** - * Continues with the push notification challenge - * @param payload Optional custom options to include with the request - */ - continue(payload?: WithRememberOptions): Promise<void>; - - /** - * Resends the push notification - * @param payload Optional custom options to include with the request - */ - resendPushNotification(payload?: WithRememberOptions): Promise<void>; - - /** - * Switches to entering the verification code manually - * @param payload Optional custom options to include with the request - */ - enterCodeManually(payload?: CustomOptions): Promise<void>; - - /** - * Allows trying another authentication method - * @param payload Optional custom options to include with the request - */ - tryAnotherMethod(payload?: CustomOptions): Promise<void>; - - /** - * Manages polling for MFA push challenge status - * @param options Configuration options for polling of type {@link MfaPollingOptions} - * @returns An object to control the polling process - */ - pollingManager(options: MfaPollingOptions): MfaPushPollingControl; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushChallengePush">ScreenMembersOnMfaPushChallengePush</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaPushChallengePush">UntrustedDataMembersOnMfaPushChallengePush</a></span>} required> -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Continues with the push notification challenge -</ParamField> - -<ParamField path="resendPushNotification" type={<span>Promise<void></span>} required> - Resends the push notification -</ParamField> - -<ParamField path="enterCodeManually" type={<span>Promise<void></span>} required> - Switches to entering the verification code manually -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows trying another authentication method -</ParamField> - -<ParamField path="pollingManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>} required> - Manages polling for MFA push challenge status -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-push-challenge-push.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushEnrollmentQrMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushEnrollmentQrMembers.mdx deleted file mode 100644 index 59eb3c4f7..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushEnrollmentQrMembers.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "MfaPushEnrollmentQrMembers" -description: "Interface defining the available methods and properties for the mfa-push-enrollment-qr screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaPushEnrollmentQrMembers extends BaseMembers { - screen: ScreenMembersOnMfaPushEnrollmentQr; - /** - * Navigates to the authenticator selection screen. - * @param payload Optional custom options to include with the request - */ - pickAuthenticator(payload?: CustomOptions): Promise<void>; - - pollingManager(options: MfaPollingOptions): MfaPushPollingControl; - -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushEnrollmentQr">ScreenMembersOnMfaPushEnrollmentQr</a></span>} required> -</ParamField> - -<ParamField path="pickAuthenticator" type={<span>Promise<void></span>} required> - Navigates to the authenticator selection screen. -</ParamField> - -<ParamField path="pollingManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-push-enrollment-qr.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushListMembers.mdx deleted file mode 100644 index c84213342..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushListMembers.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "MfaPushListMembers" -description: "Interface defining the available methods and properties for the mfa-push-list screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaPushListMembers extends BaseMembers { - /** - * Selects a registered device from the list to initiate MFA push. - * @param payload The options containing the device index. - */ - selectMfaPushDevice(payload: SelectMfaPushDeviceOptions): Promise<void>; - /** - * Navigates back to the previous screen. - * @param payload Optional custom options to include with the request. - */ - goBack(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="selectMfaPushDevice" type={<span>Promise<void></span>} required> - Selects a registered device from the list to initiate MFA push. -</ParamField> - -<ParamField path="goBack" type={<span>Promise<void></span>} required> - Navigates back to the previous screen. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-push-list.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl.mdx deleted file mode 100644 index 9db41553d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "MfaPushPollingControl" -description: "Control interface for managing an MFA push-notification polling session. This interface provides imperative methods to start, stop, and inspect the status of a long-running polling loop that checks whether an MFA push challenge has been approved." ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaPushPollingControl { - /** - * Stops the polling process immediately. - * - * - Cancels any scheduled timer or pending request. - * - Once stopped, `isRunning()` returns `false`. - * - Safe to call multiple times; subsequent calls have no effect. - * - * @example - * ```ts - * const control = mfaPushChallengePush.pollingManager({ intervalMs: 5000 }); - * control.startPolling(); - * - * // Later, if the user cancels: - * control.stopPolling(); - * ``` - */ - stopPolling: () => void; - - /** - * Starts or resumes the polling process. - * - * - If polling is already active, calling this again has no effect. - * - If previously stopped, calling this restarts the polling loop. - * - * @example - * ```ts - * control.startPolling(); // Begin checking the MFA push challenge - * ``` - */ - startPolling: () => void; - - /** - * Indicates whether the polling process is currently running. - * - * - Returns `true` if polling is active and not cancelled. - * - Returns `false` if polling has been stopped or has completed. - * - * @example - * ```ts - * if (control.isRunning()) { - * console.log('Polling in progress...'); - * } else { - * console.log('Polling is stopped or completed.'); - * } - * ``` - */ - isRunning: () => boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="stopPolling" type={<span>() => void</span>} required> - Stops the polling process immediately. - Cancels any scheduled timer or pending request. - Once stopped, `isRunning()` returns `false`. - Safe to call multiple times; subsequent calls have no effect. -</ParamField> - -<ParamField path="startPolling" type={<span>() => void</span>} required> - Starts or resumes the polling process. - If polling is already active, calling this again has no effect. - If previously stopped, calling this restarts the polling loop. -</ParamField> - -<ParamField path="isRunning" type={<span>() => boolean</span>} required> - Indicates whether the polling process is currently running. - Returns `true` if polling is active and not cancelled. - Returns `false` if polling has been stopped or has completed. -</ParamField> - ---- - -**File:** [interfaces/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeMembers.mdx deleted file mode 100644 index 58f3e0d1e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeMembers.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "MfaPushWelcomeMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaPushWelcomeMembers extends BaseMembers { - screen: ScreenMembersOnMfaPushWelcome; - enroll(payload?: CustomOptions): Promise<void>; - pickAuthenticator(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushWelcome">ScreenMembersOnMfaPushWelcome</a></span>} required> -</ParamField> - -<ParamField path="enroll" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="pickAuthenticator" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-push-welcome.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeOptions.mdx deleted file mode 100644 index a18e29965..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeOptions.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "MfaPushWelcomeOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaPushWelcomeOptions { - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-push-welcome.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeMembers.mdx deleted file mode 100644 index 2dc165059..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeMembers.mdx +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: "MfaRecoveryCodeChallengeMembers" -description: "Interface describing the members of the Mfa Recovery Code Challenge screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaRecoveryCodeChallengeMembers extends BaseMembers { - client: ClientMembers; - organization: OrganizationMembers; - prompt: PromptMembers; - screen: ScreenMembers; - transaction: TransactionMembers; - - /** - * Continues with the provided recovery code. - * @param payload - The continue options containing the recovery code and optional custom options. - * @returns A promise that resolves when the continuation is successful. - */ - continue(payload: ContinueOptions): Promise<void>; - - /** - * Navigates to the screen where the user can pick another MFA method. - * @param payload Optional payload. - * @returns A promise that resolves when the navigation is complete. - */ - tryAnotherMethod(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Continues with the provided recovery code. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Navigates to the screen where the user can pick another MFA method. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-recovery-code-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx deleted file mode 100644 index 239b789af..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "MfaRecoveryCodeChallengeNewCodeMembers" -description: "@interface MfaRecoveryCodeChallengeNewCodeMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaRecoveryCodeChallengeNewCodeMembers extends BaseMembers { - /** - * Access to the specific properties and data of the 'mfa-recovery-code-challenge-new-code' screen. - * Includes the `textCode` which is the recovery code to be displayed. - * @type {ScreenMembersOnMfaRecoveryCodeChallengeNewCode} - */ - screen: ScreenMembersOnMfaRecoveryCodeChallengeNewCode; - - /** - * Confirms that the user has saved the new recovery code and continues the authentication flow. - * This method should be called after the user indicates they have securely stored the displayed recovery code. - * It sends a confirmation to the Auth0 server to proceed to the next step. - * - * @param {ContinueOptions} [payload] - Optional custom data to include with the request. - * @returns {Promise<void>} A promise that resolves when the confirmation is successfully submitted. - * @throws {Error} Throws an error if the submission fails (e.g., network issue, invalid state). - * - * @example - * ```typescript - * import MfaRecoveryCodeChallengeNewCode from '@auth0/auth0-acul-js/mfa-recovery-code-challenge-new-code'; - * - * const screenManager = new MfaRecoveryCodeChallengeNewCode(); - * - * // Assuming the user has checked a box confirming they saved the code - * try { - * await screenManager.continue(); - * // Redirects to the next screen on success - * } catch (error) { - * console.error("Failed to confirm recovery code saved:", error); - * // Handle error, e.g., display a message from screenManager.transaction.errors - * } - * ``` - */ - continue(payload?: ContinueOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode">ScreenMembersOnMfaRecoveryCodeChallengeNewCode</a></span>} required> - Access to the specific properties and data of the 'mfa-recovery-code-challenge-new-code' screen. Includes the `textCode` which is the recovery code to be displayed. -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Confirms that the user has saved the new recovery code and continues the authentication flow. This method should be called after the user indicates they have securely stored the displayed recovery code. It sends a confirmation to the Auth0 server to proceed to the next step. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-recovery-code-challenge-new-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx deleted file mode 100644 index 6ae519e59..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "MfaRecoveryCodeEnrollmentContinueOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaRecoveryCodeEnrollmentContinueOptions extends CustomOptions { - isCodeCopied: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="isCodeCopied" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-recovery-code-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx deleted file mode 100644 index b32a98344..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "MfaRecoveryCodeEnrollmentMembers" -description: "Interface describing the members of the Mfa Recovery Code Enrollment screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaRecoveryCodeEnrollmentMembers extends BaseMembers { - screen: ScreenMembersOnMfaRecoveryCodeEnrollment; - - /** - * Declares that the user saved the recovery code. - * This action is triggered when the user declares that they have saved the recovery code. - * It redirects to the next screen in the authentication flow. - * - * @param {object} payload - An object containing any custom options. - * - * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. - * Rejects with an error if the submission fails. - */ - continue(payload: MfaRecoveryCodeEnrollmentContinueOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment">ScreenMembersOnMfaRecoveryCodeEnrollment</a></span>} required> -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Declares that the user saved the recovery code. This action is triggered when the user declares that they have saved the recovery code. It redirects to the next screen in the authentication flow. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-recovery-code-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeMembers.mdx deleted file mode 100644 index b3bd4711b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeMembers.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "MfaSmsChallengeMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaSmsChallengeMembers extends BaseMembers { - screen: ScreenMembersOnMfaSmsChallenge; - untrustedData: UntrustedDataMembersOnMfaSmsChallenge; - continueMfaSmsChallenge(payload: MfaSmsChallengeOptions): Promise<void>; - pickSms(payload?: CustomOptions): Promise<void>; - resendCode(payload?: CustomOptions): Promise<void>; - tryAnotherMethod(payload?: CustomOptions): Promise<void>; - getACall(payload?: CustomOptions): Promise<void>; - /** - * Gets resend functionality with timeout management for this screen - * @param options Configuration options for resend functionality - */ - resendManager(options?: StartResendOptions): ResendControl; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsChallenge">ScreenMembersOnMfaSmsChallenge</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaSmsChallenge">UntrustedDataMembersOnMfaSmsChallenge</a></span>} required> -</ParamField> - -<ParamField path="continueMfaSmsChallenge" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="pickSms" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="getACall" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> - Gets resend functionality with timeout management for this screen -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-sms-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions.mdx deleted file mode 100644 index d1a88e5b6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "MfaSmsChallengeOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaSmsChallengeOptions { - code: string; - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="code" type={<span>string</span>} required> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-sms-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentMembers.mdx deleted file mode 100644 index f7f285985..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentMembers.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "MfaSmsEnrollmentMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaSmsEnrollmentMembers extends BaseMembers { - screen: ScreenMembersOnMfaSmsEnrollment; - pickCountryCode(payload?: CustomOptions): Promise<void>; - continueEnrollment(payload: { phone: string; captcha?: string }): Promise<void>; - tryAnotherMethod(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsEnrollment">ScreenMembersOnMfaSmsEnrollment</a></span>} required> -</ParamField> - -<ParamField path="pickCountryCode" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="continueEnrollment" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-sms-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentOptions.mdx deleted file mode 100644 index cd17ebb94..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentOptions.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "MfaSmsEnrollmentOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaSmsEnrollmentOptions { - phone?: string; - captcha?: string; - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="phone" type={<span>string</span>}> -</ParamField> - -<ParamField path="captcha" type={<span>string</span>}> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-sms-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListMembers.mdx deleted file mode 100644 index dd84a0a65..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListMembers.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "MfaSmsListMembers" -description: "@interface MfaSmsListMembers Interface defining the members and methods for the MfaSmsList class." ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaSmsListMembers extends BaseMembers { - /** - * Selects a phone number from the list of enrolled phone numbers. - * @param {MfaSmsListOptions} [payload] - Optional payload for the action. - * @returns {Promise<void>} - * @throws {Error} If the index is out of bounds. - */ - selectPhoneNumber(payload?: MfaSmsListOptions): Promise<void>; - /** - * Navigates back to the previous screen. - * @param {MfaSmsListOptions} [payload] - Optional payload for the action. - * @returns {Promise<void>} - */ - backAction(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="selectPhoneNumber" type={<span>Promise<void></span>} required> - Selects a phone number from the list of enrolled phone numbers. -</ParamField> - -<ParamField path="backAction" type={<span>Promise<void></span>} required> - Navigates back to the previous screen. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-sms-list.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListOptions.mdx deleted file mode 100644 index 3e3942459..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListOptions.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "MfaSmsListOptions" -description: "@interface MfaSmsListOptions Options for performing actions on the mfa-sms-list screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaSmsListOptions { - /** - * @param {number} index - The index of the phone number to select. - */ - index: number; - /** Any additional custom options */ - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="index" type={<span>number</span>} required> - @param index - The index of the phone number to select. -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> - Any additional custom options -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-sms-list.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeContinueOptions.mdx deleted file mode 100644 index 4394bf4f3..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeContinueOptions.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "MfaVoiceChallengeContinueOptions" -description: "Options for submitting the voice challenge code." ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaVoiceChallengeContinueOptions { - /** - * The verification code received via voice call. - */ - code: string; - - /** - * Optional flag to remember the device for 30 days, skipping future MFA challenges. - */ - rememberDevice?: boolean; - - /** - * Additional custom options to pass with the request. - */ - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="code" type={<span>string</span>} required> - The verification code received via voice call. -</ParamField> - -<ParamField path="rememberDevice" type={<span>boolean</span>}> - Optional flag to remember the device for 30 days, skipping future MFA challenges. -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> - Additional custom options to pass with the request. -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-voice-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeMembers.mdx deleted file mode 100644 index 1bb03eeaa..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeMembers.mdx +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: "MfaVoiceChallengeMembers" -description: "Interface defining all members and operations available on the MFA Voice Challenge screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaVoiceChallengeMembers extends BaseMembers { - /** - * Screen-specific properties and data. - */ - screen: ScreenMembersOnMfaVoiceChallenge; - - untrustedData: UntrustedDataMembersOnMfaVoiceChallenge; - - /** - * Submits the voice verification code to validate the MFA challenge. - * - * @param payload - Object containing the verification code and optional parameters - * @returns Promise that resolves when the code is successfully validated - * - * @example - * ```typescript - * const mfaVoiceChallenge = new MfaVoiceChallenge(); - * mfaVoiceChallenge.continue({ - * code: '123456', - * rememberDevice: true - * }); - * ``` - */ - continue(payload: MfaVoiceChallengeContinueOptions): Promise<void>; - - /** - * Navigates to the screen for selecting a different phone number. - * - * @param payload - Optional custom parameters - * @returns Promise that resolves when navigation is complete - * - * @example - * ```typescript - * const mfaVoiceChallenge = new MfaVoiceChallenge(); - * mfaVoiceChallenge.pickPhone(); - * ``` - */ - pickPhone(payload?: CustomOptions): Promise<void>; - - /** - * Switches to SMS verification method instead of voice call. - * - * @param payload - Optional custom parameters - * @returns Promise that resolves when switching is complete - * - * @example - * ```typescript - * const mfaVoiceChallenge = new MfaVoiceChallenge(); - * mfaVoiceChallenge.switchToSms(); - * ``` - */ - switchToSms(payload?: CustomOptions): Promise<void>; - - /** - * Requests a new voice call with a verification code. - * - * @param payload - Optional custom parameters - * @returns Promise that resolves when the new code is sent - * - * @example - * ```typescript - * const mfaVoiceChallenge = new MfaVoiceChallenge(); - * mfaVoiceChallenge.resendCode(); - * ``` - */ - resendCode(payload?: CustomOptions): Promise<void>; - - /** - * Navigates to the screen for selecting an alternative MFA method. - * - * @param payload - Optional custom parameters - * @returns Promise that resolves when navigation is complete - * - * @example - * ```typescript - * const mfaVoiceChallenge = new MfaVoiceChallenge(); - * mfaVoiceChallenge.tryAnotherMethod(); - * ``` - */ - tryAnotherMethod(payload?: CustomOptions): Promise<void>; - - /** - * Gets resend functionality with timeout management for this screen - * @param options Configuration options for resend functionality - */ - resendManager(options?: StartResendOptions): ResendControl; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaVoiceChallenge">ScreenMembersOnMfaVoiceChallenge</a></span>} required> - Screen-specific properties and data. -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaVoiceChallenge">UntrustedDataMembersOnMfaVoiceChallenge</a></span>} required> -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Submits the voice verification code to validate the MFA challenge. -</ParamField> - -<ParamField path="pickPhone" type={<span>Promise<void></span>} required> - Navigates to the screen for selecting a different phone number. -</ParamField> - -<ParamField path="switchToSms" type={<span>Promise<void></span>} required> - Switches to SMS verification method instead of voice call. -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>} required> - Requests a new voice call with a verification code. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Navigates to the screen for selecting an alternative MFA method. -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> - Gets resend functionality with timeout management for this screen -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-voice-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceEnrollmentMembers.mdx deleted file mode 100644 index 155f32ba4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceEnrollmentMembers.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "MfaVoiceEnrollmentMembers" -description: "Interface describing the members of the Mfa Voice Enrollment screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaVoiceEnrollmentMembers extends BaseMembers { - client: ClientMembers; - organization: OrganizationMembers; - prompt: PromptMembers; - screen: ScreenMembers; - transaction: TransactionMembers; - - /** - * Continues with the voice enrollment process. - * @param payload - The phone number and optional custom options. - * @returns Promise that resolves when enrollment continues. - */ - continue(payload: ContinueOptions): Promise<void>; - - /** - * Allows trying another authentication method. - * @param payload - Optional custom options. - * @returns Promise that resolves when the user switches method. - */ - tryAnotherMethod(payload?: CustomOptions): Promise<void>; - - /** - * Allows picking a country code for the phone number. - * @param payload - Optional custom options. - * @returns Promise that resolves when the country code is selected. - */ - selectPhoneCountryCode(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Continues with the voice enrollment process. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows trying another authentication method. -</ParamField> - -<ParamField path="selectPhoneCountryCode" type={<span>Promise<void></span>} required> - Allows picking a country code for the phone number. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-voice-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx deleted file mode 100644 index 2deacd5b0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: "MfaWebAuthnChangeKeyNicknameMembers" -description: "@interface MfaWebAuthnChangeKeyNicknameMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaWebAuthnChangeKeyNicknameMembers extends BaseMembers { - /** - * The screen object with MFA WebAuthn Change Key Nickname specific data structure. - */ - screen: ScreenMembersOnMfaWebAuthnChangeKeyNickname; - - /** - * Submits the new nickname for the WebAuthn security key. - * This action corresponds to the user entering a new nickname and clicking a "Save" or "Continue" button. - * The SDK will POST this new nickname to the Auth0 `/u/mfa-webauthn-change-key-nickname` endpoint. - * - * If the new nickname is valid and the update is successful, Auth0 will typically redirect the user - * to the next appropriate screen (e.g., back to MFA factor management or a success confirmation). - * If the nickname is invalid (e.g., empty, too long, too short), Auth0 will re-render the - * 'mfa-webauthn-change-key-nickname' screen, and the `transaction.errors` array in the SDK's - * context will be updated with details about the validation failure. - * - * @param {ContinueOptions} payload - An object containing the `nickname` (string) entered by the user. - * It can also include any `CustomOptions` for extensibility. - * @returns {Promise<void>} A promise that resolves when the form submission is initiated. - * It does not return data directly upon resolution, as a redirect or - * page re-render is the common outcome. - * @throws {Error} Throws an error if `payload.nickname` is not provided or is not a string, - * or if the `FormHandler` encounters an unrecoverable issue during submission (e.g., network error). - * Validation errors from Auth0 (like an invalid nickname) are not thrown as JavaScript errors - * but are reflected in `this.transaction.errors` after the operation. - * - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnChangeKeyNickname - * const newNickname = "My Favorite YubiKey"; // Value from user input - * try { - * await sdk.continueWithNewNickname({ nickname: newNickname }); - * // If successful, page redirects. - * } catch (error) { - * // This catch is for unexpected errors during the SDK call itself. - * console.error("Failed to submit the new nickname:", error); - * } - * // After the await, always check sdk.transaction.errors for server-side validation issues. - * if (sdk.transaction.errors && sdk.transaction.errors.length > 0) { - * sdk.transaction.errors.forEach(err => { - * if (err.field === 'nickname') { - * // Display err.message related to the nickname input field. - * // e.g., "Name is too short", "Name is required" - * } - * }); - * } - * ``` - */ - continueWithNewNickname(payload: ContinueOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname">ScreenMembersOnMfaWebAuthnChangeKeyNickname</a></span>} required> - The screen object with MFA WebAuthn Change Key Nickname specific data structure. -</ParamField> - -<ParamField path="continueWithNewNickname" type={<span>Promise<void></span>} required> - Submits the new nickname for the WebAuthn security key. This action corresponds to the user entering a new nickname and clicking a "Save" or "Continue" button. The SDK will POST this new nickname to the Auth0 `/u/mfa-webauthn-change-key-nickname` endpoint. If the new nickname is valid and the update is successful, Auth0 will typically redirect the user to the next appropriate screen (e.g., back to MFA factor management or a success confirmation). If the nickname is invalid (e.g., empty, too long, too short), Auth0 will re-render the 'mfa-webauthn-change-key-nickname' screen, and the `transaction.errors` array in the SDK's context will be updated with details about the validation failure. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-change-key-nickname.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx deleted file mode 100644 index e45926d85..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: "MfaWebAuthnEnrollmentSuccessMembers" -description: "@interface MfaWebAuthnEnrollmentSuccessMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaWebAuthnEnrollmentSuccessMembers extends BaseMembers { - /** - * Access to the specific properties and data of the 'mfa-webauthn-enrollment-success' screen. - * Includes the `nickname` of the enrolled authenticator and its `webauthnType`. - * @type {ScreenMembersOnMfaWebAuthnEnrollmentSuccess} - */ - screen: ScreenMembersOnMfaWebAuthnEnrollmentSuccess; - - /** - * Allows the user to continue the authentication flow after successful WebAuthn enrollment. - * This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` endpoint with `action: "default"`. - * - * @param {ContinueOptions} [payload] - Optional. An object for `CustomOptions` if any - * additional parameters need to be sent with the request. - * @returns {Promise<void>} A promise that resolves when the continue action is successfully submitted. - * On success, the browser will typically be redirected to the next step in the flow. - * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). - * - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnEnrollmentSuccess - * try { - * await sdk.continue(); - * // User is redirected to the next step. - * } catch (error) { - * console.error("Failed to continue after WebAuthn enrollment:", error); - * // Handle error, potentially by inspecting sdk.transaction.errors if the page re-renders with an error. - * } - * ``` - */ - continue(payload?: ContinueOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess">ScreenMembersOnMfaWebAuthnEnrollmentSuccess</a></span>} required> - Access to the specific properties and data of the 'mfa-webauthn-enrollment-success' screen. Includes the `nickname` of the enrolled authenticator and its `webauthnType`. -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Allows the user to continue the authentication flow after successful WebAuthn enrollment. This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` endpoint with `action: "default"`. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-enrollment-success.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnErrorMembers.mdx deleted file mode 100644 index a6277d0aa..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnErrorMembers.mdx +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: "MfaWebAuthnErrorMembers" -description: "@interface MfaWebAuthnErrorMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaWebAuthnErrorMembers extends BaseMembers { - /** - * The screen object with MFA WebAuthn Error specific data structure. - */ - screen: ScreenMembersOnMfaWebAuthnError; - - /** - * Allows the user to attempt the previous WebAuthn operation again. - * This typically redirects the user back to the screen where the WebAuthn operation was initiated. - * - * @param {CustomOptions} [payload] - Optional custom options to include with the request. - * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. - * @throws {Error} Throws an error if the submission fails. - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnError - * await sdk.tryAgain(); - * ``` - */ - tryAgain(payload?: CustomOptions): Promise<void>; - - /** - * Allows the user to opt for password-based authentication as an alternative, if configured. - * This is typically available if the primary authentication or a previous step involved a password. - * - * @param {CustomOptions} [payload] - Optional custom options to include with the request. - * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. - * @throws {Error} Throws an error if the submission fails. - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnError - * await sdk.usePassword(); - * ``` - */ - usePassword(payload?: CustomOptions): Promise<void>; - - /** - * Allows the user to select a different MFA method if other factors are enrolled or available. - * This navigates the user to an authenticator selection screen. - * - * @param {CustomOptions} [payload] - Optional custom options to include with the request. - * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. - * @throws {Error} Throws an error if the submission fails. - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnError - * await sdk.tryAnotherMethod(); - * ``` - */ - tryAnotherMethod(payload?: CustomOptions): Promise<void>; - - /** - * Allows the user to refuse adding a device or completing the WebAuthn step, effectively declining the current WebAuthn flow. - * This action is typically used in enrollment scenarios where the user decides not to proceed. - * - * @param {CustomOptions} [payload] - Optional custom options to include with the request. - * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. - * @throws {Error} Throws an error if the submission fails. - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnError - * await sdk.noThanks(); - * ``` - */ - noThanks(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnError">ScreenMembersOnMfaWebAuthnError</a></span>} required> - The screen object with MFA WebAuthn Error specific data structure. -</ParamField> - -<ParamField path="tryAgain" type={<span>Promise<void></span>} required> - Allows the user to attempt the previous WebAuthn operation again. This typically redirects the user back to the screen where the WebAuthn operation was initiated. -</ParamField> - -<ParamField path="usePassword" type={<span>Promise<void></span>} required> - Allows the user to opt for password-based authentication as an alternative, if configured. This is typically available if the primary authentication or a previous step involved a password. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows the user to select a different MFA method if other factors are enrolled or available. This navigates the user to an authenticator selection screen. -</ParamField> - -<ParamField path="noThanks" type={<span>Promise<void></span>} required> - Allows the user to refuse adding a device or completing the WebAuthn step, effectively declining the current WebAuthn flow. This action is typically used in enrollment scenarios where the user decides not to proceed. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-error.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx deleted file mode 100644 index 5b5cab415..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "MfaWebAuthnNotAvailableErrorMembers" -description: "@interface MfaWebAuthnNotAvailableErrorMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaWebAuthnNotAvailableErrorMembers extends BaseMembers { - /** - * Allows the user to select a different MFA method because WebAuthn is not available. - * This action navigates the user to an authenticator selection screen where they can choose - * from other available/enrolled MFA factors. - * - * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. - * @returns {Promise<void>} A promise that resolves upon successful submission of the 'pick-authenticator' action. - * @throws {Error} Throws an error if the form submission fails (e.g., network issues, server-side validation errors). - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnNotAvailableError - * try { - * await sdk.tryAnotherMethod(); - * // On success, Auth0 handles redirection to the authenticator selection screen. - * } catch (error) { - * console.error('Failed to switch to another MFA method:', error); - * // Potentially update UI to inform the user of the failure. - * } - * ``` - */ - tryAnotherMethod(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows the user to select a different MFA method because WebAuthn is not available. This action navigates the user to an authenticator selection screen where they can choose from other available/enrolled MFA factors. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-not-available-error.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-not-available-error.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx deleted file mode 100644 index 008f8dedf..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx +++ /dev/null @@ -1,149 +0,0 @@ ---- -title: "MfaWebAuthnPlatformChallengeMembers" -description: "@interface MfaWebAuthnPlatformChallengeMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaWebAuthnPlatformChallengeMembers extends BaseMembers { - /** - * Screen-specific properties and data, including WebAuthn challenge options and remember device preference. - * @type {ScreenMembersOnMfaWebAuthnPlatformChallenge} - */ - screen: ScreenMembersOnMfaWebAuthnPlatformChallenge; - - /** - * Initiates the WebAuthn platform authenticator challenge. - * This method internally calls `navigator.credentials.get()` using the challenge options - * provided in `screen.publicKey`. - * If successful, it submits the resulting credential to Auth0 with `action: "default"`. - * - * If `navigator.credentials.get()` fails (e.g., user cancellation, timeout, or other WebAuthn API errors), - * it's recommended to call `reportBrowserError` with the error details. - * - * @param {VerifyPlatformAuthenticatorOptions} [options] - Optional parameters for the verification process, - * such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. - * @returns {Promise<void>} A promise that resolves when the verification attempt is submitted. - * A successful operation typically results in a redirect. - * @throws {Error} Throws an error if `screen.publicKey` is missing, - * if `navigator.credentials.get()` fails with an unexpected error not handled by `getPasskeyCredentials`, - * or if the form submission to Auth0 fails. - * - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformChallenge - * try { - * const remember = sdk.screen.showRememberDevice && userCheckedRememberDeviceBox; - * await sdk.verify({ rememberDevice: remember }); - * // On success, Auth0 handles redirection. - * } catch (error) { - * console.error("Platform authenticator verification failed:", error); - * // If it's a WebAuthn API error, report it - * if (error.name && error.message) { // Basic check for DOMException like error - * await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); - * } - * // Check sdk.transaction.errors for server-side validation messages if the page reloads. - * } - * ``` - */ - verify(options?: VerifyPlatformAuthenticatorOptions): Promise<void>; - - /** - * Reports a specific WebAuthn API error (from `navigator.credentials.get()`) to Auth0. - * This method should be used when `verify()` (or a manual `navigator.credentials.get()` call) fails due to - * a browser-side WebAuthn issue (e.g., user cancellation `NotAllowedError`, timeout). - * It submits the error details with `action: "showError::{errorDetailsJsonString}"` and an empty `response`. - * - * @param {ReportBrowserErrorOptions} options - Contains the `error` object (with `name` and `message` - * from the WebAuthn API DOMException) and any other custom options. - * @returns {Promise<void>} A promise that resolves when the error report is submitted. - * @throws {Error} Throws an error if the form submission fails (e.g., network error, invalid state). - * - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformChallenge - * // And webAuthnDomException is an error object from a failed navigator.credentials.get() call. - * try { - * await sdk.reportBrowserError({ - * error: { name: webAuthnDomException.name, message: webAuthnDomException.message } - * }); - * // Auth0 will process this error and may re-render the page or redirect. - * } catch (submitError) { - * console.error("Failed to report WebAuthn browser error:", submitError); - * } - * ``` - */ - reportBrowserError(options: ReportBrowserErrorOptions): Promise<void>; - - /** - * Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. - * This action submits `action: "pick-authenticator"` to Auth0, which should navigate - * the user to an MFA factor selection screen. - * - * @param {TryAnotherMethodOptions} [options] - Optional custom parameters to be sent with the request. - * @returns {Promise<void>} A promise that resolves when the 'pick-authenticator' action is submitted. - * @throws {Error} Throws an error if the form submission fails. - * - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformChallenge - * try { - * await sdk.tryAnotherMethod(); - * // On success, Auth0 handles redirection to MFA selection. - * } catch (error) { - * console.error("Failed to switch MFA method:", error); - * } - * ``` - */ - tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge">ScreenMembersOnMfaWebAuthnPlatformChallenge</a></span>} required> - Screen-specific properties and data, including WebAuthn challenge options and remember device preference. -</ParamField> - -<ParamField path="verify" type={<span>Promise<void></span>} required> - Initiates the WebAuthn platform authenticator challenge. This method internally calls `navigator.credentials.get()` using the challenge options provided in `screen.publicKey`. If successful, it submits the resulting credential to Auth0 with `action: "default"`. If `navigator.credentials.get()` fails (e.g., user cancellation, timeout, or other WebAuthn API errors), it's recommended to call `reportBrowserError` with the error details. -</ParamField> - -<ParamField path="reportBrowserError" type={<span>Promise<void></span>} required> - Reports a specific WebAuthn API error (from `navigator.credentials.get()`) to Auth0. This method should be used when `verify()` (or a manual `navigator.credentials.get()` call) fails due to a browser-side WebAuthn issue (e.g., user cancellation `NotAllowedError`, timeout). It submits the error details with `action: "showError::"` and an empty `response`. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate the user to an MFA factor selection screen. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-platform-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx deleted file mode 100644 index 9dee3e21b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: "MfaWebAuthnPlatformEnrollmentMembers" -description: "@interface MfaWebAuthnPlatformEnrollmentMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaWebAuthnPlatformEnrollmentMembers extends BaseMembers { - /** - * The screen object with MFA WebAuthn Platform Enrollment specific data structure. - */ - screen: ScreenMembersOnMfaWebAuthnPlatformEnrollment; - - /** - * Initiates the WebAuthn platform credential creation process using the public key options - * available on `this.screen.publicKey` and submits the resulting credential to the server. - * This method internally calls `createPasskeyCredentials` (which wraps `navigator.credentials.create()`). - * - * @param {SubmitPasskeyCredentialOptions} [payload] - Optional custom parameters to be sent to the server - * along with the created credential. - * @returns {Promise<void>} A promise that resolves when the credential is successfully created and submitted. - * @throws {Error} Throws an error if `this.screen.publicKey` is not available, if `createPasskeyCredentials` fails - * (e.g., user cancellation, hardware issues), or if the submission to the server fails. - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment - * try { - * if (!sdk.screen.publicKey) { // Check if options are available - * throw new Error("Public key creation options are not available on the screen context."); - * } - * await sdk.submitPasskeyCredential(); // No need to pass publicKey explicitly - * // On success, Auth0 handles redirection. - * } catch (error) { - * console.error('Passkey enrollment failed:', error); - * // Handle error, potentially by calling reportBrowserError if it's a WebAuthn API error - * if (error.name && error.message) { // Check if it looks like a WebAuthn error - * await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); - * } - * } - * ``` - */ - submitPasskeyCredential(payload?: SubmitPasskeyCredentialOptions): Promise<void>; - - /** - * Reports a browser-side error encountered during the WebAuthn `navigator.credentials.create()` operation. - * This method sends the error details to the server. - * - * @param {ReportBrowserErrorOptions} payload - The browser error details and any custom options. - * @returns {Promise<void>} A promise that resolves when the error report is successfully submitted. - * @throws {Error} Throws an error if the submission fails. - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment - * // In the catch block of an attempted passkey creation (e.g. from submitPasskeyCredential): - * } catch (webAuthnError) { - * if (webAuthnError.name) { // Check if it's likely a WebAuthn API error - * await sdk.reportBrowserError({ error: { name: webAuthnError.name, message: webAuthnError.message } }); - * } - * // Update UI to show error message to the user - * } - * ``` - */ - reportBrowserError(payload: ReportBrowserErrorOptions): Promise<void>; - - /** - * Allows the user to snooze or postpone the WebAuthn platform enrollment. - * This action typically means the user will be reminded to enroll at a later time. - * - * @param {CustomOptions} [payload] - Optional custom options to include with the request. - * @returns {Promise<void>} A promise that resolves when the snooze action is successfully submitted. - * @throws {Error} Throws an error if the submission fails. - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment - * await sdk.snoozeEnrollment(); - * ``` - */ - snoozeEnrollment(payload?: CustomOptions): Promise<void>; - - /** - * Allows the user to refuse WebAuthn platform enrollment on the current device. - * This action indicates the user does not want to use a platform authenticator on this specific device. - * - * @param {CustomOptions} [payload] - Optional custom options to include with the request. - * @returns {Promise<void>} A promise that resolves when the refusal action is successfully submitted. - * @throws {Error} Throws an error if the submission fails. - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment - * await sdk.refuseEnrollmentOnThisDevice(); - * ``` - */ - refuseEnrollmentOnThisDevice(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment">ScreenMembersOnMfaWebAuthnPlatformEnrollment</a></span>} required> - The screen object with MFA WebAuthn Platform Enrollment specific data structure. -</ParamField> - -<ParamField path="submitPasskeyCredential" type={<span>Promise<void></span>} required> - Initiates the WebAuthn platform credential creation process using the public key options available on `this.screen.publicKey` and submits the resulting credential to the server. This method internally calls `createPasskeyCredentials` (which wraps `navigator.credentials.create()`). -</ParamField> - -<ParamField path="reportBrowserError" type={<span>Promise<void></span>} required> - Reports a browser-side error encountered during the WebAuthn `navigator.credentials.create()` operation. This method sends the error details to the server. -</ParamField> - -<ParamField path="snoozeEnrollment" type={<span>Promise<void></span>} required> - Allows the user to snooze or postpone the WebAuthn platform enrollment. This action typically means the user will be reminded to enroll at a later time. -</ParamField> - -<ParamField path="refuseEnrollmentOnThisDevice" type={<span>Promise<void></span>} required> - Allows the user to refuse WebAuthn platform enrollment on the current device. This action indicates the user does not want to use a platform authenticator on this specific device. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-platform-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx deleted file mode 100644 index cb7826b5e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: "MfaWebAuthnRoamingChallengeMembers" -description: "@interface MfaWebAuthnRoamingChallengeMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaWebAuthnRoamingChallengeMembers extends BaseMembers { - /** - * Screen-specific properties and data, including WebAuthn challenge options. - * @type {ScreenMembersOnMfaWebAuthnRoamingChallenge} - */ - screen: ScreenMembersOnMfaWebAuthnRoamingChallenge; - - /** - * Initiates the WebAuthn challenge by calling `navigator.credentials.get()` with the - * options provided in `screen.data.publicKeyChallengeOptions`. - * If successful, it submits the resulting credential to Auth0 with `action: "default"`. - * If `navigator.credentials.get()` fails with a known WebAuthn API error (like `NotAllowedError`), - * this method will internally call `reportWebAuthnError` to inform Auth0. - * - * @param {VerifySecurityKeyOptions} [options] - Optional parameters for the verification process, - * such as `rememberDevice` and other custom options. - * @returns {Promise<void>} A promise that resolves when the verification attempt is submitted. - * It does not directly return data as a successful operation typically results in a redirect. - * @throws {Error} Throws an error if `screen.data.publicKeyChallengeOptions` is missing, - * if `navigator.credentials.get()` fails with an unexpected error, - * or if the form submission to Auth0 fails. - * - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge - * try { - * await sdk.verify({ rememberDevice: true }); - * // On success, Auth0 handles redirection. - * } catch (error) { - * console.error("Security key verification failed:", error); - * // Check sdk.transaction.errors for server-side validation messages if the page reloads. - * } - * ``` - */ - verify(options?: VerifySecurityKeyOptions): Promise<void>; - - /** - * Reports a specific WebAuthn API error to Auth0. - * This method should be used if `navigator.credentials.get()` fails in a way that - * `verify()` doesn't automatically handle, or if the developer wants to explicitly - * report an error before trying another action. - * It submits the error details with `action: "showError::{errorDetails}"`. - * - * @param {ReportWebAuthnErrorOptions} options - Contains the `error` object with `name` and `message` - * from the WebAuthn API, and any other custom options. - * @returns {Promise<void>} A promise that resolves when the error report is submitted. - * @throws {Error} Throws an error if the form submission fails. - * - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge - * // And webAuthnError is an error object from a failed navigator.credentials.get() call. - * try { - * await sdk.reportWebAuthnError({ - * error: { name: webAuthnError.name, message: webAuthnError.message } - * }); - * } catch (submitError) { - * console.error("Failed to report WebAuthn error:", submitError); - * } - * ``` - */ - reportWebAuthnError(options: ReportWebAuthnErrorOptions): Promise<void>; - - /** - * Allows the user to opt-out of the WebAuthn challenge and select a different MFA method. - * This action submits `action: "pick-authenticator"` to Auth0, which should navigate - * the user to an MFA factor selection screen. - * - * @param {TryAnotherMethodOptions} [options] - Optional custom parameters for the request. - * @returns {Promise<void>} A promise that resolves when the action is submitted. - * @throws {Error} Throws an error if the form submission fails. - * - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnRoamingChallenge - * try { - * await sdk.tryAnotherMethod(); - * // On success, Auth0 handles redirection to MFA selection. - * } catch (error) { - * console.error("Failed to switch MFA method:", error); - * } - * ``` - */ - tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge">ScreenMembersOnMfaWebAuthnRoamingChallenge</a></span>} required> - Screen-specific properties and data, including WebAuthn challenge options. -</ParamField> - -<ParamField path="verify" type={<span>Promise<void></span>} required> - Initiates the WebAuthn challenge by calling `navigator.credentials.get()` with the options provided in `screen.data.publicKeyChallengeOptions`. If successful, it submits the resulting credential to Auth0 with `action: "default"`. If `navigator.credentials.get()` fails with a known WebAuthn API error (like `NotAllowedError`), this method will internally call `reportWebAuthnError` to inform Auth0. -</ParamField> - -<ParamField path="reportWebAuthnError" type={<span>Promise<void></span>} required> - Reports a specific WebAuthn API error to Auth0. This method should be used if `navigator.credentials.get()` fails in a way that `verify()` doesn't automatically handle, or if the developer wants to explicitly report an error before trying another action. It submits the error details with `action: "showError::"`. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows the user to opt-out of the WebAuthn challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate the user to an MFA factor selection screen. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx deleted file mode 100644 index f2a5cb78f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: "MfaWebAuthnRoamingEnrollmentMembers" -description: "Interface defining the available methods and properties for the mfa-webauthn-roaming-enrollment screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface MfaWebAuthnRoamingEnrollmentMembers extends BaseMembers { - screen: ScreenMembersOnMfaWebAuthnRoamingEnrollment; - /** - * Initiates the WebAuthn credential creation and submits the result to the server. - * This corresponds to the user interacting with the FIDO Security Keys prompt. - * @param payload Optional custom options to include with the request. - * @example - * ```typescript - * import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; - * - * const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); - * try { - * // This will trigger the browser's WebAuthn prompt - * const credential = await navigator.credentials.create({ publicKey: webauthnEnrollment.screen.data.passkey.public_key }); - * // You would typically serialize the credential response here - * const response = JSON.stringify(credential); - * await webauthnEnrollment.enroll({ response }); - * } catch (error) { - * console.error('WebAuthn enrollment failed:', error); - * // Handle the error, e.g., show an error message to the user or submit the error details - * // await webauthnEnrollment.showError({ error: { name: error.name, message: error.message } }); - * } - * ``` - */ - enroll(payload: CustomOptions): Promise<void>; - /** - * Submits details about a WebAuthn browser error to the server. - * This is used when the browser's WebAuthn API encounters an error. - * @param payload The options containing the error details. - * @example - * ```typescript - * import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; - * - * const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); - * // Example error handler for the browser's WebAuthn API call - * const handleError = async (error: any) => { - * console.error('WebAuthn error:', error); - * await webauthnEnrollment.showError({ - * error: { - * name: error.name, - * message: error.message, - * // Include other relevant error properties if available - * }, - * }); - * }; - * // ... use handleError in your WebAuthn API call's catch block - * ``` - */ - showError(payload: ShowErrorOptions): Promise<void>; - /** - * Allows the user to try another MFA method. - * This corresponds to the "Try Another Method" button. - * @param payload Optional custom options to include with the request. - * @example - * ```typescript - * import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; - * - * const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); - * await webauthnEnrollment.tryAnotherMethod(); - * ``` - */ - tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment">ScreenMembersOnMfaWebAuthnRoamingEnrollment</a></span>} required> -</ParamField> - -<ParamField path="enroll" type={<span>Promise<void></span>} required> - Initiates the WebAuthn credential creation and submits the result to the server. This corresponds to the user interacting with the FIDO Security Keys prompt. -</ParamField> - -<ParamField path="showError" type={<span>Promise<void></span>} required> - Submits details about a WebAuthn browser error to the server. This is used when the browser's WebAuthn API encounters an error. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows the user to try another MFA method. This corresponds to the "Try Another Method" button. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-roaming-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext.mdx deleted file mode 100644 index 0d6c896f7..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "OrganizationContext" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface OrganizationContext { - id: string; - name: string; - usage: string; - display_name?: string; - branding?: { - logo_url?: string; - colors?: { - primary?: string; - page_background?: string; - }; - }; - metadata?: { - [key: string]: string; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="id" type={<span>string</span>} required> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="usage" type={<span>string</span>} required> -</ParamField> - -<ParamField path="display_name" type={<span>string</span>}> -</ParamField> - -<ParamField path="branding" type="object"> - <Expandable title="properties"> - <ParamField path="logo_url" type={<span>string</span>}> - </ParamField> - <ParamField path="colors" type="object"> - <Expandable title="properties"> - <ParamField path="primary" type={<span>string</span>}> - </ParamField> - <ParamField path="page_background" type={<span>string</span>}> - </ParamField> - </Expandable> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="metadata" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/models/organization.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/organization.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers.mdx deleted file mode 100644 index c7293b2d9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "OrganizationMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface OrganizationMembers { - id: string | null; - name: string | null; - usage: string | null; - displayName: string | null; - branding: Branding | null; - metadata: { [key: string]: string } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="id" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="name" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="usage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="displayName" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding">Branding</a> | null</span>}> -</ParamField> - -<ParamField path="metadata" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/models/organization.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/organization.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationPickerMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationPickerMembers.mdx deleted file mode 100644 index 6c8cc079a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationPickerMembers.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "OrganizationPickerMembers" -description: "Interface defining the available methods and properties for the organization-picker screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface OrganizationPickerMembers extends BaseMembers { - /** - * Selects an organization for the user. - * @param payload The options containing the organization ID. - */ - selectOrganization(payload: { organization: string; state: string }): Promise<void>; - - /** - * Skips the organization selection, proceeding with the user's personal account. - * @param payload Optional custom options to include with the request. - */ - skipOrganizationSelection(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="selectOrganization" type={<span>Promise<void></span>} required> - Selects an organization for the user. -</ParamField> - -<ParamField path="skipOrganizationSelection" type={<span>Promise<void></span>} required> - Skips the organization selection, proceeding with the user's personal account. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/organization-picker.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/organization-picker.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationSelectionMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationSelectionMembers.mdx deleted file mode 100644 index f1a9d7185..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationSelectionMembers.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "OrganizationSelectionMembers" -description: "Interface defining the available methods and properties for the organization-selection screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface OrganizationSelectionMembers extends BaseMembers { - /** - * The screen properties. - */ - screen: ScreenMembersOnOrganizationSelection; - /** - * Continues with the selected organization name. - * @param payload The options containing the organization name. - */ - continueWithOrganizationName(payload: ContinueWithOrganizationNameOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnOrganizationSelection">ScreenMembersOnOrganizationSelection</a></span>} required> - The screen properties. -</ParamField> - -<ParamField path="continueWithOrganizationName" type={<span>Promise<void></span>} required> - Continues with the selected organization name. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/organization-selection.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/organization-selection.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Organizations.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Organizations.mdx deleted file mode 100644 index 51607ed9f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Organizations.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "Organizations" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface Organizations { - organizationId: string | undefined; - organizationName: string | undefined; - displayName: string | undefined; - branding: Branding; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="organizationId" type={<span>string | undefined</span>}> -</ParamField> - -<ParamField path="organizationName" type={<span>string | undefined</span>}> -</ParamField> - -<ParamField path="displayName" type={<span>string | undefined</span>}> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding">Branding</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/models/user.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/user.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OtpCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OtpCodeOptions.mdx deleted file mode 100644 index 40434a06e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OtpCodeOptions.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "OtpCodeOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface OtpCodeOptions extends CustomOptions { - /** - * The OTP code that the user enters to submit. - */ - code: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="code" type={<span>string</span>} required> - The OTP code that the user enters to submit. -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/email-otp-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Passkey.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Passkey.mdx deleted file mode 100644 index 5101ab0a8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Passkey.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Passkey" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface Passkey { - enabled: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="enabled" type={<span>boolean</span>} required> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate.mdx deleted file mode 100644 index 1de630648..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "PasskeyCreate" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PasskeyCreate { - public_key: { - user: { - id: string; - name: string; - displayName: string; - }; - rp: { - id: string; - name: string; - }; - challenge: string; - pubKeyCredParams: [ - { - type: string; - alg: number; - }, - ]; - authenticatorSelection: { - residentKey: string; - userVerification: string; - authenticatorAttachment?: string; - }; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="public_key" type="object" required> - <Expandable title="properties"> - <ParamField path="user" type="object" required> - <Expandable title="properties"> - <ParamField path="id" type={<span>string</span>} required> - </ParamField> - <ParamField path="name" type={<span>string</span>} required> - </ParamField> - <ParamField path="displayName" type={<span>string</span>} required> - </ParamField> - </Expandable> - </ParamField> - <ParamField path="rp" type="object" required> - <Expandable title="properties"> - <ParamField path="id" type={<span>string</span>} required> - </ParamField> - <ParamField path="name" type={<span>string</span>} required> - </ParamField> - </Expandable> - </ParamField> - <ParamField path="challenge" type={<span>string</span>} required> - </ParamField> - <ParamField path="pubKeyCredParams" type={<span>array of objects</span>} required> - <Expandable title="properties"> - <ParamField path="type" type={<span>string</span>} required> - </ParamField> - <ParamField path="alg" type={<span>number</span>} required> - </ParamField> - </Expandable> - </ParamField> - <ParamField path="authenticatorSelection" type="object" required> - <Expandable title="properties"> - <ParamField path="residentKey" type={<span>string</span>} required> - </ParamField> - <ParamField path="userVerification" type={<span>string</span>} required> - </ParamField> - <ParamField path="authenticatorAttachment" type={<span>string</span>}> - </ParamField> - </Expandable> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreateResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreateResponse.mdx deleted file mode 100644 index 35c286652..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreateResponse.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "PasskeyCreateResponse" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PasskeyCreateResponse { - id: string; - rawId: string | null; - type: string; - authenticatorAttachment: string | null; - response: CredentialResponse; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="id" type={<span>string</span>} required> -</ParamField> - -<ParamField path="rawId" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="type" type={<span>string</span>} required> -</ParamField> - -<ParamField path="authenticatorAttachment" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="response" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CredentialResponse">CredentialResponse</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCredentialResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCredentialResponse.mdx deleted file mode 100644 index 1d2dbda12..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCredentialResponse.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "PasskeyCredentialResponse" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PasskeyCredentialResponse { - id: string; - rawId: string | null; - type: string; - authenticatorAttachment: string | null; - response: { - clientDataJSON: string | null; - authenticatorData: string | null; - signature: string | null; - userHandle: string | null; - }; - isUserVerifyingPlatformAuthenticatorAvailable: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="id" type={<span>string</span>} required> -</ParamField> - -<ParamField path="rawId" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="type" type={<span>string</span>} required> -</ParamField> - -<ParamField path="authenticatorAttachment" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="response" type="object"> - <Expandable title="properties"> - <ParamField path="clientDataJSON" type={<span>string | null</span>}> - </ParamField> - <ParamField path="authenticatorData" type={<span>string | null</span>}> - </ParamField> - <ParamField path="signature" type={<span>string | null</span>}> - </ParamField> - <ParamField path="userHandle" type={<span>string | null</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="isUserVerifyingPlatformAuthenticatorAvailable" type={<span>boolean</span>} required> -</ParamField> - ---- - -**File:** [interfaces/utils/passkeys.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/passkeys.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnroll.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnroll.mdx deleted file mode 100644 index 91c16ad3a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnroll.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "PasskeyEnroll" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PasskeyEnroll extends Passkey { - public_key: { - user: { - id: ArrayBuffer; - name: string; - displayName: string; - }; - rp: { - id: string; - name: string; - }; - challenge: ArrayBuffer; - pubKeyCredParams: [ - { - type: string; - alg: number; - }, - ]; - authenticatorSelection: { - residentKey: string; - userVerification: string; - }; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="public_key" type="object" required> - <Expandable title="properties"> - <ParamField path="user" type="object" required> - <Expandable title="properties"> - <ParamField path="id" type={<span>ArrayBuffer</span>} required> - </ParamField> - <ParamField path="name" type={<span>string</span>} required> - </ParamField> - <ParamField path="displayName" type={<span>string</span>} required> - </ParamField> - </Expandable> - </ParamField> - <ParamField path="rp" type="object" required> - <Expandable title="properties"> - <ParamField path="id" type={<span>string</span>} required> - </ParamField> - <ParamField path="name" type={<span>string</span>} required> - </ParamField> - </Expandable> - </ParamField> - <ParamField path="challenge" type={<span>ArrayBuffer</span>} required> - </ParamField> - <ParamField path="pubKeyCredParams" type={<span>array of objects</span>} required> - <Expandable title="properties"> - <ParamField path="type" type={<span>string</span>} required> - </ParamField> - <ParamField path="alg" type={<span>number</span>} required> - </ParamField> - </Expandable> - </ParamField> - <ParamField path="authenticatorSelection" type="object" required> - <Expandable title="properties"> - <ParamField path="residentKey" type={<span>string</span>} required> - </ParamField> - <ParamField path="userVerification" type={<span>string</span>} required> - </ParamField> - </Expandable> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="enabled" type={<span>boolean</span>} required> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollment.mdx deleted file mode 100644 index d24f4003d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollment.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: "PasskeyEnrollment" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PasskeyEnrollment extends BaseContext { - screen: ExtendedScreenContext; -} -``` - -```typescript Enroll with Passkey local -import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; - -const passkeyEnrollment = new PasskeyEnrollment(); -passkeyEnrollment.continuePasskeyEnrollment(); -``` - -```typescript Abort passkey enrolment local -import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; - -const passkeyEnrollment = new PasskeyEnrollment(); -passkeyEnrollment.abortPasskeyEnrollment(); -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext">ExtendedScreenContext</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> -</ParamField> - -<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/passkey-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocal.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocal.mdx deleted file mode 100644 index 27d355f4b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocal.mdx +++ /dev/null @@ -1,157 +0,0 @@ ---- -title: "PasskeyEnrollmentLocal" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PasskeyEnrollmentLocal extends BaseContext { - screen: ExtendedScreenContext; -} -``` - -```typescript continuePasskeyEnrollment -import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment-local'; - -// Create an instance of PasskeyEnrollment to handle the enrollment process -const passkeyEnrollment = new PasskeyEnrollment(); - -// Begin the passkey enrollment process for local authentication -// This will trigger the necessary flow for the user to enroll their passkey -passkeyEnrollment.continuePasskeyEnrollment(); -``` - -```typescript Abort local passkey enrolment -import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment-local'; - -const passkeyEnrollment = new PasskeyEnrollmentLocal(); -passkeyEnrollment.abortPasskeyEnrollment({ - doNotShowAgain: <boolean> -}); -``` - -```typescript PasskeyEnrollmentLocal React Example -import React, { useState } from 'react'; -import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local'; - -const PasskeyEnrollmentLocalScreen: React.FC = () => { - const [error, setError] = useState(''); - const [success, setSuccess] = useState(false); - const [aborted, setAborted] = useState(false); - const [doNotShowAgain, setDoNotShowAgain] = useState(false); - - const passkeyEnrollment = new PasskeyEnrollmentLocal(); - - const handleContinue = async (e) => { - e.preventDefault(); - setError(''); - setSuccess(false); - setAborted(false); - try { - await passkeyEnrollment.continuePasskeyEnrollment(); - setSuccess(true); - } catch (err) { - setError('Failed to enroll passkey. Please try again.'); - } - }; - - const handleAbort = async (e) => { - e.preventDefault(); - setError(''); - setSuccess(false); - setAborted(false); - try { - await passkeyEnrollment.abortPasskeyEnrollment({ doNotShowAgain }); - setAborted(true); - } catch (err) { - setError('Failed to abort enrollment. Please try again.'); - } - }; - - return ( - <div className="min-h-screen bg-gray-100 flex flex-col justify-center py-12 sm:px-6 lg:px-8"> - <div className="sm:mx-auto sm:w-full sm:max-w-md"> - <h2 className="mt-6 text-center text-3xl font-extrabold text-gray-900"> - Passkey Enrollment (Local) - </h2> - </div> - <div className="mt-8 sm:mx-auto sm:w-full sm:max-w-md"> - <div className="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10"> - <form className="space-y-6" onSubmit={handleContinue}> - <div className="flex flex-col gap-2"> - <button - type="submit" - className="w-full py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500" - > - Continue Passkey Enrollment - </button> - </div> - </form> - <form className="space-y-6 mt-4" onSubmit={handleAbort}> - <div className="flex items-center"> - <input - id="doNotShowAgain" - name="doNotShowAgain" - type="checkbox" - checked={doNotShowAgain} - onChange={(e) => setDoNotShowAgain(e.target.checked)} - className="h-4 w-4 text-blue-600 focus:ring-blue-500 border-gray-300 rounded" - /> - <label htmlFor="doNotShowAgain" className="ml-2 block text-sm text-gray-900"> - Do not show again - </label> - </div> - <button - type="submit" - className="w-full py-2 px-4 border border-red-600 rounded-md shadow-sm text-sm font-medium text-red-600 bg-white hover:bg-red-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-red-500" - > - Abort Enrollment - </button> - </form> - {error && <div className="text-red-600 text-sm mt-2">{error}</div>} - {success && <div className="text-green-600 text-sm mt-2">Passkey enrollment successful!</div>} - {aborted && <div className="text-blue-600 text-sm mt-2">Passkey enrollment aborted.</div>} - </div> - </div> - </div> - ); -}; - -export default PasskeyEnrollmentLocalScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext">ExtendedScreenContext</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> -</ParamField> - -<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/passkey-enrollment-local.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocalMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocalMembers.mdx deleted file mode 100644 index 0bdbe69ed..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocalMembers.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "PasskeyEnrollmentLocalMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PasskeyEnrollmentLocalMembers extends BaseMembers { - screen: ScreenMembersOnPasskeyEnrollmentLocal; - continuePasskeyEnrollment(payload?: CustomOptions): Promise<void>; - abortPasskeyEnrollment(payload: AbortEnrollmentOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollmentLocal">ScreenMembersOnPasskeyEnrollmentLocal</a></span>} required> -</ParamField> - -<ParamField path="continuePasskeyEnrollment" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="abortPasskeyEnrollment" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/passkey-enrollment-local.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentMembers.mdx deleted file mode 100644 index a11d44416..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentMembers.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "PasskeyEnrollmentMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PasskeyEnrollmentMembers extends BaseMembers { - screen: ScreenMembersOnPasskeyEnrollment; - continuePasskeyEnrollment(payload?: CustomOptions): Promise<void>; - abortPasskeyEnrollment(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollment">ScreenMembersOnPasskeyEnrollment</a></span>} required> -</ParamField> - -<ParamField path="continuePasskeyEnrollment" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="abortPasskeyEnrollment" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/passkey-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyLogin.mdx deleted file mode 100644 index 60d00d254..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyLogin.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "PasskeyLogin" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PasskeyLogin extends Passkey { - public_key: { - challenge: ArrayBuffer; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="public_key" type="object" required> - <Expandable title="properties"> - <ParamField path="challenge" type={<span>ArrayBuffer</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="enabled" type={<span>boolean</span>} required> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead.mdx deleted file mode 100644 index 501832b08..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "PasskeyRead" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PasskeyRead { - public_key: { - challenge: Base64URLString; - allowCredentials?: AllowCredential[]; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="public_key" type="object" required> - <Expandable title="properties"> - <ParamField path="challenge" type={<span>Base64URLString</span>} required> - </ParamField> - <ParamField path="allowCredentials" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AllowCredential">AllowCredential[]</a></span>}> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule.mdx deleted file mode 100644 index 786d3d073..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "PasswordComplexityRule" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PasswordComplexityRule { - code: string; - label: string; - status: 'valid' | 'error'; - isValid: boolean; - args?: { - count: number; - total?: number; - example?: string; - }; - items?: PasswordComplexityRule[]; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="code" type={<span>string</span>} required> -</ParamField> - -<ParamField path="label" type={<span>string</span>} required> -</ParamField> - -<ParamField path="status" type={<span>'valid' | 'error'</span>} required> -</ParamField> - -<ParamField path="isValid" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="args" type="object"> - <Expandable title="properties"> - <ParamField path="count" type={<span>number</span>} required> - </ParamField> - <ParamField path="total" type={<span>number</span>}> - </ParamField> - <ParamField path="example" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="items" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule">PasswordComplexityRule[]</a></span>}> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy.mdx deleted file mode 100644 index e65033d2a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "PasswordPolicy" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PasswordPolicy { - enabled?: boolean; - minLength?: number; - policy: 'none' | 'low' | 'fair' | 'good' | 'excellent'; - passwordSecurityInfo?: PasswordComplexityRule[]; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="enabled" type={<span>boolean</span>}> -</ParamField> - -<ParamField path="minLength" type={<span>number</span>}> -</ParamField> - -<ParamField path="policy" type={<span>'none' | 'low' | 'fair' | 'good' | 'excellent'</span>} required> -</ParamField> - -<ParamField path="passwordSecurityInfo" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule">PasswordComplexityRule[]</a></span>}> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult.mdx deleted file mode 100644 index 14623ce0f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "PasswordValidationResult" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PasswordValidationResult { - /** - * Overall outcome of all password policy checks. - * - * `true` only if every rule in {@link PasswordComplexityRule} has `status` equal to `"valid"`. - */ - isValid: boolean; - - /** - * Array of evaluated password rules. - * - * Each item is a {@link PasswordComplexityRule} whose - * {@link PasswordComplexityRule.status | status} field reflects the - * computed validation result for that rule. - */ - results: PasswordComplexityRule[]; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="isValid" type={<span>boolean</span>} required> - Overall outcome of all password policy checks. `true` only if every rule in has `status` equal to `"valid"`. -</ParamField> - -<ParamField path="results" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule">PasswordComplexityRule[]</a></span>} required> - Array of evaluated password rules. Each item is a whose field reflects the computed validation result for that rule. -</ParamField> - ---- - -**File:** [interfaces/utils/validate-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/validate-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordlessConnection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordlessConnection.mdx deleted file mode 100644 index ef5e836ea..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordlessConnection.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "PasswordlessConnection" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PasswordlessConnection extends Connection { - options: { - signup_enabled: boolean; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="options" type="object" required> - <Expandable title="properties"> - <ParamField path="signup_enabled" type={<span>boolean</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="strategy" type={<span>string</span>} required> -</ParamField> - -<ParamField path="metadata" type={<span>Record<string, string></span>}> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneChallengeOptions.mdx deleted file mode 100644 index 57b91a497..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneChallengeOptions.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "PhoneChallengeOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PhoneChallengeOptions { - code: string; - captcha?: string; - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="code" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captcha" type={<span>string</span>}> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/phone-identifier-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneEnrollmentOptions.mdx deleted file mode 100644 index 0b4c5cd1f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneEnrollmentOptions.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "PhoneEnrollmentOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PhoneEnrollmentOptions { - type: 'text' | 'voice'; - [key: string]: string | number | boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="type" type={<span>'text' | 'voice'</span>} required> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean</span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/phone-identifier-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierChallengeMembers.mdx deleted file mode 100644 index 64d2118a8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierChallengeMembers.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "PhoneIdentifierChallengeMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PhoneIdentifierChallengeMembers extends BaseMembers { - screen: ScreenMembersOnPhoneIdentifierChallenge; - submitPhoneChallenge(payload: PhoneChallengeOptions): Promise<void>; - resendCode(payload?: CustomOptions): Promise<void>; - resendManager(options?: StartResendOptions): ResendControl; - returnToPrevious(payload?: CustomOptions): Promise<void>; - switchToVoice(payload?: CustomOptions): Promise<void>; - switchToText(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierChallenge">ScreenMembersOnPhoneIdentifierChallenge</a></span>} required> -</ParamField> - -<ParamField path="submitPhoneChallenge" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> -</ParamField> - -<ParamField path="returnToPrevious" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="switchToVoice" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="switchToText" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/phone-identifier-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierEnrollmentMembers.mdx deleted file mode 100644 index 4cffaf8c0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierEnrollmentMembers.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "PhoneIdentifierEnrollmentMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PhoneIdentifierEnrollmentMembers extends BaseMembers { - screen: ScreenMembersOnPhoneIdentifierEnrollment; - continuePhoneEnrollment(payload: PhoneEnrollmentOptions): Promise<void>; - returnToPrevious(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierEnrollment">ScreenMembersOnPhoneIdentifierEnrollment</a></span>} required> -</ParamField> - -<ParamField path="continuePhoneEnrollment" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="returnToPrevious" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/phone-identifier-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix.mdx deleted file mode 100644 index 8e1e56e44..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "PhonePrefix" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PhonePrefix { - /** The country name */ - country: string; - /** The country code (e.g. 'US', 'GB') */ - country_code: string; - /** The phone prefix (e.g. '+1', '+44') */ - phone_prefix: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="country" type={<span>string</span>} required> - The country name -</ParamField> - -<ParamField path="country_code" type={<span>string</span>} required> - The country code (e.g. 'US', 'GB') -</ParamField> - -<ParamField path="phone_prefix" type={<span>string</span>} required> - The phone prefix (e.g. '+1', '+44') -</ParamField> - ---- - -**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickAuthenticatorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickAuthenticatorOptions.mdx deleted file mode 100644 index 8a4ea18d0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickAuthenticatorOptions.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "PickAuthenticatorOptions" -description: "@interface PickAuthenticatorOptions Defines the options for the 'pick-authenticator' action. This allows the user to choose a different MFA method if available." ---- - -<RequestExample> - -```typescript Interface lines -export interface PickAuthenticatorOptions extends CustomOptions {} -``` - -</RequestExample> - -## Properties - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-phone-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickPhoneOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickPhoneOptions.mdx deleted file mode 100644 index 79d20a985..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickPhoneOptions.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "PickPhoneOptions" -description: "@interface PickPhoneOptions Defines the options for the 'pick-phone' action. Although the interface only shows one phone number, this action might be used in scenarios where the server needs to redirect to a phone selection screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface PickPhoneOptions extends CustomOptions {} -``` - -</RequestExample> - -## Properties - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-phone-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PostPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PostPayloadOptions.mdx deleted file mode 100644 index 55ef89597..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PostPayloadOptions.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "PostPayloadOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PostPayloadOptions { - state: string; - [key: string]: string | number | boolean | null | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | null | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/utils/form-handler.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/form-handler.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext.mdx deleted file mode 100644 index 213c25862..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "PromptContext" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PromptContext { - name: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - ---- - -**File:** [interfaces/models/prompt.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/prompt.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers.mdx deleted file mode 100644 index cd6379765..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "PromptMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface PromptMembers { - name: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - ---- - -**File:** [interfaces/models/prompt.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/prompt.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/RedeemTicketMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/RedeemTicketMembers.mdx deleted file mode 100644 index b64bfe50c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/RedeemTicketMembers.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "RedeemTicketMembers" -description: "Interface describing the data available on the Redeem Ticket screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface RedeemTicketMembers extends BaseMembers { - client: ClientMembers; - organization: OrganizationMembers; - prompt: PromptMembers; - screen: ScreenMembers; - transaction: TransactionMembers; - - /** - * Performs the default action on the redeem-ticket screen, which usually involves continuing the flow. - * @param {CustomOptions} [payload] - Optional custom options to include with the request. - * @returns {Promise<void>} A promise that resolves when the action is complete. - * @throws {Error} If the operation fails. - * @example - * ```typescript - * import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; - * - * const redeemTicket = new RedeemTicket(); - * await redeemTicket.continue(); - * ``` - */ - continue(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Performs the default action on the redeem-ticket screen, which usually involves continuing the flow. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/redeem-ticket.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions.mdx deleted file mode 100644 index 50fda0d7d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "ReportBrowserErrorOptions" -description: "@interface ReportBrowserErrorOptions" ---- - -<RequestExample> - -```typescript Interface lines -export interface ReportBrowserErrorOptions { - /** - * The error object from the WebAuthn API. This typically is a `DOMException`. - * The SDK expects an object with at least `name` and `message` properties. - * @type {WebAuthnErrorDetails} - * @example { name: "NotAllowedError", message: "The operation was cancelled by the user." } - */ - error: WebAuthnErrorDetails; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="error" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>} required> - The error object from the WebAuthn API. This typically is a `DOMException`. The SDK expects an object with at least `name` and `message` properties. -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportWebAuthnErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportWebAuthnErrorOptions.mdx deleted file mode 100644 index e3b3a20c8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportWebAuthnErrorOptions.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ReportWebAuthnErrorOptions" -description: "@interface ReportWebAuthnErrorOptions" ---- - -<RequestExample> - -```typescript Interface lines -export interface ReportWebAuthnErrorOptions { - error: WebAuthnErrorDetails; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="error" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions.mdx deleted file mode 100644 index f87f94b1d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "ResendCodeOptions" -description: "Options for resending the email code." ---- - -<RequestExample> - -```typescript Interface lines -export interface ResendCodeOptions { - /** Any additional custom options */ - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> - Any additional custom options -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-email-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl.mdx deleted file mode 100644 index 37fcfe880..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ResendControl" -description: "Control object returned by resendManager method" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResendControl { - startResend: () => void; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="startResend" type={<span>() => void</span>} required> -</ParamField> - ---- - -**File:** [interfaces/utils/resend-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/resend-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailMembers.mdx deleted file mode 100644 index efec56e0d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailMembers.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "ResetPasswordEmailMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordEmailMembers extends BaseMembers { - screen: ScreenMembersOnResetPasswordEmail; - resendEmail(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordEmail">ScreenMembersOnResetPasswordEmail</a></span>} required> -</ParamField> - -<ParamField path="resendEmail" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-email.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailOptions.mdx deleted file mode 100644 index c0ffe9470..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailOptions.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ResetPasswordEmailOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordEmailOptions { - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-email.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorMembers.mdx deleted file mode 100644 index a979164be..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorMembers.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "ResetPasswordErrorMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordErrorMembers extends BaseMembers { - screen: ScreenMembersOnResetPasswordError; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordError">ScreenMembersOnResetPasswordError</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-error.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorOptions.mdx deleted file mode 100644 index 10d6171ce..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorOptions.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ResetPasswordErrorOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordErrorOptions { - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-error.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMembers.mdx deleted file mode 100644 index 31991de1f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMembers.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "ResetPasswordMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordMembers extends BaseMembers { - screen: ScreenMembersOnResetPassword; - transaction: TransactionMembersOnResetPassword; - resetPassword(payload: ResetPasswordOptions): Promise<void>; - validatePassword(password: string): PasswordValidationResult; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPassword">ScreenMembersOnResetPassword</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPassword">TransactionMembersOnResetPassword</a></span>} required> -</ParamField> - -<ParamField path="resetPassword" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="validatePassword" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx deleted file mode 100644 index d2a6ff773..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: "ResetPasswordMfaEmailChallengeMembers" -description: "Interface defining the available methods and properties for the reset-password-mfa-email-challenge screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordMfaEmailChallengeMembers extends BaseMembers { - screen: ScreenMembersOnResetPasswordMfaEmailChallenge; - - /** - * Continues with the email challenge using the provided code. - * @param payload The options containing the code and rememberDevice flag. - */ - continue(payload: ContinueOptions): Promise<void>; - - /** - * Resends the email code. - * @param payload Optional custom options to include with the request. - */ - resendCode(payload?: ResendCodeOptions): Promise<void>; - - /** - * Allows the user to try another MFA method. - * @param payload Optional custom options to include with the request. - */ - tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; - - /** - * Gets resend functionality with timeout management for this screen - * @param options Configuration options for resend functionality - */ - resendManager(options?: StartResendOptions): ResendControl; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge">ScreenMembersOnResetPasswordMfaEmailChallenge</a></span>} required> -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Continues with the email challenge using the provided code. -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>} required> - Resends the email code. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows the user to try another MFA method. -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> - Gets resend functionality with timeout management for this screen -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-email-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx deleted file mode 100644 index c3ab62c5c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "ResetPasswordMfaOtpChallengeMembers" -description: "Interface defining the available methods and properties for the reset-password-mfa-otp-challenge screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordMfaOtpChallengeMembers extends BaseMembers { - /** - * Continues with the OTP challenge using the provided code. - * @param payload The options containing the code. - */ - continue(payload: ContinueOptions): Promise<void>; - /** - * Allows the user to try another MFA method. - * @param payload Optional custom options to include with the request. - */ - tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Continues with the OTP challenge using the provided code. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows the user to try another MFA method. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-otp-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx deleted file mode 100644 index 4243269cc..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx +++ /dev/null @@ -1,133 +0,0 @@ ---- -title: "ResetPasswordMfaPhoneChallengeMembers" -description: "@interface ResetPasswordMfaPhoneChallengeMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordMfaPhoneChallengeMembers extends BaseMembers { - /** - * Access to client-specific information (e.g., client ID, name). - * @type {ClientMembers} - */ - client: ClientMembers; - - /** - * Access to organization-specific information, if applicable. - * @type {OrganizationMembers} - */ - organization: OrganizationMembers; - - /** - * Access to prompt details (e.g., prompt name). - * @type {PromptMembers} - */ - prompt: PromptMembers; - - /** - * Access to the specific properties and data of the 'reset-password-mfa-phone-challenge' screen. - * @type {ScreenMembersOnResetPasswordMfaPhoneChallenge} - */ - screen: ScreenMembersOnResetPasswordMfaPhoneChallenge; - - /** - * Access to the current transaction details (e.g., state, errors). - * @type {TransactionMembers} - */ - transaction: TransactionMembers; - - /** - * Sends the verification code to the user's phone via the specified method (SMS or Voice). - * This action corresponds to the user clicking the "Send Code via SMS" or "Send Code via Voice Call" button. - * It triggers the Auth0 backend to initiate the code delivery process. - * - * @param {ContinueOptions} payload - The options specifying the delivery type ('sms' or 'voice') and any custom data. - * @returns {Promise<void>} A promise that resolves when the action is successfully submitted to the server. - * @throws {Error} Throws an error if the submission fails (e.g., network issue, invalid state). - * @example - * ```typescript - * import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; - * - * const screen = new ResetPasswordMfaPhoneChallenge(); - * - * // Send code via SMS - * await screen.continue({ type: 'sms' }); - * - * // Send code via Voice Call - * await screen.continue({ type: 'voice' }); - * ``` - */ - continue(payload: ContinueOptions): Promise<void>; - - /** - * Navigates the user to the screen where they can select an alternative MFA method. - * This action corresponds to the user clicking a "Try Another Method" button. - * - * @param {TryAnotherMethodOptions} payload - The options specifying the current challenge type (`sms` or `voice`) and any custom data. The `type` field is necessary to inform the backend which flow the user is navigating away from. - * @returns {Promise<void>} A promise that resolves when the action is successfully submitted to the server. - * @throws {Error} Throws an error if the submission fails. - * @example - * ```typescript - * import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge'; - * - * const screen = new ResetPasswordMfaPhoneChallenge(); - * - * // If the user was presented with SMS option initially: - * await screen.tryAnotherMethod({ type: 'sms' }); - * - * // If the user was presented with Voice option initially: - * await screen.tryAnotherMethod({ type: 'voice' }); - * ``` - */ - tryAnotherMethod(payload: TryAnotherMethodOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> - Access to client-specific information (e.g., client ID, name). -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> - Access to organization-specific information, if applicable. -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> - Access to prompt details (e.g., prompt name). -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge">ScreenMembersOnResetPasswordMfaPhoneChallenge</a></span>} required> - Access to the specific properties and data of the 'reset-password-mfa-phone-challenge' screen. -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> - Access to the current transaction details (e.g., state, errors). -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Sends the verification code to the user's phone via the specified method (SMS or Voice). This action corresponds to the user clicking the "Send Code via SMS" or "Send Code via Voice Call" button. It triggers the Auth0 backend to initiate the code delivery process. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Navigates the user to the screen where they can select an alternative MFA method. This action corresponds to the user clicking a "Try Another Method" button. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-phone-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx deleted file mode 100644 index f5572380d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "ResetPasswordMfaPushChallengePushMembers" -description: "Interface defining the available methods and properties for the reset-password-mfa-push-challenge-push screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordMfaPushChallengePushMembers extends BaseMembers { - screen: ScreenMembersOnResetPasswordMfaPushChallengePush; - - /** - * Continues with the push notification challenge - * @param payload Optional custom options to include with the request - */ - continue(payload?: CustomOptions): Promise<void>; - - /** - * Resends the push notification - * @param payload Optional custom options to include with the request - */ - resendPushNotification(payload?: CustomOptions): Promise<void>; - - /** - * Switches to entering the verification code manually - * @param payload Optional custom options to include with the request - */ - enterCodeManually(payload?: CustomOptions): Promise<void>; - - /** - * Allows trying another authentication method - * @param payload Optional custom options to include with the request - */ - tryAnotherMethod(payload?: CustomOptions): Promise<void>; - - /** - * Allows polling for the push notification challenge to be approved. - * @param options of type {@link MfaPollingOptions} - */ - pollingManager(options?: MfaPollingOptions): MfaPushPollingControl; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush">ScreenMembersOnResetPasswordMfaPushChallengePush</a></span>} required> -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Continues with the push notification challenge -</ParamField> - -<ParamField path="resendPushNotification" type={<span>Promise<void></span>} required> - Resends the push notification -</ParamField> - -<ParamField path="enterCodeManually" type={<span>Promise<void></span>} required> - Switches to entering the verification code manually -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows trying another authentication method -</ParamField> - -<ParamField path="pollingManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>} required> - Allows polling for the push notification challenge to be approved. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-push-challenge-push.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx deleted file mode 100644 index 6de2a8959..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "ResetPasswordMfaRecoveryCodeChallengeMembers" -description: "Interface describing the members of the Mfa Recovery Code Challenge screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordMfaRecoveryCodeChallengeMembers extends BaseMembers { - client: ClientMembers; - organization: OrganizationMembers; - prompt: PromptMembers; - screen: ScreenMembers; - transaction: TransactionMembers; - - /** - * Continues with the provided recovery code. - * @param {string} code - The recovery code entered by the user. - * @param {CustomOptions} [payload] - Optional payload. - * @returns {Promise<void>} - */ - continue(code: string, payload?: CustomOptions): Promise<void>; - - /** - * Navigates to the screen where the user can pick another MFA method. - * @param {CustomOptions} [payload] - Optional payload. - * @returns {Promise<void>} - */ - tryAnotherMethod(payload?: CustomOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Continues with the provided recovery code. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Navigates to the screen where the user can pick another MFA method. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx deleted file mode 100644 index 56d4b443b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "ResetPasswordMfaSmsChallengeMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordMfaSmsChallengeMembers extends BaseMembers { - screen: ScreenMembersOnResetPasswordMfaSmsChallenge; - continueMfaSmsChallenge(payload: MfaSmsChallengeOptions): Promise<void>; - resendCode(payload?: CustomOptions): Promise<void>; - tryAnotherMethod(payload?: CustomOptions): Promise<void>; - getACall(payload?: CustomOptions): Promise<void>; - /** - * Gets resend functionality with timeout management for this screen - * @param options Configuration options for resend functionality - */ - resendManager(options?: StartResendOptions): ResendControl; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge">ScreenMembersOnResetPasswordMfaSmsChallenge</a></span>} required> -</ParamField> - -<ParamField path="continueMfaSmsChallenge" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="getACall" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> - Gets resend functionality with timeout management for this screen -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-sms-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx deleted file mode 100644 index db78f67da..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: "ResetPasswordMfaVoiceChallengeMembers" -description: "Interface defining the available methods and properties for the reset-password-mfa-voice-challenge screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordMfaVoiceChallengeMembers extends BaseMembers { - screen: ScreenMembersOnResetPasswordMfaVoiceChallenge; - - /** - * Continues with the voice challenge using the provided code. - * - * @param payload - The options containing the code. - * @returns A promise that resolves when the challenge is submitted. - * - * @example - * ```ts - * const reset = new ResetPasswordMfaVoiceChallenge(); - * await reset.continue({ code: '123456' }); - * ``` - */ - continue(payload: ContinueOptions): Promise<void>; - - /** - * Switches to SMS verification. - * - * @param payload - Optional custom options to include with the request. - * @returns A promise that resolves when the action completes. - */ - switchToSms(payload?: CustomOptions): Promise<void>; - - /** - * Re-sends the code via voice call. - * - * @param payload - Optional custom options to include with the request. - * @returns A promise that resolves when the code is resent. - */ - resendCode(payload?: CustomOptions): Promise<void>; - - /** - * Allows the user to try another MFA method. - * - * @param payload - Optional custom options to include with the request. - * @returns A promise that resolves when the request is submitted. - */ - tryAnotherMethod(payload?: CustomOptions): Promise<void>; - - /** - * Gets resend functionality with timeout management for this screen - * @param options Configuration options for resend functionality - */ - resendManager(options?: StartResendOptions): ResendControl; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge">ScreenMembersOnResetPasswordMfaVoiceChallenge</a></span>} required> -</ParamField> - -<ParamField path="continue" type={<span>Promise<void></span>} required> - Continues with the voice challenge using the provided code. -</ParamField> - -<ParamField path="switchToSms" type={<span>Promise<void></span>} required> - Switches to SMS verification. -</ParamField> - -<ParamField path="resendCode" type={<span>Promise<void></span>} required> - Re-sends the code via voice call. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows the user to try another MFA method. -</ParamField> - -<ParamField path="resendManager" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl">ResendControl</a></span>} required> - Gets resend functionality with timeout management for this screen -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-voice-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx deleted file mode 100644 index d8e518cbc..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: "ResetPasswordMfaWebAuthnPlatformChallengeMembers" -description: "@interface ResetPasswordMfaWebAuthnPlatformChallengeMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordMfaWebAuthnPlatformChallengeMembers extends BaseMembers { - /** - * Access to the specific properties and data of the 'reset-password-mfa-webauthn-platform-challenge' screen. - * @type {ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge} - */ - screen: ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge; - - /** - * Initiates the WebAuthn platform authenticator challenge by calling `navigator.credentials.get()` - * using the challenge options provided in `screen.publicKey`. - * If successful, it submits the resulting credential assertion to Auth0 with `action: "default"`. - * - * @param {ContinueWithPasskeyOptions} [options] - Optional parameters for the verification process, - * such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. - * @returns {Promise<void>} A promise that resolves when the verification attempt is submitted. - * A successful operation typically results in a redirect. - * @throws {Error} Throws an error if `screen.publicKey` is missing, - * if `navigator.credentials.get()` fails (e.g., user cancellation `NotAllowedError`), - * or if the form submission to Auth0 fails. If `navigator.credentials.get()` fails - * with a `DOMException`, it's recommended to catch that error and call `reportBrowserError`. - * - * @example - * ```typescript - * // Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge - * try { - * await sdk.continueWithPasskey({ - * rememberDevice: true // if user checked the box and sdk.screen.showRememberDevice is true - * }); - * // On success, Auth0 handles redirection. - * } catch (error) { - * console.error("Platform authenticator verification failed:", error); - * // If it's a WebAuthn API error (DOMException), report it - * if (error instanceof DOMException && error.name && error.message) { - * await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); - * } - * // Check sdk.transaction.errors for server-side validation messages if the page reloads. - * } - * ``` - */ - continueWithPasskey(options?: ContinueWithPasskeyOptions): Promise<void>; - - /** - * Reports a browser-side error that occurred during the `navigator.credentials.get()` API call. - * This is used to inform Auth0 about issues like user cancellation, timeout, or unsupported hardware. - * It submits the error details with `action: "showError::{errorDetailsJsonString}"`. - * - * @param {ReportBrowserErrorOptions} options - Contains the `error` object (with `name` and `message` - * from the WebAuthn API DOMException) and any custom options. - * @returns {Promise<void>} A promise that resolves when the error report is submitted. - * @throws {Error} If the form submission fails (e.g., network error). - * - * @example - * ```typescript - * // Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge - * // and 'webAuthnError' is a DOMException from a failed navigator.credentials.get() call. - * try { - * await sdk.reportBrowserError({ - * error: { name: webAuthnError.name, message: webAuthnError.message } - * }); - * // Auth0 may re-render the page or redirect based on the error. - * } catch (submitError) { - * console.error("Failed to report WebAuthn browser error:", submitError); - * } - * ``` - */ - reportBrowserError(options: ReportBrowserErrorOptions): Promise<void>; - - /** - * Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. - * This action submits `action: "pick-authenticator"` to Auth0, which should navigate - * the user to an MFA factor selection screen for the password reset flow. - * - * @param {TryAnotherMethodOptions} [options] - Optional. Any custom parameters to be sent with the request. - * @returns {Promise<void>} A promise that resolves when the 'pick-authenticator' action is submitted. - * @throws {Error} If the form submission fails. - * - * @example - * ```typescript - * // Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge - * try { - * await sdk.tryAnotherMethod(); - * // On success, Auth0 handles redirection to MFA selection. - * } catch (error) { - * console.error("Failed to switch MFA method:", error); - * } - * ``` - */ - tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge">ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge</a></span>} required> - Access to the specific properties and data of the 'reset-password-mfa-webauthn-platform-challenge' screen. -</ParamField> - -<ParamField path="continueWithPasskey" type={<span>Promise<void></span>} required> - Initiates the WebAuthn platform authenticator challenge by calling `navigator.credentials.get()` using the challenge options provided in `screen.publicKey`. If successful, it submits the resulting credential assertion to Auth0 with `action: "default"`. -</ParamField> - -<ParamField path="reportBrowserError" type={<span>Promise<void></span>} required> - Reports a browser-side error that occurred during the `navigator.credentials.get()` API call. This is used to inform Auth0 about issues like user cancellation, timeout, or unsupported hardware. It submits the error details with `action: "showError::"`. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate the user to an MFA factor selection screen for the password reset flow. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx deleted file mode 100644 index fc5865b50..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: "ResetPasswordMfaWebAuthnRoamingChallengeMembers" -description: "@interface ResetPasswordMfaWebAuthnRoamingChallengeMembers" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordMfaWebAuthnRoamingChallengeMembers extends BaseMembers { - - /** - * Access to the specific properties and data of the `reset-password-mfa-webauthn-roaming-challenge` screen, - * including WebAuthn `publicKey` challenge options and the `showRememberDevice` flag. - * @type {ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge} - */ - screen: ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge; - - /** - * Initiates the WebAuthn assertion process (security key challenge). - * This method will internally call `navigator.credentials.get()` using the challenge - * provided in `screen.publicKey`. - * On successful interaction with the security key, it submits the resulting - * `PublicKeyCredential` to Auth0 with `action: "default"`. - * - * @param {UseSecurityKeyOptions} [options] - Optional. Parameters for the operation, - * such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. - * The `response` field (the WebAuthn credential) is handled internally by the SDK. - * @returns {Promise<void>} A promise that resolves when the verification attempt is submitted. - * A successful operation typically results in a redirect by Auth0. - * @throws {Error} Throws an error if `screen.publicKey` is missing, if `navigator.credentials.get()` - * fails (e.g., user cancellation, no authenticator found), or if the form submission to Auth0 fails. - * It's recommended to catch these errors and potentially use `showError()` to report WebAuthn API specific issues. - */ - useSecurityKey(options?: UseSecurityKeyOptions): Promise<void>; - - /** - * Reports a client-side WebAuthn API error (from `navigator.credentials.get()`) to Auth0. - * This method should be used when `useSecurityKey()` (or a manual `navigator.credentials.get()` call) - * fails due to a browser-side WebAuthn issue (e.g., `NotAllowedError` if the user cancels the prompt, - * `NotFoundError` if no matching authenticator is found, or a timeout). - * It submits the error details with `action: "showError::{errorDetailsJsonString}"` and an empty `response`. - * - * @param {ShowErrorOptions} options - Contains the `error` object (with `name` and `message` - * from the WebAuthn API DOMException), an optional `rememberDevice` flag, and any other custom options. - * @returns {Promise<void>} A promise that resolves when the error report is submitted. - * Auth0 may re-render the page with error information or redirect. - * @throws {Error} Throws an error if the form submission fails (e.g., network error, invalid state). - */ - showError(options: ShowErrorOptions): Promise<void>; - - /** - * Allows the user to opt-out of the WebAuthn roaming challenge and select a different MFA method. - * This action submits `action: "pick-authenticator"` to Auth0, which should navigate - * the user to an MFA factor selection screen. - * - * @param {TryAnotherMethodOptions} [options] - Optional. Parameters for the operation, - * such as `rememberDevice` (if `screen.showRememberDevice` is true) and other custom options. - * @returns {Promise<void>} A promise that resolves when the 'pick-authenticator' action is submitted. - * @throws {Error} Throws an error if the form submission fails. - */ - tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge">ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge</a></span>} required> - Access to the specific properties and data of the `reset-password-mfa-webauthn-roaming-challenge` screen, including WebAuthn `publicKey` challenge options and the `showRememberDevice` flag. -</ParamField> - -<ParamField path="useSecurityKey" type={<span>Promise<void></span>} required> - Initiates the WebAuthn assertion process (security key challenge). This method will internally call `navigator.credentials.get()` using the challenge provided in `screen.publicKey`. On successful interaction with the security key, it submits the resulting `PublicKeyCredential` to Auth0 with `action: "default"`. -</ParamField> - -<ParamField path="showError" type={<span>Promise<void></span>} required> - Reports a client-side WebAuthn API error (from `navigator.credentials.get()`) to Auth0. This method should be used when `useSecurityKey()` (or a manual `navigator.credentials.get()` call) fails due to a browser-side WebAuthn issue (e.g., `NotAllowedError` if the user cancels the prompt, `NotFoundError` if no matching authenticator is found, or a timeout). It submits the error details with `action: "showError::"` and an empty `response`. -</ParamField> - -<ParamField path="tryAnotherMethod" type={<span>Promise<void></span>} required> - Allows the user to opt-out of the WebAuthn roaming challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate the user to an MFA factor selection screen. -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordOptions.mdx deleted file mode 100644 index 42c6de025..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordOptions.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "ResetPasswordOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordOptions { - 'password-reset': string; - 're-enter-password': string; - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="'password-reset'" type={<span>string</span>} required> -</ParamField> - -<ParamField path="'re-enter-password'" type={<span>string</span>} required> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestMembers.mdx deleted file mode 100644 index 9f45c6e2a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestMembers.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "ResetPasswordRequestMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordRequestMembers extends BaseMembers { - screen: ScreenMembersOnResetPasswordRequest; - transaction: TransactionMembersOnResetPasswordRequest; - resetPassword(payload: ResetPasswordRequestOptions): Promise<void>; - backToLogin(payload?: CustomOptions): Promise<void>; - getLoginIdentifiers(): IdentifierType[] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordRequest">ScreenMembersOnResetPasswordRequest</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPasswordRequest">TransactionMembersOnResetPasswordRequest</a></span>} required> -</ParamField> - -<ParamField path="resetPassword" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="backToLogin" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="getLoginIdentifiers" type={<span>IdentifierType[] | null</span>}> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-request.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions.mdx deleted file mode 100644 index 874e4e2b5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "ResetPasswordRequestOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordRequestOptions { - username: string; - captcha?: string; - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="username" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captcha" type={<span>string</span>}> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-request.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessMembers.mdx deleted file mode 100644 index 3d6b7b39f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessMembers.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "ResetPasswordSuccessMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordSuccessMembers extends BaseMembers { - screen: ScreenMembersOnResetPasswordSuccess; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordSuccess">ScreenMembersOnResetPasswordSuccess</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-success.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-success.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessOptions.mdx deleted file mode 100644 index 3f006f154..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessOptions.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ResetPasswordSuccessOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ResetPasswordSuccessOptions { - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-success.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-success.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope.mdx deleted file mode 100644 index 68b6c6f8d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "Scope" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface Scope { - value: string; - description?: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="value" type={<span>string</span>} required> -</ParamField> - -<ParamField path="description" type={<span>string</span>}> -</ParamField> - ---- - -**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext.mdx deleted file mode 100644 index 6a598c658..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "ScreenContext" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenContext { - name: string; - links?: Record<string, string>; - captcha?: CaptchaContext; - data?: ScreenData; - texts?: Record<string, string>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string></span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a></span>}> -</ParamField> - -<ParamField path="data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData">ScreenData</a></span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string></span>}> -</ParamField> - ---- - -**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLogin.mdx deleted file mode 100644 index a86298f72..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLogin.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "ScreenContextOnLogin" -description: "Extended screen context interface for the login screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenContextOnLogin extends ScreenContext { - links: { - signup: string; - reset_password: string; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="links" type="object" required> - <Expandable title="properties"> - <ParamField path="signup" type={<span>string</span>} required> - </ParamField> - <ParamField path="reset_password" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a></span>}> -</ParamField> - -<ParamField path="data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData">ScreenData</a></span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string></span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPassword.mdx deleted file mode 100644 index 056326aeb..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPassword.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "ScreenContextOnLoginPassword" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenContextOnLoginPassword extends ScreenContext { - links: { - signup: string; - reset_password: string; - edit_identifier: string; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="links" type="object" required> - <Expandable title="properties"> - <ParamField path="signup" type={<span>string</span>} required> - </ParamField> - <ParamField path="reset_password" type={<span>string</span>} required> - </ParamField> - <ParamField path="edit_identifier" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a></span>}> -</ParamField> - -<ParamField path="data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData">ScreenData</a></span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string></span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPasswordlessSmsOtp.mdx deleted file mode 100644 index 19187e4a6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPasswordlessSmsOtp.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "ScreenContextOnLoginPasswordlessSmsOtp" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenContextOnLoginPasswordlessSmsOtp extends ScreenContext { - links: { - edit_identifier: string; - reset_password: string; - signup: string; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="links" type="object" required> - <Expandable title="properties"> - <ParamField path="edit_identifier" type={<span>string</span>} required> - </ParamField> - <ParamField path="reset_password" type={<span>string</span>} required> - </ParamField> - <ParamField path="signup" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a></span>}> -</ParamField> - -<ParamField path="data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData">ScreenData</a></span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string></span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-passwordless-sms-otp.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnSignupPassword.mdx deleted file mode 100644 index f2dbdcfe0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnSignupPassword.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "ScreenContextOnSignupPassword" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenContextOnSignupPassword extends ScreenContext { - links: { - login: string; - edit_identifier: string; - }; - - data: { - email?: string; - phone_number?: string; - username?: string; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="links" type="object" required> - <Expandable title="properties"> - <ParamField path="login" type={<span>string</span>} required> - </ParamField> - <ParamField path="edit_identifier" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="data" type="object" required> - <Expandable title="properties"> - <ParamField path="email" type={<span>string</span>}> - </ParamField> - <ParamField path="phone_number" type={<span>string</span>}> - </ParamField> - <ParamField path="username" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a></span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string></span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/signup-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData.mdx deleted file mode 100644 index 5ce1bc4f5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ScreenData" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenData { - [key: string]: string | boolean | PasskeyRead | PasskeyCreate | string[] | Array<PhonePrefix | Scope | AuthorizationDetail> | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="unknown" type={<span>string | boolean | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a> | string[] | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope">Scope</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail">AuthorizationDetail</a>> | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge.mdx deleted file mode 100644 index 706370326..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge" -description: "@interface ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge description Specific data available on the `screen.data` object for the `reset-password-mfa-webauthn-roaming-challenge` screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge { - /** - * The WebAuthn public key credential request options, specifically the challenge (`publicKey`) - * to be used with `navigator.credentials.get()`. - * @type {PasskeyRead} - */ - passkey: PasskeyRead; - /** - * Optional. If true, the UI should offer an option to remember the current device/browser, - * potentially skipping MFA for a defined period on subsequent logins from the same device. - * @type {boolean | undefined} - */ - show_remember_device?: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="passkey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a></span>} required> - The WebAuthn public key credential request options, specifically the challenge (`publicKey`) to be used with `navigator.credentials.get()`. -</ParamField> - -<ParamField path="show_remember_device" type={<span>boolean</span>}> - Optional. If true, the UI should offer an option to remember the current device/browser, potentially skipping MFA for a defined period on subsequent logins from the same device. -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions.mdx deleted file mode 100644 index 473d2a2b2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "ScreenDataOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenDataOptions extends ScreenData { - username?: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="username" type={<span>string</span>}> -</ParamField> - -<ParamField path="unknown" type={<span>string | boolean | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a> | string[] | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope">Scope</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail">AuthorizationDetail</a>> | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers.mdx deleted file mode 100644 index 54dc73f4c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "ScreenMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembers { - name: string; - captchaImage: string | null; - captchaSiteKey: string | null; - captchaProvider: string | null; - isCaptchaAvailable: boolean; - data: Record<string, string | boolean | string[] | Record<string, string[]> | Array<PhonePrefix> | PasskeyCreate> | null; - links: Record<string, string> | null; - texts: Record<string, string> | null; - captcha: CaptchaContext | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnAcceptInvitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnAcceptInvitation.mdx deleted file mode 100644 index c4f09681a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnAcceptInvitation.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "ScreenMembersOnAcceptInvitation" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnAcceptInvitation extends ScreenMembers { - data: { - inviter: string; - email: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="inviter" type={<span>string</span>} required> - </ParamField> - <ParamField path="email" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/accept-invitation.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockFailure.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockFailure.mdx deleted file mode 100644 index 76840068c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockFailure.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "ScreenMembersOnBruteForceProtectionUnblockFailure" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnBruteForceProtectionUnblockFailure extends ScreenMembers { - data: { - errorType?: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="errorType" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/brute-force-protection-unblock-failure.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/brute-force-protection-unblock-failure.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockSuccess.mdx deleted file mode 100644 index 284b0a31b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockSuccess.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "ScreenMembersOnBruteForceProtectionUnblockSuccess" -description: "Represents the screen members specific to the Brute Force Protection Unblock Success screen. Extends the base ScreenMembers interface." ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnBruteForceProtectionUnblockSuccess extends ScreenMembers {} -``` - -</RequestExample> - -## Properties - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/brute-force-protection-unblock-success.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/brute-force-protection-unblock-success.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnConsent.mdx deleted file mode 100644 index 572b4d141..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnConsent.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "ScreenMembersOnConsent" -description: "@interface ScreenMembersOnConsent" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnConsent extends ScreenMembers { - scopes: Scope[]; - hideScopes: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="scopes" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope">Scope[]</a></span>} required> -</ParamField> - -<ParamField path="hideScopes" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/consent.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/consent.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnCustomizedConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnCustomizedConsent.mdx deleted file mode 100644 index 190b53a1c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnCustomizedConsent.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "ScreenMembersOnCustomizedConsent" -description: "@interface ScreenMembersOnCustomizedConsent" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnCustomizedConsent extends ScreenMembers { - /** - * An array of `Scope` objects detailing each permission (scope) being requested. - * These are typically high-level permissions like 'read:profile' or 'openid'. - * This list should be displayed to the user for their review. - */ - scopes: Scope[]; - - /** - * An array of `AuthorizationDetail` objects. - * Each object provides granular details about specific data or - * actions the application wants to perform, potentially related to - * Rich Authorization Requests (RAR) or other fine-grained permission models. - * This list should be displayed to the user for their review. - */ - authorizationDetails: AuthorizationDetail[]; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="scopes" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope">Scope[]</a></span>} required> - An array of `Scope` objects detailing each permission (scope) being requested. These are typically high-level permissions like 'read:profile' or 'openid'. This list should be displayed to the user for their review. -</ParamField> - -<ParamField path="authorizationDetails" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail">AuthorizationDetail[]</a></span>} required> - An array of `AuthorizationDetail` objects. Each object provides granular details about specific data or actions the application wants to perform, potentially related to Rich Authorization Requests (RAR) or other fine-grained permission models. This list should be displayed to the user for their review. -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/customized-consent.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/customized-consent.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx deleted file mode 100644 index 936583446..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "ScreenMembersOnDeviceCodeConfirmation" -description: "Interface describing the data available on the Device Code Confirmation screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnDeviceCodeConfirmation extends ScreenMembers { - data: { - textCode: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="textCode" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/device-code-confirmation.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx deleted file mode 100644 index 9e0cad6b5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "ScreenMembersOnEmailIdentifierChallenge" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnEmailIdentifierChallenge extends ScreenMembers { - data: { - messageType?: string; - email?: string; - resendLimitReached?: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="messageType" type={<span>string</span>}> - </ParamField> - <ParamField path="email" type={<span>string</span>}> - </ParamField> - <ParamField path="resendLimitReached" type={<span>boolean</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/email-identifier-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailOTPChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailOTPChallenge.mdx deleted file mode 100644 index ed2c3d027..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailOTPChallenge.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "ScreenMembersOnEmailOTPChallenge" -description: "Represents the members of the Email OTP Challenge screen. Extends the base ScreenMembers interface." ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnEmailOTPChallenge extends ScreenMembers { - // Add any specific members for this screen here -} -``` - -</RequestExample> - -## Properties - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/email-otp-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailVerificationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailVerificationResult.mdx deleted file mode 100644 index b216b7c21..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailVerificationResult.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "ScreenMembersOnEmailVerificationResult" -description: "@interface ScreenMembersOnEmailVerificationResult" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnEmailVerificationResult extends ScreenMembers { - /** - * Screen-specific data containing the status of the email verification. - * @type {{ status: string; } | null} - */ - data: { - /** - * The status of the email verification process. - * Possible values might include "success", "failure", "already_verified", etc. - * This status should be displayed to the user to inform them of the outcome. - */ - status: string; - } | null; - - /** - * Navigation links available on this screen. - * @type {string | null} - */ - loginLink: string | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="loginLink" type={<span>string | null</span>}> - Navigation links available on this screen. -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/email-verification-result.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLogin.mdx deleted file mode 100644 index 7f3fad931..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLogin.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: "ScreenMembersOnLogin" -description: "Extended screen members interface for the login screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnLogin extends ScreenMembers { - signupLink: string | null; - resetPasswordLink: string | null; - data: { - username?: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="signupLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="resetPasswordLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="username" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginId.mdx deleted file mode 100644 index 386ebfbb0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginId.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "ScreenMembersOnLoginId" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnLoginId extends ScreenMembers { - signupLink: string | null; - resetPasswordLink: string | null; - publicKey: PasskeyRead['public_key'] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="signupLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="resetPasswordLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key'] | null</span>}> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPassword.mdx deleted file mode 100644 index ed666980d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPassword.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "ScreenMembersOnLoginPassword" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnLoginPassword extends ScreenMembers { - signupLink: string | null; - resetPasswordLink: string | null; - editIdentifierLink: string | null; - data: { - username: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="signupLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="resetPasswordLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="editIdentifierLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="username" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx deleted file mode 100644 index 62c6c55b7..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "ScreenMembersOnLoginPasswordlessEmailCode" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnLoginPasswordlessEmailCode extends ScreenMembers { - editIdentifierLink: string | null; - resetPasswordLink: string | null; - signupLink: string | null; - data: { - email?: string; - username?: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="editIdentifierLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="resetPasswordLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="signupLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="email" type={<span>string</span>}> - </ParamField> - <ParamField path="username" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-passwordless-email-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx deleted file mode 100644 index b136863d3..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "ScreenMembersOnLoginPasswordlessSmsOtp" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnLoginPasswordlessSmsOtp extends ScreenMembers { - signupLink: string | null; - resetPasswordLink: string | null; - backLink: string | null; - data: { - username: string; - phone_number: string; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="signupLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="resetPasswordLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="backLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="data" type="object" required> - <Expandable title="properties"> - <ParamField path="username" type={<span>string</span>} required> - </ParamField> - <ParamField path="phone_number" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-passwordless-sms-otp.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaCountryCodes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaCountryCodes.mdx deleted file mode 100644 index c35da48a4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaCountryCodes.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "ScreenMembersOnMfaCountryCodes" -description: "Interface for screen data specific to mfa-country-codes screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaCountryCodes extends ScreenMembers { - data: { - /** List of available phone prefixes */ - phone_prefixes: PhonePrefix[]; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-country-codes.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailChallenge.mdx deleted file mode 100644 index 06c9c1a66..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailChallenge.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "ScreenMembersOnMfaEmailChallenge" -description: "Interface for the screen data specific to mfa-email-challenge screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaEmailChallenge extends ScreenMembers { - data: { - email: string; - showRememberDevice?: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="email" type={<span>string</span>} required> - </ParamField> - <ParamField path="showRememberDevice" type={<span>boolean</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-email-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailList.mdx deleted file mode 100644 index 50a1f3d60..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailList.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "ScreenMembersOnMfaEmailList" -description: "Interface for the screen data specific to mfa-email-list screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaEmailList extends ScreenMembers { - data: { - /** List of enrolled email addresses */ - enrolled_emails: string[]; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-email-list.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEnrollResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEnrollResult.mdx deleted file mode 100644 index f9daec671..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEnrollResult.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: "ScreenMembersOnMfaEnrollResult" -description: "@interface ScreenMembersOnMfaEnrollResult" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaEnrollResult extends ScreenMembers { - /** - * Screen-specific data containing the status of the MFA enrollment. - * @type {{ status: string; } | null} - */ - data: { - /** - * The status of the MFA enrollment process. - * Possible values might include "success", "failure", or other specific status codes. - * This status can be used to display an appropriate message to the user. - * @type {string} - */ - status: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-enroll-result.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaLoginOptions.mdx deleted file mode 100644 index a3987fcc4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaLoginOptions.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "ScreenMembersOnMfaLoginOptions" -description: "Interface for the screen data specific to mfa-login-options screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaLoginOptions extends ScreenMembers { - data: { - /** List of enrolled MFA factors for the user */ - enrolled_factors: string[]; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-login-options.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpChallenge.mdx deleted file mode 100644 index e2a1fbe85..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpChallenge.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "ScreenMembersOnMfaOtpChallenge" -description: "Interface for the screen data specific to mfa-otp-challenge screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaOtpChallenge extends ScreenMembers { - data: { - showRememberDevice?: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="showRememberDevice" type={<span>boolean</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-otp-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx deleted file mode 100644 index 44e0812d6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "ScreenMembersOnMfaOtpEnrollmentCode" -description: "Interface for the screen data specific to the mfa-otp-enrollment-code screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaOtpEnrollmentCode extends ScreenMembers { - data: { - /** - * The text code to display to the user. - */ - text_code: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-otp-enrollment-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx deleted file mode 100644 index 646aa3266..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "ScreenMembersOnMfaOtpEnrollmentQr" -description: "Interface for the screen data specific to mfa-otp-enrollment-qr screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaOtpEnrollmentQr extends ScreenMembers { - data: { - qr_code: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="qr_code" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-otp-enrollment-qr.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx deleted file mode 100644 index 42461ca05..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "ScreenMembersOnMfaPhoneChallenge" -description: "@interface ScreenMembersOnMfaPhoneChallenge" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaPhoneChallenge extends ScreenMembers { - /** - * @property {object | null} data - Screen-specific data. - * @property {string} data.phone_number - The phone number (often masked) associated with this MFA challenge. - */ - data: { - /** The phone number (often masked) associated with this MFA challenge. */ - phoneNumber: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-phone-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushChallengePush.mdx deleted file mode 100644 index 3f1c04458..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushChallengePush.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "ScreenMembersOnMfaPushChallengePush" -description: "Interface for the screen data specific to mfa-push-challenge-push screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaPushChallengePush extends ScreenMembers { - data: { - /** The name of the device receiving the push notification */ - deviceName: string; - /** Whether to show the remember device option */ - showRememberDevice?: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-push-challenge-push.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx deleted file mode 100644 index 3102abe3c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "ScreenMembersOnMfaPushEnrollmentQr" -description: "Interface for the screen data specific to mfa-push-enrollment-qr screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaPushEnrollmentQr extends ScreenMembers { - data: { - qrCode: string; - qrUri: string; - showCodeCopy: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="qrCode" type={<span>string</span>} required> - </ParamField> - <ParamField path="qrUri" type={<span>string</span>} required> - </ParamField> - <ParamField path="showCodeCopy" type={<span>boolean</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-push-enrollment-qr.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushWelcome.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushWelcome.mdx deleted file mode 100644 index c3a55ad59..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushWelcome.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "ScreenMembersOnMfaPushWelcome" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaPushWelcome extends ScreenMembers { - screen: { - name: string; - links: { - ios: string; - android: string; - }; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type="object" required> - <Expandable title="properties"> - <ParamField path="name" type={<span>string</span>} required> - </ParamField> - <ParamField path="links" type="object" required> - <Expandable title="properties"> - <ParamField path="ios" type={<span>string</span>} required> - </ParamField> - <ParamField path="android" type={<span>string</span>} required> - </ParamField> - </Expandable> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-push-welcome.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx deleted file mode 100644 index f79ca078f..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "ScreenMembersOnMfaRecoveryCodeChallengeNewCode" -description: "@interface ScreenMembersOnMfaRecoveryCodeChallengeNewCode" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaRecoveryCodeChallengeNewCode extends ScreenMembers { - /** - * @property {object | null} data - Screen-specific data. - * @property {string} data.textCode - The newly generated recovery code that the user must save. - */ - data: { - /** - * The newly generated recovery code to display to the user. - * It is crucial that the user saves this code securely as it will be needed for future logins if other MFA factors are unavailable. - */ - textCode: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-recovery-code-challenge-new-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx deleted file mode 100644 index ac7ef71de..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "ScreenMembersOnMfaRecoveryCodeEnrollment" -description: "Interface describing the data available on the Mfa Recovery Code Enrollment screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaRecoveryCodeEnrollment extends ScreenMembers { - data: { - /** - * The recovery code to display to the user. - */ - textCode: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-recovery-code-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsChallenge.mdx deleted file mode 100644 index 656ea61e3..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsChallenge.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "ScreenMembersOnMfaSmsChallenge" -description: "Interface for the screen data specific to mfa-sms-challenge screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaSmsChallenge extends ScreenMembers { - data: { - /** - * The phone number where the SMS was sent - */ - phoneNumber?: string; - /** - * Whether to show the remember device option - */ - showRememberDevice?: boolean; - /** - * Whether to show the link to switch to voice call verification - */ - showLinkVoice?: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-sms-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx deleted file mode 100644 index fb6bb9941..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "ScreenMembersOnMfaSmsEnrollment" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaSmsEnrollment extends ScreenMembers { - data: { - phone?: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="phone" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-sms-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx deleted file mode 100644 index 5f64cbc1c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "ScreenMembersOnMfaVoiceChallenge" -description: "Extended screen members interface for the MFA Voice Challenge screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaVoiceChallenge extends ScreenMembers { - /** - * Additional screen data specific to MFA voice challenge. - */ - data: { - /** - * The phone number where the voice code was sent. - */ - phoneNumber?: string; - - /** - * Whether to show the remember device option. - */ - showRememberDevice?: boolean; - - /** - * Whether to show the link to switch to SMS verification. - */ - showLinkSms?: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-voice-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx deleted file mode 100644 index 0733487d2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "ScreenMembersOnMfaWebAuthnChangeKeyNickname" -description: "@interface ScreenMembersOnMfaWebAuthnChangeKeyNickname" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaWebAuthnChangeKeyNickname extends ScreenMembers { - /** - * Screen-specific data containing the current nickname of the WebAuthn key. - * @type {{ nickname: string; } | null} - */ - data: { - /** - * The current nickname of the WebAuthn security key that the user is about to change. - * This value should be displayed to the user for context. - * @type {string} - * @example "My YubiKey" - * @example "Work Security Key" - */ - nickname: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-change-key-nickname.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx deleted file mode 100644 index 59822a41d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "ScreenMembersOnMfaWebAuthnEnrollmentSuccess" -description: "@interface ScreenMembersOnMfaWebAuthnEnrollmentSuccess" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaWebAuthnEnrollmentSuccess extends ScreenMembers { - /** - * Screen-specific data containing details about the successful WebAuthn enrollment. - * @type {{ nickname: string; webauthnType: WebAuthnType; } | null} - */ - data: { - /** - * The nickname that the user (or system) assigned to the newly enrolled WebAuthn authenticator. - * This helps the user identify the authenticator later. - * @type {string} - * @example "YubiKey 5" - * @example "My Laptop's Touch ID" - */ - nickname: string; - /** - * The type of WebAuthn authenticator that was successfully enrolled. - * - `'webauthn-roaming'`: Indicates a roaming authenticator like a USB security key. - * - `'webauthn-platform'`: Indicates a platform authenticator like Touch ID or Windows Hello. - * @type {WebAuthnType} - */ - webauthnType: WebAuthnType; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-enrollment-success.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnError.mdx deleted file mode 100644 index bdc1cf5f8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnError.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "ScreenMembersOnMfaWebAuthnError" -description: "@interface ScreenMembersOnMfaWebAuthnError" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaWebAuthnError extends ScreenMembers { - /** - * @property {object | null} data - Screen-specific data detailing the WebAuthn error. - * @property {string} data.errorType - A string code or message describing the nature of the WebAuthn error - * (e.g., "NotAllowedError", "TimeoutError", "InvalidStateError"). - * @property {WebAuthnType} data.webauthnType - Indicates whether the error occurred with a 'webauthn-roaming' - * or 'webauthn-platform' authenticator. - */ - data: { - /** - * A code or message describing the WebAuthn error. - */ - errorType: string; - /** - * The type of WebAuthn authenticator involved. - */ - webauthnType: WebAuthnType; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-error.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx deleted file mode 100644 index d15452ed9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "ScreenMembersOnMfaWebAuthnPlatformChallenge" -description: "@interface ScreenMembersOnMfaWebAuthnPlatformChallenge" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaWebAuthnPlatformChallenge extends ScreenMembers { - /** - * Direct access to the `PublicKeyCredentialRequestOptions` (specifically the challenge part) - * needed for `navigator.credentials.get()`. - * This is a convenience accessor for `data?.passkey?.public_key`. - * @type {PasskeyRead['public_key'] | null} - */ - publicKey: PasskeyRead['public_key'] | null; - - /** - * Indicates whether the "Remember this device" checkbox should be displayed. - * @type {boolean} - */ - showRememberDevice: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key'] | null</span>}> - Direct access to the `PublicKeyCredentialRequestOptions` (specifically the challenge part) needed for `navigator.credentials.get()`. This is a convenience accessor for `data?.passkey?.public_key`. -</ParamField> - -<ParamField path="showRememberDevice" type={<span>boolean</span>} required> - Indicates whether the "Remember this device" checkbox should be displayed. -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-platform-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx deleted file mode 100644 index 424ae2b8a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "ScreenMembersOnMfaWebAuthnPlatformEnrollment" -description: "@interface ScreenMembersOnMfaWebAuthnPlatformEnrollment" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaWebAuthnPlatformEnrollment extends ScreenMembers { - /** - * @property {PasskeyCreate['public_key'] | null} publicKey - Direct access to the `PublicKeyCredentialCreationOptions`. - * This is a convenience accessor for `data?.passkeys?.public_key`. It provides the necessary options - * for `navigator.credentials.create()`. - */ - publicKey: PasskeyCreate['public_key'] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>['public_key'] | null</span>}> - Direct access to the `PublicKeyCredentialCreationOptions`. This is a convenience accessor for `data?.passkeys?.public_key`. It provides the necessary options for `navigator.credentials.create()`. -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-platform-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx deleted file mode 100644 index 14ef49a43..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "ScreenMembersOnMfaWebAuthnRoamingChallenge" -description: "@interface ScreenMembersOnMfaWebAuthnRoamingChallenge" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaWebAuthnRoamingChallenge extends ScreenMembers { - showRememberDevice?: boolean; - webauthnType: string | null; - publicKey: PasskeyRead['public_key'] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="showRememberDevice" type={<span>boolean</span>}> -</ParamField> - -<ParamField path="webauthnType" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key'] | null</span>}> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx deleted file mode 100644 index 96afa301a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "ScreenMembersOnMfaWebAuthnRoamingEnrollment" -description: "Interface for screen data specific to mfa-webauthn-roaming-enrollment screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnMfaWebAuthnRoamingEnrollment extends ScreenMembers { - webauthnType: string | null; - publicKey: PasskeyCreate['public_key'] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="webauthnType" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>['public_key'] | null</span>}> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-roaming-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnOrganizationSelection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnOrganizationSelection.mdx deleted file mode 100644 index 58dded037..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnOrganizationSelection.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "ScreenMembersOnOrganizationSelection" -description: "Interface for the screen data specific to organization-selection screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnOrganizationSelection extends ScreenMembers { - client: ClientMembers; - organization: OrganizationMembers; - prompt: PromptMembers; - screen: ScreenMembers; - transaction: TransactionMembers; - User: UserMembers; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers">ScreenMembers</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers">TransactionMembers</a></span>} required> -</ParamField> - -<ParamField path="User" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/organization-selection.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/organization-selection.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollment.mdx deleted file mode 100644 index 43d291601..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollment.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "ScreenMembersOnPasskeyEnrollment" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnPasskeyEnrollment extends ScreenMembers { - backLink: string | null; - loginLink: string | null; - publicKey: PasskeyCreate['public_key'] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="backLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="loginLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>['public_key'] | null</span>}> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/passkey-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx deleted file mode 100644 index 1a0771e6e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "ScreenMembersOnPasskeyEnrollmentLocal" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnPasskeyEnrollmentLocal extends ScreenMembers { - publicKey: PasskeyCreate['public_key'] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>['public_key'] | null</span>}> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/passkey-enrollment-local.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx deleted file mode 100644 index 9003f520b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "ScreenMembersOnPhoneIdentifierChallenge" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnPhoneIdentifierChallenge extends ScreenMembers { - data: { - messageType?: 'text' | 'voice'; - phone?: string; - resendLimitReached?: boolean; - showLinkSms?: boolean; - showLinkVoice?: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="messageType" type={<span>'text' | 'voice'</span>}> - </ParamField> - <ParamField path="phone" type={<span>string</span>}> - </ParamField> - <ParamField path="resendLimitReached" type={<span>boolean</span>}> - </ParamField> - <ParamField path="showLinkSms" type={<span>boolean</span>}> - </ParamField> - <ParamField path="showLinkVoice" type={<span>boolean</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/phone-identifier-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx deleted file mode 100644 index 93eaf9c5a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "ScreenMembersOnPhoneIdentifierEnrollment" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnPhoneIdentifierEnrollment extends ScreenMembers { - data: { - phone?: 'string'; - messageType?: 'text' | 'voice'; - } | null; - editIdentifierLink: string | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="phone" type={<span>'string'</span>}> - </ParamField> - <ParamField path="messageType" type={<span>'text' | 'voice'</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="editIdentifierLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/phone-identifier-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPassword.mdx deleted file mode 100644 index 93591af33..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPassword.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "ScreenMembersOnResetPassword" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnResetPassword extends ScreenMembers { - data: { - username?: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="username" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordEmail.mdx deleted file mode 100644 index dce9b7054..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordEmail.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "ScreenMembersOnResetPasswordEmail" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnResetPasswordEmail extends ScreenMembers { - data: { - username?: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="username" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-email.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordError.mdx deleted file mode 100644 index dc718cbbb..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordError.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "ScreenMembersOnResetPasswordError" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnResetPasswordError extends ScreenMembers { - data: { - username?: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="username" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-error.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx deleted file mode 100644 index 08f584883..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "ScreenMembersOnResetPasswordMfaEmailChallenge" -description: "Interface for the screen data specific to reset-password-mfa-email-challenge screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnResetPasswordMfaEmailChallenge extends ScreenMembers { - data: { - email: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="email" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-email-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx deleted file mode 100644 index e4b4ccce0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "ScreenMembersOnResetPasswordMfaPhoneChallenge" -description: "@interface ScreenMembersOnResetPasswordMfaPhoneChallenge" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnResetPasswordMfaPhoneChallenge extends ScreenMembers { - /** - * @property {object | null} data - Screen-specific data. - * @property {string} data.phoneNumber - The phone number (often masked for security) associated with this MFA challenge during password reset. - */ - data: { - /** The phone number (often masked) associated with this MFA challenge. */ - phoneNumber: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-phone-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx deleted file mode 100644 index 307d396bc..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "ScreenMembersOnResetPasswordMfaPushChallengePush" -description: "Interface for the screen data specific to reset-password-mfa-push-challenge-push screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnResetPasswordMfaPushChallengePush - extends ScreenMembers { - data: { - deviceName: string; - rememberDevice?: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="deviceName" type={<span>string</span>} required> - </ParamField> - <ParamField path="rememberDevice" type={<span>boolean</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-push-challenge-push.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx deleted file mode 100644 index 8ae464465..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "ScreenMembersOnResetPasswordMfaSmsChallenge" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnResetPasswordMfaSmsChallenge extends ScreenMembers { - data: { - phoneNumber: string; - /** - * Whether to show the link to switch to voice call verification - */ - showLinkVoice?: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="phoneNumber" type={<span>string</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-sms-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx deleted file mode 100644 index 8549378e3..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "ScreenMembersOnResetPasswordMfaVoiceChallenge" -description: "Interface for the screen data specific to reset-password-mfa-voice-challenge screen." ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnResetPasswordMfaVoiceChallenge extends ScreenMembers { - data: { - /** - * The phone number to send the voice call to. - */ - phoneNumber: string; - - /** - * Whether to show the link to switch to SMS verification. - */ - showLinkSms?: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-voice-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx deleted file mode 100644 index 2de0d6f63..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge" -description: "@interface ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge extends ScreenMembers { - /** - * Convenience getter for the public key credential request options (challenge) needed for WebAuthn. - * This is derived from `screen.data.passkey.public_key`. - * If `screen.data.passkey` or `screen.data.passkey.public_key` is not available, this will be `null`. - * @type {PasskeyRead['public_key'] | null} - */ - publicKey: PasskeyRead['public_key'] | null; - - /** - * Convenience getter for whether the "Remember this device" option should be shown. - * Derived from `screen.data.show_remember_device`. Defaults to `false` if not specified. - * @type {boolean} - */ - showRememberDevice: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key'] | null</span>}> - Convenience getter for the public key credential request options (challenge) needed for WebAuthn. This is derived from `screen.data.passkey.public_key`. If `screen.data.passkey` or `screen.data.passkey.public_key` is not available, this will be `null`. -</ParamField> - -<ParamField path="showRememberDevice" type={<span>boolean</span>} required> - Convenience getter for whether the "Remember this device" option should be shown. Derived from `screen.data.show_remember_device`. Defaults to `false` if not specified. -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx deleted file mode 100644 index f8d2f3621..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge" -description: "@interface ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge extends ScreenMembers { - /** - * A direct accessor for the `passkey.public_key` data from `screen.data`. - * This object contains the challenge and other options necessary for the - * `navigator.credentials.get()` WebAuthn API call. - * It is `null` if `screen.data.passkey.public_key` is not available. - * @type {PasskeyRead['public_key'] | null} - * @public - */ - publicKey: PasskeyRead['public_key'] | null; - - /** - * A direct accessor for the `show_remember_device` flag from `screen.data`. - * Indicates whether the UI should present an option to the user to remember this device/browser - * to potentially bypass MFA on future logins. Defaults to `false` if not set in `screen.data`. - * @type {boolean} - * @public - */ - showRememberDevice: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="publicKey" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead">PasskeyRead</a>['public_key'] | null</span>}> - A direct accessor for the `passkey.public_key` data from `screen.data`. This object contains the challenge and other options necessary for the `navigator.credentials.get()` WebAuthn API call. It is `null` if `screen.data.passkey.public_key` is not available. -</ParamField> - -<ParamField path="showRememberDevice" type={<span>boolean</span>} required> - A direct accessor for the `show_remember_device` flag from `screen.data`. Indicates whether the UI should present an option to the user to remember this device/browser to potentially bypass MFA on future logins. Defaults to `false` if not set in `screen.data`. -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordRequest.mdx deleted file mode 100644 index 9cdab6448..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordRequest.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "ScreenMembersOnResetPasswordRequest" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnResetPasswordRequest extends ScreenMembers { - data: { - phone?: string; - email?: string; - username?: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="phone" type={<span>string</span>}> - </ParamField> - <ParamField path="email" type={<span>string</span>}> - </ParamField> - <ParamField path="username" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-request.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordSuccess.mdx deleted file mode 100644 index fc68e25e4..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordSuccess.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "ScreenMembersOnResetPasswordSuccess" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnResetPasswordSuccess extends ScreenMembers {} -``` - -</RequestExample> - -## Properties - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-success.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-success.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignup.mdx deleted file mode 100644 index db32b61fc..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignup.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "ScreenMembersOnSignup" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnSignup extends ScreenMembers { - loginLink: string | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="loginLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/signup.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupId.mdx deleted file mode 100644 index 7481245cc..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupId.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "ScreenMembersOnSignupId" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnSignupId extends ScreenMembers { - loginLink: string | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="loginLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="data" type={<span>Record<string, string | boolean | string[] | Record<string, string[]> | Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix">PhonePrefix</a>> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate">PasskeyCreate</a>> | null</span>}> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/signup-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupPassword.mdx deleted file mode 100644 index 5671fb387..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupPassword.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "ScreenMembersOnSignupPassword" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface ScreenMembersOnSignupPassword extends ScreenMembers { - loginLink: string | null; - editLink: string | null; - data: { - email?: string; - phoneNumber?: string; - username?: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="loginLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="editLink" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="data" type="object"> - <Expandable title="properties"> - <ParamField path="email" type={<span>string</span>}> - </ParamField> - <ParamField path="phoneNumber" type={<span>string</span>}> - </ParamField> - <ParamField path="username" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captchaImage" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaSiteKey" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="captchaProvider" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="isCaptchaAvailable" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="links" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="texts" type={<span>Record<string, string> | null</span>}> -</ParamField> - -<ParamField path="captcha" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext">CaptchaContext</a> | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/signup-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectCountryCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectCountryCodeOptions.mdx deleted file mode 100644 index 71e91c9cf..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectCountryCodeOptions.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "SelectCountryCodeOptions" -description: "Options for selecting a country code" ---- - -<RequestExample> - -```typescript Interface lines -export interface SelectCountryCodeOptions { - /** The country code (e.g. 'US', 'GB') */ - country_code: string; - /** The phone prefix (e.g. '+1', '+44') */ - phone_prefix: string; - /** Any additional custom options */ - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="country_code" type={<span>string</span>} required> - The country code (e.g. 'US', 'GB') -</ParamField> - -<ParamField path="phone_prefix" type={<span>string</span>} required> - The phone prefix (e.g. '+1', '+44') -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> - Any additional custom options -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-country-codes.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaEmailOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaEmailOptions.mdx deleted file mode 100644 index 24fecf9c6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaEmailOptions.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "SelectMfaEmailOptions" -description: "Options for selecting an email address" ---- - -<RequestExample> - -```typescript Interface lines -export interface SelectMfaEmailOptions { - /** - * @param {number} index - The index of the phone number to select. - * - */ - index: number; - /** Any additional custom options */ - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="index" type={<span>number</span>} required> - @param index - The index of the phone number to select. -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> - Any additional custom options -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-email-list.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaPushDeviceOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaPushDeviceOptions.mdx deleted file mode 100644 index 2534cabd8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaPushDeviceOptions.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "SelectMfaPushDeviceOptions" -description: "Options for selecting an MFA push device." ---- - -<RequestExample> - -```typescript Interface lines -export interface SelectMfaPushDeviceOptions { - /** - * The index of the device to select from the list of enrolled devices. - * The index is 0-based. - */ - deviceIndex: number; - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="deviceIndex" type={<span>number</span>} required> - The index of the device to select from the list of enrolled devices. The index is 0-based. -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-push-list.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectOrganizationOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectOrganizationOptions.mdx deleted file mode 100644 index 645cff9ad..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectOrganizationOptions.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "SelectOrganizationOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface SelectOrganizationOptions { - organization: string; - state: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="organization" type={<span>string</span>} required> -</ParamField> - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/organization-picker.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/organization-picker.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions.mdx deleted file mode 100644 index 6ca5968d9..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "ShowErrorOptions" -description: "@interface ShowErrorOptions" ---- - -<RequestExample> - -```typescript Interface lines -export interface ShowErrorOptions { - /** - * The error object captured from a failed `navigator.credentials.get()` call. - * This should include at least `name` and `message` properties of the DOMException. - * @type {WebAuthnErrorDetails} - * @example { name: "NotAllowedError", message: "The operation was aborted by the user." } - */ - error: WebAuthnErrorDetails; - - /** - * Optional. If `true`, and if the screen context (`screen.showRememberDevice`) - * indicates that remembering the device is an option, this signals the user's - * intent to remember this browser/device. - * @type {boolean | undefined} - */ - rememberDevice?: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="error" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>} required> - The error object captured from a failed `navigator.credentials.get()` call. This should include at least `name` and `message` properties of the DOMException. -</ParamField> - -<ParamField path="rememberDevice" type={<span>boolean</span>}> - Optional. If `true`, and if the screen context (`screen.showRememberDevice`) indicates that remembering the device is an option, this signals the user's intent to remember this browser/device. -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupId.mdx deleted file mode 100644 index fad5202de..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupId.mdx +++ /dev/null @@ -1,283 +0,0 @@ ---- -title: "SignupId" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface SignupId extends BaseContext { - screen: ExtendedScreenContext; - untrusted_data?: ExtendedUntrustedDataContext; -} -``` - -```typescript signup -import SignupId from "@auth0/auth0-acul-js/signup-id"; - const signupIdManager = new SignupId(); - - //get mandatory & optional identifiers required for signup - const { transaction } = signupIdManager; - const mandatoryIdentifier = transaction.getRequiredIdentifiers(); // eg: email - const optionalIdentifiers = transaction.getOptionalIdentifiers() // eg: phone - - /* Based on mandatory & optional identifiers users can render corresponding field on signup-id screen */ - - const signupParams = { - email : "testEmail", - phone : "+91923456789" - } - - signupIdManager.signup(signupParams); -``` - -```typescript socialSignup -import SignupId from "@auth0/auth0-acul-js/signup-id"; - - const signupIdManager = new SignupId(); - const { transaction } = signupIdManager; - - //get social connections - const socialConnection = transaction.alternateConnections; //eg: "google-oauth2" - const signupParams = { - connection : socialConnection[0].name, // "google-oauth2" - }; - - signupIdManager.federatedSignup(signupParams); -``` - -```typescript signupId Example -import React, { useState, useEffect } from 'react'; -import SignupId from '@auth0/auth0-acul-js/signup-id'; -import { Logo } from '../../components/Logo'; -import Button from '../../components/Button'; - -const SignupIdScreen: React.FC = () => { - const [email, setEmail] = useState(''); - const [phone, setPhone] = useState(''); - const [username, setUsername] = useState(''); - const [error, setError] = useState(''); - const [success, setSuccess] = useState(false); - const [identifiers, setIdentifiers] = useState<Array<{ type: string; required: boolean }>>([]); - - const signupIdManager = new SignupId(); - - const title = signupIdManager.screen.texts?.title || ''; - const description = signupIdManager.screen.texts?.description || ''; - const federatedConnections = signupIdManager.transaction.alternateConnections ?? []; - const links = signupIdManager.screen.links ?? {}; - - const { isValid, errors } = signupIdManager.validateUsername(username); - - - useEffect(() => { - const enabledIds = signupIdManager.getSignupIdentifiers(); - setIdentifiers(enabledIds ?? []); - }, []); - - const handleSignup = async (e: React.FormEvent) => { - e.preventDefault(); - setError(''); - setSuccess(false); - - const emailRequired = identifiers.find((id) => id.type === 'email')?.required; - const phoneRequired = identifiers.find((id) => id.type === 'phone')?.required; - const usernameRequired = identifiers.find((id) => id.type === 'username')?.required; - - if (emailRequired && !email) { - setError('Email is required.'); - return; - } - if (phoneRequired && !phone) { - setError('Phone number is required.'); - return; - } - if (usernameRequired && !username) { - setError('Username is required.'); - return; - } - - if(!isValid){ - setError(errors[0].message); - return; - } - - try { - await signupIdManager.signup({ - email, - phone, - username, - }); - setSuccess(true); - } catch { - setError('Signup failed. Please try again later.'); - } - }; - - const handleFederatedSignup = (connectionName: string) => { - signupIdManager.federatedSignup({ connection: connectionName }); - }; - - return ( - <div className="prompt-container"> - <Logo /> - {/* Title Section */} - <div className="title-container"> - <h1 className="mt-6 text-center text-3xl font-extrabold text-gray-900">{title}</h1> - <div> - <p className="mt-2 text-center text-sm text-gray-600">{description}</p> - </div> - </div> - - {/* Form Section */} - <div className="input-container"> - <form onSubmit={handleSignup}> - {/* Email */} - {identifiers.find((id) => id.type === 'email') && ( - <div> - <label>Email {identifiers.find((id) => id.type === 'email')?.required && '*'}</label> - <input - type="email" - id="email" - placeholder="Enter your email" - value={email} - onChange={(e) => setEmail(e.target.value)} - className="input-field" - /> - </div> - )} - - {/* Phone */} - {identifiers.find((id) => id.type === 'phone') && ( - <div> - <label>Phone {identifiers.find((id) => id.type === 'phone')?.required && '*'}</label> - <input - type="tel" - id="phone" - placeholder="Enter your phone number" - value={phone} - onChange={(e) => setPhone(e.target.value)} - className="input-field" - /> - </div> - )} - - {/* Username */} - {identifiers.find((id) => id.type === 'username') && ( - <div> - <label>Username {identifiers.find((id) => id.type === 'username')?.required && '*'}</label> - <input - type="text" - id="username" - placeholder="Enter your username" - value={username} - onChange={(e) => setUsername(e.target.value)} - className={`input-field ${username && !isValid ? 'border-red-500' : 'border-gray-300' - }`} - /> - - {username.length > 0 && errors.length > 0 && ( - <ul className="mt-1 text-sm text-red-500"> - {errors.map((err, i) => ( - <li key={i}>{err.message}</li> - ))} - </ul> - )} - </div> - )} - - {/* Error & Success Messages */} - {error && ( - <div className="error-container"> - <p>{error}</p> - </div> - )} - {success && ( - <div className="success-message"> - Signup successful! Please check your email to verify your account. - </div> - )} - - {/* Submit Button */} - <div className="button-container"> - <Button onClick={() => handleSignup}> - Sign Up - </Button> - </div> - </form> - - {/* Login Link */} - {links?.login && ( - <div className="mt-6 text-center text-sm"> - <span> - Already have an account? - </span> - <a - href={links.loginLink} - className="text-indigo-600 hover:underline" - > - Log in - </a> - </div> - )} - {/* OR separator */} - <div className="flex items-center my-4"> - <div className="flex-1 border-t border-gray-300"></div> - <span className="px-3 text-sm text-gray-400">OR</span> - <div className="flex-1 border-t border-gray-300"></div> - </div> - - {/* Google login */} - {federatedConnections.length > 0 && federatedConnections.map((conn: any) => ( - <button - key={conn.name} - onClick={() => handleFederatedSignup(conn.name)} - className="w-full flex items-center justify-center gap-2 rounded-md border border-gray-300 bg-white px-4 py-2 text-sm font-medium text-gray-700 hover:bg-gray-50" - > - {/* <img src="/google-icon.svg" alt="" className="h-4 w-4" /> */} - Continue with {conn.options?.display_name || conn.name} - </button> - ))} - - </div> - </div> - ); -}; - -export default SignupIdScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext">ExtendedScreenContext</a></span>} required> -</ParamField> - -<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext">ExtendedUntrustedDataContext</a></span>}> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/signup-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupIdMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupIdMembers.mdx deleted file mode 100644 index acba2f1b8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupIdMembers.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "SignupIdMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface SignupIdMembers extends BaseMembers { - screen: ScreenMembersOnSignupId; - transaction: TransactionMembersOnSignupId; - signup(payload: SignupOptions): Promise<void>; - federatedSignup(payload: FederatedSignupOptions): Promise<void>; - getSignupIdentifiers(): Identifier[] | null; - pickCountryCode(payload?: CustomOptions): Promise<void>; - validateUsername(username: string): UsernameValidationResult; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupId">ScreenMembersOnSignupId</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a></span>} required> -</ParamField> - -<ParamField path="signup" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="federatedSignup" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="getSignupIdentifiers" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier">Identifier[]</a> | null</span>}> -</ParamField> - -<ParamField path="pickCountryCode" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="validateUsername" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/signup-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupMembers.mdx deleted file mode 100644 index dffde6731..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupMembers.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: "SignupMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface SignupMembers extends BaseMembers { - screen: ScreenMembersOnSignup; - transaction: TransactionMembersOnSignup; - signup(payload: SignupOptions): Promise<void>; - federatedSignup(payload: FederatedSignupOptions): Promise<void>; - pickCountryCode(payload?: CustomOptions): Promise<void>; - validatePassword(password: string): PasswordValidationResult; - /** - * Returns a list of enabled identifiers (e.g. email, phone, username) - * based on the current transaction state. - * - * Identifiers may be required or optional depending on the connection strategy - * and configuration provided during the authentication or signup flow. - * - * @returns An array of enabled {@link Identifier} objects, or `null` if the transaction is not initialized. - * - * @example - * ```ts - * const identifiers = authClient.getSignupIdentifiers(); - * if (identifiers) { - * identifiers.forEach(({ type, required }) => { - * console.log(`${type} is ${required ? 'required' : 'optional'}`); - * }); - * } - * ``` - * @utilityFeature - * @see Identifier - */ - getSignupIdentifiers(): Identifier[] | null; - validateUsername(username: string): UsernameValidationResult; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignup">ScreenMembersOnSignup</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignup">TransactionMembersOnSignup</a></span>} required> -</ParamField> - -<ParamField path="signup" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="federatedSignup" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="pickCountryCode" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="validatePassword" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>} required> -</ParamField> - -<ParamField path="getSignupIdentifiers" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier">Identifier[]</a> | null</span>}> - Returns a list of enabled identifiers (e.g. email, phone, username) based on the current transaction state. Identifiers may be required or optional depending on the connection strategy and configuration provided during the authentication or signup flow. -</ParamField> - -<ParamField path="validateUsername" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/signup.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions.mdx deleted file mode 100644 index 864f45efb..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "SignupOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface SignupOptions { - email?: string; - username?: string; - phoneNumber?: string; - password?: string; - captcha?: string; - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="email" type={<span>string</span>}> -</ParamField> - -<ParamField path="username" type={<span>string</span>}> -</ParamField> - -<ParamField path="phoneNumber" type={<span>string</span>}> -</ParamField> - -<ParamField path="password" type={<span>string</span>}> -</ParamField> - -<ParamField path="captcha" type={<span>string</span>}> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/signup.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPassword.mdx deleted file mode 100644 index 2994aa6b2..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPassword.mdx +++ /dev/null @@ -1,238 +0,0 @@ ---- -title: "SignupPassword" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface SignupPassword extends BaseContext { - screen: ScreenContextOnSignupPassword; -} -``` - -```typescript signup -import SignupPassword from "@auth0/auth0-acul-js/signup-password"; - - const signupPasswordManager = new SignupPassword(); - const { transaction, screen } = signupPasswordManager; - - //get mandatory & optional identifiers required for signup-password screen to proceed - const mandatoryIdentifier = transaction.getRequiredIdentifiers(); //eg: email - const optionalIdentifiers = transaction.getOptionalIdentifiers() //eg: phone - - //get signup data submitted on previous screen from previous screen - const data = screen.data; //eg: email, phone - - - const signupParams = { - email : data.email, - phone : data.phone_number, - password : "********" - }; - - signupPasswordManager.signup(signupParams); -``` - -```typescript signupPassword Example using validatePassword -import React, { useState } from 'react'; -import SignupPassword from '@auth0/auth0-acul-js/signup-password'; -import { Logo } from '../../components/Logo'; -import Button from '../../components/Button'; - -const SignupPasswordScreen: React.FC = () => { - const [password, setPassword] = useState(''); - const [error, setError] = useState(''); - const [success, setSuccess] = useState(false); - - const signupPasswordManager = new SignupPassword(); - - const email = signupPasswordManager.screen.data?.email || ''; - const phone = signupPasswordManager.screen.data?.phoneNumber || ''; - const username = signupPasswordManager.screen.data?.username || ''; - - const title = signupPasswordManager.screen.texts?.title || ''; - const description = signupPasswordManager.screen.texts?.description || ''; - - const { isValid, results } = signupPasswordManager.validatePassword(password); - - const handleSignup = async (e: React.FormEvent) => { - e.preventDefault(); - setError(''); - setSuccess(false); - - if (!email || !password) { - setError('Email and password are required.'); - return; - } - - if (!isValid) return; - - try { - await signupPasswordManager.signup({ email, username, phone, password }); - setSuccess(true); - } catch { - setError('Signup failed. Please try again later.'); - } - }; - - return ( - <div className="prompt-container"> - <Logo /> - - {/* Title Section (inline, not imported) */} - <div className="title-container"> - <h1 className="mt-6 text-center text-3xl font-extrabold text-gray-900">{title}</h1> - <div> - <p className="mt-2 text-center text-sm text-gray-600">{description}</p> - </div> - </div> - - {/* Form */} - <div className="input-container"> - <form onSubmit={handleSignup}> - {email && ( - <div> - <label>Email</label> - <input - type="email" - id="email" - placeholder="Enter your email" - value={email} - disabled - /> - </div> - )} - - - {username && ( - <div> - <label>Username</label> - <input - type="text" - id="username" - placeholder="Enter your username" - value={username} - disabled - /> - </div> - )} - - { - phone && ( - <div> - <label>Phone</label> - <input - type="tel" - id="phone" - placeholder="Enter your phone number" - value={phone} - disabled - /> - </div> - ) - } - - - - <label>Password</label> - <input - type="password" - id="password" - placeholder="Enter your password" - value={password} - onChange={(e) => setPassword(e.target.value)} - className={!isValid && password.length > 0 ? 'error' : ''} - /> - - {/* Password Validation Rules */} - - {password.length > 0 && results.length > 0 && ( - <div className="mt-2 border border-gray-300 rounded p-2 text-sm"> - <p className="text-gray-700 mb-1">Your password must contain:</p> - <ul className="list-disc ml-4"> - {results.map((rule) => ( - <li - key={rule.code} - className={rule.status === 'valid' ? 'text-green-600' : 'text-gray-700'} - > - {rule.label} - {rule.items && rule.items.length > 0 && ( - <ul className="ml-5 list-disc"> - {rule.items.map((sub) => ( - <li - key={sub.code} - className={sub.status === 'valid' ? 'text-green-600' : 'text-gray-700'} - > - {sub.label} - </li> - ))} - </ul> - )} - </li> - ))} - </ul> - </div> - )} - {/* Error & Success messages */} - {error && ( - <div className="error-container"> - <p>{error}</p> - </div> - )} - - {success && ( - <div className="success-message"> - Signup successful! Please check your email to verify your account. - </div> - )} - - {/* Submit Button */} - <div className="button-container"> - <Button onClick={() => handleSignup}> - Sign Up - </Button> - </div> - </form> - </div> - </div> - ); -}; - -export default SignupPasswordScreen; -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnSignupPassword">ScreenContextOnSignupPassword</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext">BrandingContext</a></span>}> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext">ClientContext</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext">PromptContext</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext">TenantContext</a></span>}> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext">TransactionContext</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext">UserContext</a></span>} required> -</ParamField> - -<ParamField path="untrusted_data" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext">UntrustedDataContext</a></span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/signup-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordMembers.mdx deleted file mode 100644 index f33e08cf3..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordMembers.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "SignupPasswordMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface SignupPasswordMembers extends BaseMembers { - screen: ScreenMembersOnSignupPassword; - transaction: TransactionMembersOnSignupPassword; - signup(payload: SignupPasswordOptions): Promise<void>; - federatedSignup(payload: FederatedSignupOptions): Promise<void>; - validatePassword(password: string): PasswordValidationResult; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="screen" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupPassword">ScreenMembersOnSignupPassword</a></span>} required> -</ParamField> - -<ParamField path="transaction" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupPassword">TransactionMembersOnSignupPassword</a></span>} required> -</ParamField> - -<ParamField path="signup" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="federatedSignup" type={<span>Promise<void></span>} required> -</ParamField> - -<ParamField path="validatePassword" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>} required> -</ParamField> - -<ParamField path="branding" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers">BrandingMembers</a></span>} required> -</ParamField> - -<ParamField path="client" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers">ClientMembers</a></span>} required> -</ParamField> - -<ParamField path="organization" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers">OrganizationMembers</a></span>} required> -</ParamField> - -<ParamField path="prompt" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers">PromptMembers</a></span>} required> -</ParamField> - -<ParamField path="tenant" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers">TenantMembers</a></span>} required> -</ParamField> - -<ParamField path="user" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers">UserMembers</a></span>} required> -</ParamField> - -<ParamField path="untrustedData" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/signup-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordOptions.mdx deleted file mode 100644 index 38f3bf2f5..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordOptions.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "SignupPasswordOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface SignupPasswordOptions { - email?: string; - username?: string; - phoneNumber?: string; - password: string; - captcha?: string; - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="email" type={<span>string</span>}> -</ParamField> - -<ParamField path="username" type={<span>string</span>}> -</ParamField> - -<ParamField path="phoneNumber" type={<span>string</span>}> -</ParamField> - -<ParamField path="password" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captcha" type={<span>string</span>}> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/signup-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SocialConnection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SocialConnection.mdx deleted file mode 100644 index 1844b2495..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SocialConnection.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "SocialConnection" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface SocialConnection extends Connection {} -``` - -</RequestExample> - -## Properties - -<ParamField path="name" type={<span>string</span>} required> -</ParamField> - -<ParamField path="strategy" type={<span>string</span>} required> -</ParamField> - -<ParamField path="metadata" type={<span>Record<string, string></span>}> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions.mdx deleted file mode 100644 index 714e28cc8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "StartResendOptions" -description: "Options for configuring resend functionality" ---- - -<RequestExample> - -```typescript Interface lines -export interface StartResendOptions { - timeoutSeconds?: number; - onStatusChange?: OnStatusChangeCallback; - onTimeout?: () => void; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="timeoutSeconds" type={<span>number</span>}> -</ParamField> - -<ParamField path="onStatusChange" type={<span>OnStatusChangeCallback</span>}> -</ParamField> - -<ParamField path="onTimeout" type={<span>() => void</span>}> -</ParamField> - ---- - -**File:** [interfaces/utils/resend-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/resend-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCaptchaOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCaptchaOptions.mdx deleted file mode 100644 index 292edebd0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCaptchaOptions.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "SubmitCaptchaOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface SubmitCaptchaOptions { - captcha: string; - [key: string]: string | number; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="captcha" type={<span>string</span>} required> -</ParamField> - -<ParamField path="unknown" type={<span>string | number</span>} required> -</ParamField> - ---- - -**File:** [interfaces/screens/interstitial-captcha.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCodeOptions.mdx deleted file mode 100644 index 73941ea2c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCodeOptions.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "SubmitCodeOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface SubmitCodeOptions { - code: string | number; - captcha?: string; - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="code" type={<span>string | number</span>} required> -</ParamField> - -<ParamField path="captcha" type={<span>string</span>}> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-passwordless-email-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitOTPOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitOTPOptions.mdx deleted file mode 100644 index d4dcca7d6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitOTPOptions.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "SubmitOTPOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface SubmitOTPOptions { - username?: string; - code: string; - captcha?: string; - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="username" type={<span>string</span>}> -</ParamField> - -<ParamField path="code" type={<span>string</span>} required> -</ParamField> - -<ParamField path="captcha" type={<span>string</span>}> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-passwordless-sms-otp.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitPasskeyCredentialOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitPasskeyCredentialOptions.mdx deleted file mode 100644 index 652c9269c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitPasskeyCredentialOptions.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "SubmitPasskeyCredentialOptions" -description: "@interface SubmitPasskeyCredentialOptions" ---- - -<RequestExample> - -```typescript Interface lines -export interface SubmitPasskeyCredentialOptions extends CustomOptions { - // No longer requires publicKey here, as it's sourced from this.screen.publicKey -} -``` - -</RequestExample> - -## Properties - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-platform-enrollment.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext.mdx deleted file mode 100644 index cec85e231..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "TenantContext" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface TenantContext { - name?: string; - friendly_name?: string; - enabled_locales?: string[]; - enabled_factors?: string[]; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="name" type={<span>string</span>}> -</ParamField> - -<ParamField path="friendly_name" type={<span>string</span>}> -</ParamField> - -<ParamField path="enabled_locales" type={<span>string[]</span>}> -</ParamField> - -<ParamField path="enabled_factors" type={<span>string[]</span>}> -</ParamField> - ---- - -**File:** [interfaces/models/tenant.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/tenant.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers.mdx deleted file mode 100644 index 875344247..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "TenantMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface TenantMembers { - name: string | null; - friendlyName: string | null; - enabledLocales: string[] | null; - enabledFactors: string[] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="name" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="friendlyName" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="enabledLocales" type={<span>string[] | null</span>}> -</ParamField> - -<ParamField path="enabledFactors" type={<span>string[] | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/models/tenant.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/tenant.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext.mdx deleted file mode 100644 index 1d1d420a3..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "TransactionContext" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface TransactionContext { - state: string; - locale: string; - errors?: Error[]; - country_code?: CountryCode; - connection?: DBConnection | PasswordlessConnection; - alternate_connections?: (Connection | EnterpriseConnectionContext)[]; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="locale" type={<span>string</span>} required> -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a></span>}> -</ParamField> - -<ParamField path="country_code" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a></span>}> -</ParamField> - -<ParamField path="connection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection">DBConnection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordlessConnection">PasswordlessConnection</a></span>}> -</ParamField> - -<ParamField path="alternate_connections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext">EnterpriseConnectionContext</a>)[]</span>}> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLogin.mdx deleted file mode 100644 index abfae3170..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLogin.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "TransactionContextOnLogin" -description: "Extended transaction context interface for the login screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface TransactionContextOnLogin extends TransactionContext { - connection: DBConnection; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="connection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection">DBConnection</a></span>} required> -</ParamField> - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="locale" type={<span>string</span>} required> -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a></span>}> -</ParamField> - -<ParamField path="country_code" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a></span>}> -</ParamField> - -<ParamField path="alternate_connections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext">EnterpriseConnectionContext</a>)[]</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLoginPassword.mdx deleted file mode 100644 index 5cf12422d..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLoginPassword.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "TransactionContextOnLoginPassword" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface TransactionContextOnLoginPassword extends TransactionContext { - connection: DBConnection; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="connection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection">DBConnection</a></span>} required> -</ParamField> - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="locale" type={<span>string</span>} required> -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a></span>}> -</ParamField> - -<ParamField path="country_code" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a></span>}> -</ParamField> - -<ParamField path="alternate_connections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext">EnterpriseConnectionContext</a>)[]</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers.mdx deleted file mode 100644 index 967868051..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "TransactionMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface TransactionMembers { - state: string; - locale: string; - countryCode: CountryCode['code'] | null; - countryPrefix: CountryCode['prefix'] | null; - connectionStrategy: string | null; - hasErrors: boolean; - errors: Error[] | null; - currentConnection: Connection | null; - alternateConnections: (Connection | EnterpriseConnection)[] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="locale" type={<span>string</span>} required> -</ParamField> - -<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> -</ParamField> - -<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> -</ParamField> - -<ParamField path="connectionStrategy" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="hasErrors" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> -</ParamField> - -<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> -</ParamField> - -<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLogin.mdx deleted file mode 100644 index c37c12eec..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLogin.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "TransactionMembersOnLogin" -description: "Extended transaction members interface for the login screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface TransactionMembersOnLogin extends TransactionMembers { - isSignupEnabled: boolean; - isForgotPasswordEnabled: boolean; - isPasskeyEnabled: boolean; - passwordPolicy: PasswordPolicy | null; - allowedIdentifiers: IdentifierType[] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="isSignupEnabled" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="isForgotPasswordEnabled" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="isPasskeyEnabled" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="passwordPolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy">PasswordPolicy</a> | null</span>}> -</ParamField> - -<ParamField path="allowedIdentifiers" type={<span>IdentifierType[] | null</span>}> -</ParamField> - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="locale" type={<span>string</span>} required> -</ParamField> - -<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> -</ParamField> - -<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> -</ParamField> - -<ParamField path="connectionStrategy" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="hasErrors" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> -</ParamField> - -<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> -</ParamField> - -<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId.mdx deleted file mode 100644 index aad8b7373..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "TransactionMembersOnLoginId" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface TransactionMembersOnLoginId extends TransactionMembers { - isSignupEnabled: boolean; - isPasskeyEnabled: boolean; - isForgotPasswordEnabled: boolean; - isUsernameRequired: boolean; - usernamePolicy: UsernamePolicy | null; - allowedIdentifiers: IdentifierType[] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="isSignupEnabled" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="isPasskeyEnabled" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="isForgotPasswordEnabled" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="isUsernameRequired" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="usernamePolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy">UsernamePolicy</a> | null</span>}> -</ParamField> - -<ParamField path="allowedIdentifiers" type={<span>IdentifierType[] | null</span>}> -</ParamField> - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="locale" type={<span>string</span>} required> -</ParamField> - -<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> -</ParamField> - -<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> -</ParamField> - -<ParamField path="connectionStrategy" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="hasErrors" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> -</ParamField> - -<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> -</ParamField> - -<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPassword.mdx deleted file mode 100644 index 604b043d3..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPassword.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "TransactionMembersOnLoginPassword" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface TransactionMembersOnLoginPassword extends TransactionMembers { - isSignupEnabled: boolean; - isForgotPasswordEnabled: boolean; - isPasskeyEnabled: boolean; - getPasswordPolicy(): PasswordPolicy | null; - getUsernamePolicy(): UsernamePolicy | null; - getAllowedIdentifiers(): IdentifierType[] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="isSignupEnabled" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="isForgotPasswordEnabled" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="isPasskeyEnabled" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="getPasswordPolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy">PasswordPolicy</a> | null</span>}> -</ParamField> - -<ParamField path="getUsernamePolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy">UsernamePolicy</a> | null</span>}> -</ParamField> - -<ParamField path="getAllowedIdentifiers" type={<span>IdentifierType[] | null</span>}> -</ParamField> - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="locale" type={<span>string</span>} required> -</ParamField> - -<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> -</ParamField> - -<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> -</ParamField> - -<ParamField path="connectionStrategy" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="hasErrors" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> -</ParamField> - -<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> -</ParamField> - -<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx deleted file mode 100644 index cb74cb595..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "TransactionMembersOnLoginPasswordlessEmailCode" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface TransactionMembersOnLoginPasswordlessEmailCode extends TransactionMembers { - isSignupEnabled: boolean | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="isSignupEnabled" type={<span>boolean | null</span>}> -</ParamField> - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="locale" type={<span>string</span>} required> -</ParamField> - -<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> -</ParamField> - -<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> -</ParamField> - -<ParamField path="connectionStrategy" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="hasErrors" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> -</ParamField> - -<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> -</ParamField> - -<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-passwordless-email-code.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx deleted file mode 100644 index 37b6b472b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "TransactionMembersOnLoginPasswordlessSmsOtp" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface TransactionMembersOnLoginPasswordlessSmsOtp extends TransactionMembers { - isSignupEnabled: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="isSignupEnabled" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="locale" type={<span>string</span>} required> -</ParamField> - -<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> -</ParamField> - -<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> -</ParamField> - -<ParamField path="connectionStrategy" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="hasErrors" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> -</ParamField> - -<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> -</ParamField> - -<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/login-passwordless-sms-otp.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPassword.mdx deleted file mode 100644 index 071bf61ea..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPassword.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "TransactionMembersOnResetPassword" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface TransactionMembersOnResetPassword extends TransactionMembers { - passwordPolicy: PasswordPolicy | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="passwordPolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy">PasswordPolicy</a> | null</span>}> -</ParamField> - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="locale" type={<span>string</span>} required> -</ParamField> - -<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> -</ParamField> - -<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> -</ParamField> - -<ParamField path="connectionStrategy" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="hasErrors" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> -</ParamField> - -<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> -</ParamField> - -<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPasswordRequest.mdx deleted file mode 100644 index ce6f2afe0..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPasswordRequest.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "TransactionMembersOnResetPasswordRequest" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface TransactionMembersOnResetPasswordRequest extends TransactionMembers { - allowedIdentifiers: IdentifierType[] | null; - requiredIdentifiers: IdentifierType[] | null; - hasFlexibleIdentifier: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="allowedIdentifiers" type={<span>IdentifierType[] | null</span>}> -</ParamField> - -<ParamField path="requiredIdentifiers" type={<span>IdentifierType[] | null</span>}> -</ParamField> - -<ParamField path="hasFlexibleIdentifier" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="locale" type={<span>string</span>} required> -</ParamField> - -<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> -</ParamField> - -<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> -</ParamField> - -<ParamField path="connectionStrategy" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="hasErrors" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> -</ParamField> - -<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> -</ParamField> - -<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-request.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignup.mdx deleted file mode 100644 index e41aaa212..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignup.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "TransactionMembersOnSignup" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface TransactionMembersOnSignup extends TransactionMembers { - isPasskeyEnabled: boolean; - usernamePolicy: UsernamePolicy | null; - requiredIdentifiers: IdentifierType[] | null; - optionalIdentifiers: IdentifierType[] | null; - passwordPolicy: PasswordPolicy | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="isPasskeyEnabled" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="usernamePolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy">UsernamePolicy</a> | null</span>}> -</ParamField> - -<ParamField path="requiredIdentifiers" type={<span>IdentifierType[] | null</span>}> -</ParamField> - -<ParamField path="optionalIdentifiers" type={<span>IdentifierType[] | null</span>}> -</ParamField> - -<ParamField path="passwordPolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy">PasswordPolicy</a> | null</span>}> -</ParamField> - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="locale" type={<span>string</span>} required> -</ParamField> - -<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> -</ParamField> - -<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> -</ParamField> - -<ParamField path="connectionStrategy" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="hasErrors" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> -</ParamField> - -<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> -</ParamField> - -<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/signup.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId.mdx deleted file mode 100644 index 2ec54456c..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "TransactionMembersOnSignupId" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface TransactionMembersOnSignupId extends TransactionMembers { - isPasskeyEnabled: boolean; - usernamePolicy: UsernamePolicy | null; - requiredIdentifiers: IdentifierType[] | null; - optionalIdentifiers: IdentifierType[] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="isPasskeyEnabled" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="usernamePolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy">UsernamePolicy</a> | null</span>}> -</ParamField> - -<ParamField path="requiredIdentifiers" type={<span>IdentifierType[] | null</span>}> -</ParamField> - -<ParamField path="optionalIdentifiers" type={<span>IdentifierType[] | null</span>}> -</ParamField> - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="locale" type={<span>string</span>} required> -</ParamField> - -<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> -</ParamField> - -<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> -</ParamField> - -<ParamField path="connectionStrategy" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="hasErrors" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> -</ParamField> - -<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> -</ParamField> - -<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/signup-id.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-id.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupPassword.mdx deleted file mode 100644 index c38579e60..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupPassword.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "TransactionMembersOnSignupPassword" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface TransactionMembersOnSignupPassword extends TransactionMembers { - isPasskeyEnabled: boolean; - passwordPolicy: PasswordPolicy | null; - requiredIdentifiers: IdentifierType[] | null; - optionalIdentifiers: IdentifierType[] | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="isPasskeyEnabled" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="passwordPolicy" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy">PasswordPolicy</a> | null</span>}> -</ParamField> - -<ParamField path="requiredIdentifiers" type={<span>IdentifierType[] | null</span>}> -</ParamField> - -<ParamField path="optionalIdentifiers" type={<span>IdentifierType[] | null</span>}> -</ParamField> - -<ParamField path="state" type={<span>string</span>} required> -</ParamField> - -<ParamField path="locale" type={<span>string</span>} required> -</ParamField> - -<ParamField path="countryCode" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['code'] | null</span>}> -</ParamField> - -<ParamField path="countryPrefix" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode">CountryCode</a>['prefix'] | null</span>}> -</ParamField> - -<ParamField path="connectionStrategy" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="hasErrors" type={<span>boolean</span>} required> -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error">Error[]</a> | null</span>}> -</ParamField> - -<ParamField path="currentConnection" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | null</span>}> -</ParamField> - -<ParamField path="alternateConnections" type={<span>(<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection">Connection</a> | <a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection">EnterpriseConnection</a>)[] | null</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/signup-password.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/signup-password.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions.mdx deleted file mode 100644 index 2685ad104..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "TryAnotherMethodOptions" -description: "@interface TryAnotherMethodOptions" ---- - -<RequestExample> - -```typescript Interface lines -export interface TryAnotherMethodOptions extends CustomOptions { - /** - * Optional. If `true`, and if the screen context (`screen.showRememberDevice`) - * indicates that remembering the device is an option, this signals the user's - * intent to remember this browser/device. - * @type {boolean | undefined} - */ - rememberDevice?: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="rememberDevice" type={<span>boolean</span>}> - Optional. If `true`, and if the screen context (`screen.showRememberDevice`) indicates that remembering the device is an option, this signals the user's intent to remember this browser/device. -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext.mdx deleted file mode 100644 index 70625574b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "UntrustedDataContext" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface UntrustedDataContext { - submitted_form_data?: { - [key: string]: string | undefined | boolean | null; - [key: `ulp_${string}`]: string | undefined; - }; - authorization_params?: { - login_hint?: string; - screen_hint?: string; - ui_locales?: string; - [key: `ext-${string}`]: string; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="submitted_form_data" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="authorization_params" type="object"> - <Expandable title="properties"> - <ParamField path="login_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="screen_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="ui_locales" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/models/untrusted-data.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/untrusted-data.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers.mdx deleted file mode 100644 index 1f0d34c93..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "UntrustedDataMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface UntrustedDataMembers { - submittedFormData: { [key: string]: string | number | boolean | undefined | null } | null; - authorizationParams: { - login_hint?: string; - screen_hint?: string; - ui_locales?: string; - [key: `ext-${string}`]: string; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="submittedFormData" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="authorizationParams" type="object"> - <Expandable title="properties"> - <ParamField path="login_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="screen_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="ui_locales" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/models/untrusted-data.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/untrusted-data.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx deleted file mode 100644 index c4cbafd8a..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "UntrustedDataMembersOnMfaEmailChallenge" -description: "Interface for untrusted data specific to mfa-email-challenge screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface UntrustedDataMembersOnMfaEmailChallenge extends UntrustedDataMembers { - submittedFormData: { - rememberDevice: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="submittedFormData" type="object"> - <Expandable title="properties"> - <ParamField path="rememberDevice" type={<span>boolean</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="authorizationParams" type="object"> - <Expandable title="properties"> - <ParamField path="login_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="screen_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="ui_locales" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-email-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx deleted file mode 100644 index cbe8cb89e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "UntrustedDataMembersOnMfaOtpChallenge" -description: "Interface for untrusted data specific to mfa-otp-challenge screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface UntrustedDataMembersOnMfaOtpChallenge extends UntrustedDataMembers { - submittedFormData: { - rememberDevice: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="submittedFormData" type="object"> - <Expandable title="properties"> - <ParamField path="rememberDevice" type={<span>boolean</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="authorizationParams" type="object"> - <Expandable title="properties"> - <ParamField path="login_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="screen_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="ui_locales" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-otp-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx deleted file mode 100644 index 3a5c8c2bc..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "UntrustedDataMembersOnMfaPushChallengePush" -description: "Interface for untrusted data specific to mfa-push-challenge-push screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface UntrustedDataMembersOnMfaPushChallengePush - extends UntrustedDataMembers { - submittedFormData: { - rememberDevice: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="submittedFormData" type="object"> - <Expandable title="properties"> - <ParamField path="rememberDevice" type={<span>boolean</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="authorizationParams" type="object"> - <Expandable title="properties"> - <ParamField path="login_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="screen_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="ui_locales" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-push-challenge-push.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx deleted file mode 100644 index 21f509acf..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "UntrustedDataMembersOnMfaSmsChallenge" -description: "Interface for untrusted data specific to mfa-sms-challenge screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface UntrustedDataMembersOnMfaSmsChallenge extends UntrustedDataMembers { - submittedFormData: { - rememberDevice: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="submittedFormData" type="object"> - <Expandable title="properties"> - <ParamField path="rememberDevice" type={<span>boolean</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="authorizationParams" type="object"> - <Expandable title="properties"> - <ParamField path="login_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="screen_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="ui_locales" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-sms-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx deleted file mode 100644 index a17b96f43..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "UntrustedDataMembersOnMfaVoiceChallenge" -description: "Interface for untrusted data specific to mfa-voice-challenge screen" ---- - -<RequestExample> - -```typescript Interface lines -export interface UntrustedDataMembersOnMfaVoiceChallenge extends UntrustedDataMembers { - submittedFormData: { - rememberDevice: boolean; - } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="submittedFormData" type="object"> - <Expandable title="properties"> - <ParamField path="rememberDevice" type={<span>boolean</span>} required> - </ParamField> - </Expandable> -</ParamField> - -<ParamField path="authorizationParams" type="object"> - <Expandable title="properties"> - <ParamField path="login_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="screen_hint" type={<span>string</span>}> - </ParamField> - <ParamField path="ui_locales" type={<span>string</span>}> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-voice-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UseSecurityKeyOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UseSecurityKeyOptions.mdx deleted file mode 100644 index 33c1a1e9b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UseSecurityKeyOptions.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "UseSecurityKeyOptions" -description: "@interface UseSecurityKeyOptions" ---- - -<RequestExample> - -```typescript Interface lines -export interface UseSecurityKeyOptions extends CustomOptions { - /** - * Optional. If `true`, and if the screen context (`screen.showRememberDevice`) - * indicates that remembering the device is an option, this signals the user's - * intent to remember this browser/device for future authentications. - * The SDK will submit `rememberBrowser=true` in this case. - * @type {boolean | undefined} - */ - rememberDevice?: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="rememberDevice" type={<span>boolean</span>}> - Optional. If `true`, and if the screen context (`screen.showRememberDevice`) indicates that remembering the device is an option, this signals the user's intent to remember this browser/device for future authentications. The SDK will submit `rememberBrowser=true` in this case. -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext.mdx deleted file mode 100644 index cd19daf89..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "UserContext" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface UserContext { - id: string; - email?: string; - username?: string; - phone_number?: string; - picture?: string; - enrolled_factors?: string[]; - enrolled_emails?: EnrolledEmail[]; - enrolled_phone_numbers?: EnrolledPhoneNumber[]; - enrolled_devices?: EnrolledDevice[]; - organizations?: OrganizationContext[]; - user_metadata?: Record<string, string>; - app_metadata?: Record<string, string>; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="id" type={<span>string</span>} required> -</ParamField> - -<ParamField path="email" type={<span>string</span>}> -</ParamField> - -<ParamField path="username" type={<span>string</span>}> -</ParamField> - -<ParamField path="phone_number" type={<span>string</span>}> -</ParamField> - -<ParamField path="picture" type={<span>string</span>}> -</ParamField> - -<ParamField path="enrolled_factors" type={<span>string[]</span>}> -</ParamField> - -<ParamField path="enrolled_emails" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail">EnrolledEmail[]</a></span>}> -</ParamField> - -<ParamField path="enrolled_phone_numbers" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber">EnrolledPhoneNumber[]</a></span>}> -</ParamField> - -<ParamField path="enrolled_devices" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice">EnrolledDevice[]</a></span>}> -</ParamField> - -<ParamField path="organizations" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext">OrganizationContext[]</a></span>}> -</ParamField> - -<ParamField path="user_metadata" type={<span>Record<string, string></span>}> -</ParamField> - -<ParamField path="app_metadata" type={<span>Record<string, string></span>}> -</ParamField> - ---- - -**File:** [interfaces/models/user.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/user.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers.mdx deleted file mode 100644 index d50745585..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "UserMembers" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface UserMembers { - id: string | null; - email: string | null; - username: string | null; - phoneNumber: string | null; - picture: string | null; - enrolledFactors: Array<string> | null; - enrolledEmails: Array<EnrolledEmail> | null; - enrolledPhoneNumbers: Array<EnrolledPhoneNumber> | null; - enrolledDevices: Array<EnrolledDevice> | null; - organizations: Organizations[] | null; - userMetadata: { [key: string]: string } | null; - appMetadata: { [key: string]: string } | null; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="id" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="email" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="username" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="phoneNumber" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="picture" type={<span>string | null</span>}> -</ParamField> - -<ParamField path="enrolledFactors" type={<span>Array<string> | null</span>}> -</ParamField> - -<ParamField path="enrolledEmails" type={<span>Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail">EnrolledEmail</a>> | null</span>}> -</ParamField> - -<ParamField path="enrolledPhoneNumbers" type={<span>Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber">EnrolledPhoneNumber</a>> | null</span>}> -</ParamField> - -<ParamField path="enrolledDevices" type={<span>Array<<a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice">EnrolledDevice</a>> | null</span>}> -</ParamField> - -<ParamField path="organizations" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Organizations">Organizations[]</a> | null</span>}> -</ParamField> - -<ParamField path="userMetadata" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - -<ParamField path="appMetadata" type="object"> - <Expandable title="properties"> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/models/user.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/user.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy.mdx deleted file mode 100644 index a9374cc10..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "UsernamePolicy" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface UsernamePolicy { - isActive?: boolean - maxLength: number; - minLength: number; - allowedFormats?: { - usernameInEmailFormat?: boolean; - usernameInPhoneFormat?: boolean; - }; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="isActive" type={<span>boolean</span>}> -</ParamField> - -<ParamField path="maxLength" type={<span>number</span>} required> -</ParamField> - -<ParamField path="minLength" type={<span>number</span>} required> -</ParamField> - -<ParamField path="allowedFormats" type="object"> - <Expandable title="properties"> - <ParamField path="usernameInEmailFormat" type={<span>boolean</span>}> - </ParamField> - <ParamField path="usernameInPhoneFormat" type={<span>boolean</span>}> - </ParamField> - </Expandable> -</ParamField> - ---- - -**File:** [interfaces/models/transaction.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/transaction.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationError.mdx deleted file mode 100644 index 1e8b8e312..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationError.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "UsernameValidationError" -description: "Represents a single username validation error returned during validation. Each error has a machine-readable `code` and a human-readable `message`." ---- - -<RequestExample> - -```typescript Interface lines -export interface UsernameValidationError { - /** - * A unique identifier for the validation rule that failed. - * - * Example: `"username-too-short"`, `"username-invalid-characters"` - */ - code: string; - - /** - * A human-readable description of the error. - * - * Example: `"Username must be at least 3 characters long."` - */ - message: string; - - /** - * The field associated with the validation error, typically "username", "email", or "phone". - */ - field: string; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="code" type={<span>string</span>} required> - A unique identifier for the validation rule that failed. Example: `"username-too-short"`, `"username-invalid-characters"` -</ParamField> - -<ParamField path="message" type={<span>string</span>} required> - A human-readable description of the error. Example: `"Username must be at least 3 characters long."` -</ParamField> - -<ParamField path="field" type={<span>string</span>} required> - The field associated with the validation error, typically "username", "email", or "phone". -</ParamField> - ---- - -**File:** [interfaces/utils/validate-username.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/validate-username.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult.mdx deleted file mode 100644 index 40d2d2063..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "UsernameValidationResult" -description: "The result of validating a username against one or more rules." ---- - -<RequestExample> - -```typescript Interface lines -export interface UsernameValidationResult { - /** - * Indicates whether the username passed all validation rules. - */ - isValid: boolean; - - /** - * An array of {@link UsernameValidationError} objects representing - * the individual rules that failed, if any. - * - * This array is empty if {@link UsernameValidationResult.isValid} is `true`. - */ - errors: UsernameValidationError[]; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="isValid" type={<span>boolean</span>} required> - Indicates whether the username passed all validation rules. -</ParamField> - -<ParamField path="errors" type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationError">UsernameValidationError[]</a></span>} required> - An array of objects representing the individual rules that failed, if any. This array is empty if is `true`. -</ParamField> - ---- - -**File:** [interfaces/utils/validate-username.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/validate-username.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifyPlatformAuthenticatorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifyPlatformAuthenticatorOptions.mdx deleted file mode 100644 index c28c322fe..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifyPlatformAuthenticatorOptions.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "VerifyPlatformAuthenticatorOptions" -description: "@interface VerifyPlatformAuthenticatorOptions" ---- - -<RequestExample> - -```typescript Interface lines -export interface VerifyPlatformAuthenticatorOptions extends CustomOptions { - /** - * Optional. If true and `screen.showRememberDevice` is true, this indicates the user - * has chosen to remember this device, typically for 30 days, to bypass MFA on subsequent logins. - * @type {boolean} - */ - rememberDevice?: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="rememberDevice" type={<span>boolean</span>}> - Optional. If true and `screen.showRememberDevice` is true, this indicates the user has chosen to remember this device, typically for 30 days, to bypass MFA on subsequent logins. -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-platform-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifySecurityKeyOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifySecurityKeyOptions.mdx deleted file mode 100644 index 6a3d3bc03..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifySecurityKeyOptions.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "VerifySecurityKeyOptions" -description: "@interface VerifySecurityKeyOptions" ---- - -<RequestExample> - -```typescript Interface lines -export interface VerifySecurityKeyOptions extends CustomOptions { - rememberDevice?: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="rememberDevice" type={<span>boolean</span>}> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-webauthn-roaming-challenge.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails.mdx deleted file mode 100644 index 00eaa5ec6..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "WebAuthnErrorDetails" -description: "Details of a WebAuthn browser error." ---- - -<RequestExample> - -```typescript Interface lines -export interface WebAuthnErrorDetails { - /** - * The name of the error (e.g., "NotAllowedError"). - */ - name: string; - /** - * The error message. - */ - message: string; - /** - * Any additional error properties. - */ - [key: string]: string | number | boolean | undefined; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="name" type={<span>string</span>} required> - The name of the error (e.g., "NotAllowedError"). -</ParamField> - -<ParamField path="message" type={<span>string</span>} required> - The error message. -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> - Any additional error properties. -</ParamField> - ---- - -**File:** [interfaces/common/index.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/common/index.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WithRememberOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WithRememberOptions.mdx deleted file mode 100644 index c23f22190..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WithRememberOptions.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "WithRememberOptions" -description: "" ---- - -<RequestExample> - -```typescript Interface lines -export interface WithRememberOptions extends CustomOptions { - rememberDevice?: boolean; -} -``` - -</RequestExample> - -## Properties - -<ParamField path="rememberDevice" type={<span>boolean</span>}> -</ParamField> - -<ParamField path="unknown" type={<span>string | number | boolean | undefined</span>}> -</ParamField> - ---- - -**File:** [interfaces/screens/mfa-push-challenge-push.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/navigation.json b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/navigation.json deleted file mode 100644 index 770842d2b..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/navigation.json +++ /dev/null @@ -1,581 +0,0 @@ -{ - "group": "@auth0/auth0-acul-js", - "pages": [ - { - "group": "Classes", - "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BaseContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Branding", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Client", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Organization", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Prompt", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Screen", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Tenant", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Transaction", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedData", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/User", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AcceptInvitation", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblock", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockFailure", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/BruteForceProtectionUnblockSuccess", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Consent", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/CustomizedConsent", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivation", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationAllowed", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeActivationDenied", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/DeviceCodeConfirmation", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailOTPChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/EmailVerificationResult", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/InterstitialCaptcha", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Login", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginEmailVerification", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessEmailCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LoginPasswordlessSmsOtp", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Logout", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutAborted", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/LogoutComplete", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaBeginEnrollOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaCountryCodes", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaDetectBrowserCapabilities", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEmailList", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaEnrollResult", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaLoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaOtpEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPhoneEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushList", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaPushWelcome", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeChallengeNewCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaRecoveryCodeEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaSmsList", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UntrustedDataOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaVoiceEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnChangeKeyNickname", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnEnrollmentSuccess", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnNotAvailableError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnPlatformEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/MfaWebAuthnRoamingEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationPicker", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/OrganizationSelection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PasskeyEnrollmentLocal", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/PhoneIdentifierEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/RedeemTicket", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordEmail", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaRecoveryCodeChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordMfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordRequest", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ResetPasswordSuccess", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Signup", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/ScreenOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/TransactionOverride", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/AculError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/UserInputError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/SDKUsageError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/Auth0ServerError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/classes/FormHandler" - ] - }, - { - "group": "Interfaces", - "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WebAuthnErrorDetails", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CurrentScreenOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FlattenedTheme", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BaseMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingSettings", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingThemes", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BrandingMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ClientMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Branding", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PromptMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CaptchaContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AllowCredential", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyRead", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreate", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhonePrefix", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Scope", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AuthorizationDetail", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenData", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TenantMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Connection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Passkey", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyLogin", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnroll", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CountryCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernamePolicy", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordPolicy", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DBConnection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordlessConnection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnectionContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnterpriseConnection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SocialConnection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordComplexityRule", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Error", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledEmail", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledPhoneNumber", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EnrolledDevice", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Organizations", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UserMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnAcceptInvitation", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AcceptInvitationMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockFailure", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockFailureMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockSuccessMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnBruteForceProtectionUnblockSuccess", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/BruteForceProtectionUnblockMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnConsent", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConsentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnCustomizedConsent", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CustomizedConsentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationAllowedMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationDeniedMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeActivationMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnDeviceCodeConfirmation", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/DeviceCodeConfirmationMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailIdentifierChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailOTPChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OtpCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailOTPChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnEmailVerificationResult", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/EmailVerificationResultMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCaptchaOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/InterstitialCaptchaMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEmailVerificationMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginIdMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessEmailCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessEmailCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessEmailCodeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLoginPasswordlessSmsOtp", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitOTPOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginPasswordlessSmsOtpMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnLogin", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnLogin", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionContextOnLogin", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnLogin", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Login", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedLoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutAbortedMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutCompleteMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConfirmLogoutOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LogoutMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaBeginEnrollOptionsMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaCountryCodes", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectCountryCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaCountryCodesMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaDetectBrowserCapabilitiesMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEmailList", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaEmailOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEmailListMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaEnrollResult", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaEnrollResultMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaLoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/LoginEnrollOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaLoginOptionsMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentCodeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaOtpEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaOtpEnrollmentQrMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickPhoneOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PickAuthenticatorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPhoneEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/WithRememberOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushChallengePushMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushEnrollmentQrMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectMfaPushDeviceOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushListMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaPushWelcome", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushWelcomeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeNewCodeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaRecoveryCodeEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaSmsEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsListMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UntrustedDataMembersOnMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaVoiceEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnChangeKeyNicknameMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnEnrollmentSuccessMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnErrorMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnNotAvailableErrorMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifyPlatformAuthenticatorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SubmitPasskeyCredentialOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnPlatformEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/VerifySecurityKeyOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportWebAuthnErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaWebAuthnRoamingEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SelectOrganizationOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationPickerMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithOrganizationNameOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnOrganizationSelection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/OrganizationSelectionMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocal", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/AbortEnrollmentOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollmentLocal", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentLocalMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnPhoneIdentifierEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneEnrollmentOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PhoneIdentifierEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/RedeemTicketMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordEmail", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordEmailMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordErrorMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaEmailChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaOtpChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPhoneChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaPushChallengePushMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaSmsChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaSmsChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaVoiceChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ContinueWithPasskeyOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ReportBrowserErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOnResetPasswordMfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UseSecurityKeyOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ShowErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPasswordRequest", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordRequest", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordRequestMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPasswordSuccess", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordSuccessMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenDataOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnResetPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnResetPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResetPasswordMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedScreenContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ExtendedUntrustedDataContext", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupIdMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenContextOnSignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupPasswordMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FederatedSignupOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ScreenMembersOnSignup", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/TransactionMembersOnSignup", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/SignupMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/FormOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PostPayloadOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCredentialResponse", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/CredentialResponse", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasskeyCreateResponse", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ConditionalMediationCapable", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/MfaPushPollingControl", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/StartResendOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/ResendControl", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/Identifier", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/PasswordValidationResult", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/interfaces/UsernameValidationResult" - ] - }, - { - "group": "Types", - "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/Base64URLString", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/AuthenticatorTransport", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/WebAuthnType", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/MfaPollingOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/OnStatusChangeCallback", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/IdentifierType" - ] - }, - { - "group": "Functions", - "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreen", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getCurrentScreenOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getErrors", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/updatePayloadByIdentifier", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupLink", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBackLink", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginLink", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getResetPasswordLink", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getForgotPasswordLink", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getEditIdentifierLink", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPublicKey", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getShowRememberDevice", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getWebAuthnType", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getScopes", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isSignupEnabled", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isForgotPasswordEnabled", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeyEnabled", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isUsernameRequired", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getUsernamePolicy", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasswordPolicy", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getActiveIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getAllowedIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getRequiredIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getOptionalIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/hasFlexibleIdentifier", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/extractIdentifiersByStatus", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenColors", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenFonts", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenBorders", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenPageBackground", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/flattenWidget", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isBrave", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthAvailable", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isJsAvailable", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isWebAuthPlatformAvailable", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isPasskeySupported", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getBrowserCapabilities", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/base64UrlToUint8Array", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/uint8ArrayToBase64Url", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getLoginIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/safeBase64Url", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/decodePublicKey", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isAuthenticatorAssertionResponse", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getPasskeyCredentials", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPasskeyCredentials", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/registerPasskeyAutofill", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createPollingControl", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/internalPoll", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/startPolling", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/stopPolling", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/isRunning", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/parseErrorMessage", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/createResendControl", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/getSignupIdentifiers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validatePassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/functions/validateUsername" - ] - } - ] -} \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/AuthenticatorTransport.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/AuthenticatorTransport.mdx deleted file mode 100644 index ecd21b6a8..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/AuthenticatorTransport.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "AuthenticatorTransport" -description: "" ---- - -## Type Definition - -```typescript -type AuthenticatorTransport = 'usb' | 'nfc' | 'ble' | 'internal' | 'hybrid'; -``` - ---- - -**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/Base64URLString.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/Base64URLString.mdx deleted file mode 100644 index 18f813fcc..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/Base64URLString.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Base64URLString" -description: "" ---- - -## Type Definition - -```typescript -type Base64URLString = string; -``` - ---- - -**File:** [interfaces/models/screen.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/models/screen.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/IdentifierType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/IdentifierType.mdx deleted file mode 100644 index 5bf35ef23..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/IdentifierType.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "IdentifierType" -description: "Represents the types of user identifiers that can be used during signup. - `'email'`: The user will provide an email address. - `'phone'`: The user will provide a phone number. - `'username'`: The user will choose a username. This type is typically used in identity selection or signup flows to define which identifiers are enabled and how they behave." ---- - -## Type Definition - -```typescript -type IdentifierType = 'email' | 'phone' | 'username'; -``` - ---- - -**File:** [interfaces/utils/signup-identifiers.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/MfaPollingOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/MfaPollingOptions.mdx deleted file mode 100644 index 203a15c14..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/MfaPollingOptions.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "MfaPollingOptions" -description: "Configuration options for managing an MFA push-notification polling process. Supply these options when starting a polling session to control how often the challenge endpoint is queried and how success or failure is handled." ---- - -## Type Definition - -```typescript -type MfaPollingOptions = { - /** - * Optional interval, in **milliseconds**, between consecutive polling requests. - * - * - If omitted, the SDK’s internal default interval is used (typically 5000 ms). - * - Choose a value that balances responsiveness with rate-limit considerations. - * - * @defaultValue Implementation-specific (commonly 5000 ms) - */ - intervalMs?: number; - - /** - * Optional callback executed once the MFA push challenge is successfully - * approved and polling completes. - * - * - Called exactly **once**, after which polling stops automatically. - * - Useful for advancing the login flow (e.g., calling `continue()`). - */ - onCompleted?: () => void; - - /** - * Optional callback invoked if an error occurs while polling. - * - * Receives an {@link ULError} object containing: - * - `status` — the HTTP status code from the failed request - * - `responseText` — the raw response body, if available - * - * - Called once per error event; polling may retry depending on error type. - * - Use to surface error messages or trigger custom retry/abort logic. - */ - onError?: (error: ULError) => void; -}; -``` - ---- - -**File:** [interfaces/utils/polling-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/polling-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/OnStatusChangeCallback.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/OnStatusChangeCallback.mdx deleted file mode 100644 index 57b68f24e..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/OnStatusChangeCallback.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "OnStatusChangeCallback" -description: "Callback function for status changes during resend countdown." ---- - -## Type Definition - -```typescript -type OnStatusChangeCallback = (remainingSeconds: number, isDisabled: boolean) => void; -``` - ---- - -**File:** [interfaces/utils/resend-control.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/utils/resend-control.ts) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/WebAuthnType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/WebAuthnType.mdx deleted file mode 100644 index 13d1ca8a3..000000000 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/types/WebAuthnType.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "WebAuthnType" -description: "@type description Specifies the type of WebAuthn authenticator involved in the error. - `webauthn-roaming`: Error related to a roaming authenticator (e.g., USB security key). - `webauthn-platform`: Error related to a platform authenticator (e.g., Touch ID, Windows Hello)." ---- - -## Type Definition - -```typescript -type WebAuthnType = 'webauthn-roaming' | 'webauthn-platform'; -``` - ---- - -**File:** [interfaces/screens/mfa-webauthn-error.ts](https://github.com/auth0/universal-login/blob/master/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts) From 3f96f3f6e76a132a22034933f86f880a477d259e Mon Sep 17 00:00:00 2001 From: Gabriel <gabrielraeder@outlook.com.br> Date: Mon, 17 Nov 2025 18:32:56 -0300 Subject: [PATCH 6/7] fixes js sdk files --- main/docs.json | 195 +++++++----- .../Screens/classes/AcceptInvitation.mdx | 64 ++-- .../js-sdk/Screens/classes/AculError.mdx | 25 +- .../Screens/classes/Auth0ServerError.mdx | 21 +- .../js-sdk/Screens/classes/Consent.mdx | 148 ++------- .../Screens/classes/CustomizedConsent.mdx | 121 +------- .../Screens/classes/DeviceCodeActivation.mdx | 83 ++---- .../classes/DeviceCodeActivationAllowed.mdx | 41 +-- .../classes/DeviceCodeActivationDenied.mdx | 41 +-- .../classes/DeviceCodeConfirmation.mdx | 85 ++---- .../classes/EmailIdentifierChallenge.mdx | 134 ++------- .../Screens/classes/EmailOTPChallenge.mdx | 130 ++------ .../classes/EmailVerificationResult.mdx | 60 +--- .../Screens/classes/InterstitialCaptcha.mdx | 59 ++-- .../js-sdk/Screens/classes/Login.mdx | 128 ++------ .../classes/LoginEmailVerification.mdx | 193 ++---------- .../js-sdk/Screens/classes/LoginId.mdx | 282 ++---------------- .../js-sdk/Screens/classes/LoginPassword.mdx | 101 ++----- .../classes/LoginPasswordlessEmailCode.mdx | 127 ++------ .../classes/LoginPasswordlessSmsOtp.mdx | 126 ++------ .../js-sdk/Screens/classes/Logout.mdx | 67 ++--- .../js-sdk/Screens/classes/LogoutAborted.mdx | 41 +-- .../js-sdk/Screens/classes/LogoutComplete.mdx | 41 +-- .../Screens/classes/MfaBeginEnrollOptions.mdx | 60 ++-- .../Screens/classes/MfaCountryCodes.mdx | 111 ++----- .../classes/MfaDetectBrowserCapabilities.mdx | 62 +--- .../Screens/classes/MfaEmailChallenge.mdx | 184 ++---------- .../js-sdk/Screens/classes/MfaEmailList.mdx | 104 ++----- .../Screens/classes/MfaEnrollResult.mdx | 72 +---- .../Screens/classes/MfaLoginOptions.mdx | 84 ++---- .../Screens/classes/MfaOtpChallenge.mdx | 103 ++----- .../Screens/classes/MfaOtpEnrollmentCode.mdx | 105 ++----- .../Screens/classes/MfaOtpEnrollmentQr.mdx | 123 ++------ .../Screens/classes/MfaPhoneChallenge.mdx | 136 ++------- .../Screens/classes/MfaPhoneEnrollment.mdx | 130 ++------ .../Screens/classes/MfaPushChallengePush.mdx | 39 +-- .../Screens/classes/MfaPushEnrollmentQr.mdx | 112 ++----- .../js-sdk/Screens/classes/MfaPushList.mdx | 90 ++---- .../js-sdk/Screens/classes/MfaPushWelcome.mdx | 91 ++---- .../classes/MfaRecoveryCodeChallenge.mdx | 110 ++----- .../MfaRecoveryCodeChallengeNewCode.mdx | 106 ++----- .../classes/MfaRecoveryCodeEnrollment.mdx | 90 ++---- .../Screens/classes/MfaSmsChallenge.mdx | 206 ++----------- .../Screens/classes/MfaSmsEnrollment.mdx | 122 ++------ .../js-sdk/Screens/classes/MfaSmsList.mdx | 103 ++----- .../Screens/classes/MfaVoiceChallenge.mdx | 227 ++------------ .../Screens/classes/MfaVoiceEnrollment.mdx | 136 ++------- .../classes/MfaWebAuthnChangeKeyNickname.mdx | 97 +----- .../classes/MfaWebAuthnEnrollmentSuccess.mdx | 108 ++----- .../Screens/classes/MfaWebAuthnError.mdx | 159 ++-------- .../classes/MfaWebAuthnNotAvailableError.mdx | 85 ++---- .../classes/MfaWebAuthnPlatformChallenge.mdx | 167 +---------- .../classes/MfaWebAuthnPlatformEnrollment.mdx | 164 ++-------- .../classes/MfaWebAuthnRoamingChallenge.mdx | 131 +------- .../classes/MfaWebAuthnRoamingEnrollment.mdx | 128 ++------ .../Screens/classes/OrganizationPicker.mdx | 127 ++------ .../Screens/classes/OrganizationSelection.mdx | 74 ++--- .../Screens/classes/PasskeyEnrollment.mdx | 80 ++--- .../classes/PasskeyEnrollmentLocal.mdx | 86 ++---- .../classes/PhoneIdentifierChallenge.mdx | 170 ++--------- .../classes/PhoneIdentifierEnrollment.mdx | 79 ++--- .../js-sdk/Screens/classes/RedeemTicket.mdx | 69 ++--- .../js-sdk/Screens/classes/ResetPassword.mdx | 77 ++--- .../Screens/classes/ResetPasswordEmail.mdx | 55 ++-- .../Screens/classes/ResetPasswordError.mdx | 41 +-- .../ResetPasswordMfaEmailChallenge.mdx | 148 ++------- .../classes/ResetPasswordMfaOtpChallenge.mdx | 94 ++---- .../ResetPasswordMfaPhoneChallenge.mdx | 143 ++------- .../ResetPasswordMfaPushChallengePush.mdx | 181 ++--------- .../ResetPasswordMfaRecoveryCodeChallenge.mdx | 111 ++----- .../classes/ResetPasswordMfaSmsChallenge.mdx | 169 ++--------- .../ResetPasswordMfaVoiceChallenge.mdx | 165 ++-------- ...etPasswordMfaWebAuthnPlatformChallenge.mdx | 47 +-- ...setPasswordMfaWebAuthnRoamingChallenge.mdx | 55 ++-- .../Screens/classes/ResetPasswordRequest.mdx | 94 ++---- .../Screens/classes/ResetPasswordSuccess.mdx | 38 +-- .../js-sdk/Screens/classes/SDKUsageError.mdx | 21 +- .../js-sdk/Screens/classes/Signup.mdx | 176 ++--------- .../js-sdk/Screens/classes/SignupId.mdx | 191 ++---------- .../js-sdk/Screens/classes/SignupPassword.mdx | 153 ++-------- .../js-sdk/Screens/classes/UserInputError.mdx | 21 +- .../Screens/functions/getCurrentScreen.mdx | 2 +- .../functions/getCurrentScreenOptions.mdx | 2 +- .../functions/getCurrentThemeOptions.mdx | 2 +- .../js-sdk/Screens/functions/getErrors.mdx | 2 +- .../interfaces/AbortEnrollmentOptions.mdx | 4 +- .../interfaces/AcceptInvitationMembers.mdx | 22 +- .../Screens/interfaces/AllowCredential.mdx | 8 +- .../interfaces/AuthorizationDetail.mdx | 4 +- .../js-sdk/Screens/interfaces/BaseMembers.mdx | 20 +- .../js-sdk/Screens/interfaces/Branding.mdx | 6 +- .../Screens/interfaces/BrandingMembers.mdx | 6 +- .../Screens/interfaces/BrandingSettings.mdx | 10 +- .../Screens/interfaces/BrandingThemes.mdx | 4 +- .../Screens/interfaces/CaptchaContext.mdx | 8 +- .../Screens/interfaces/ClientMembers.mdx | 12 +- .../interfaces/ConfirmLogoutOptions.mdx | 4 +- .../js-sdk/Screens/interfaces/Connection.mdx | 8 +- .../Screens/interfaces/ConsentMembers.mdx | 24 +- .../Screens/interfaces/ContinueOTPOptions.mdx | 6 +- .../Screens/interfaces/ContinueOptions.mdx | 6 +- .../interfaces/ContinuePayloadOptions.mdx | 6 +- .../ContinueWithCodeOptionPayload.mdx | 4 +- .../ContinueWithOrganizationNameOptions.mdx | 4 +- .../Screens/interfaces/CredentialResponse.mdx | 8 +- .../interfaces/CurrentScreenOptions.mdx | 16 +- .../Screens/interfaces/CustomOptions.mdx | 2 +- .../interfaces/CustomizedConsentMembers.mdx | 24 +- .../DeviceCodeActivationAllowedMembers.mdx | 20 +- .../DeviceCodeActivationContinueOptions.mdx | 4 +- .../DeviceCodeActivationDeniedMembers.mdx | 20 +- .../DeviceCodeActivationMembers.mdx | 22 +- .../DeviceCodeConfirmationMembers.mdx | 24 +- .../interfaces/EmailChallengeOptions.mdx | 6 +- .../EmailIdentifierChallengeMembers.mdx | 28 +- .../interfaces/EmailOTPChallengeMembers.mdx | 26 +- .../EmailVerificationResultMembers.mdx | 20 +- .../Screens/interfaces/EnrolledDevice.mdx | 6 +- .../Screens/interfaces/EnrolledEmail.mdx | 6 +- .../interfaces/EnrolledPhoneNumber.mdx | 6 +- .../interfaces/EnterpriseConnection.mdx | 10 +- .../js-sdk/Screens/interfaces/Error.mdx | 10 +- .../interfaces/FederatedLoginOptions.mdx | 4 +- .../FederatedLoginPasswordOptions.mdx | 4 +- .../FederatedLoginPayloadOptions.mdx | 4 +- .../interfaces/FederatedSignupOptions.mdx | 4 +- .../FederatedSignupPasswordPayloadOptions.mdx | 4 +- .../FederatedSignupPayloadOptions.mdx | 4 +- .../Screens/interfaces/FlattenedTheme.mdx | 12 +- .../js-sdk/Screens/interfaces/Identifier.mdx | 6 +- .../interfaces/InterstitialCaptchaMembers.mdx | 26 +- .../LoginEmailVerificationMembers.mdx | 26 +- .../Screens/interfaces/LoginEnrollOptions.mdx | 4 +- .../Screens/interfaces/LoginIdMembers.mdx | 30 +- .../Screens/interfaces/LoginMembers.mdx | 28 +- .../Screens/interfaces/LoginOptions.mdx | 6 +- .../interfaces/LoginPasswordMembers.mdx | 24 +- .../interfaces/LoginPasswordOptions.mdx | 8 +- .../LoginPasswordlessEmailCodeMembers.mdx | 26 +- .../LoginPasswordlessSmsOtpMembers.mdx | 26 +- .../interfaces/LoginPayloadOptions.mdx | 8 +- .../interfaces/LogoutAbortedMembers.mdx | 20 +- .../interfaces/LogoutCompleteMembers.mdx | 20 +- .../Screens/interfaces/LogoutMembers.mdx | 22 +- .../MfaBeginEnrollOptionsMembers.mdx | 22 +- .../interfaces/MfaCountryCodesMembers.mdx | 24 +- .../MfaDetectBrowserCapabilitiesMembers.mdx | 22 +- .../interfaces/MfaEmailChallengeMembers.mdx | 30 +- .../interfaces/MfaEmailListMembers.mdx | 24 +- .../Screens/interfaces/MfaEnrollOptions.mdx | 4 +- .../interfaces/MfaEnrollResultMembers.mdx | 20 +- .../interfaces/MfaLoginOptionsMembers.mdx | 24 +- .../interfaces/MfaOtpChallengeMembers.mdx | 24 +- .../interfaces/MfaOtpContinueOptions.mdx | 4 +- .../MfaOtpEnrollmentCodeMembers.mdx | 24 +- .../MfaOtpEnrollmentQrContinueOptions.mdx | 4 +- .../interfaces/MfaOtpEnrollmentQrMembers.mdx | 26 +- .../MfaOtpTryAnotherMethodOptions.mdx | 2 +- .../MfaPhoneChallengeContinueOptions.mdx | 4 +- .../interfaces/MfaPhoneChallengeMembers.mdx | 26 +- ...PhoneChallengePickAuthenticatorOptions.mdx | 2 +- .../MfaPhoneChallengePickPhoneOptions.mdx | 2 +- .../MfaPhoneEnrollmentContinueOptions.mdx | 6 +- .../interfaces/MfaPhoneEnrollmentMembers.mdx | 26 +- .../MfaPushChallengePushMembers.mdx | 30 +- .../interfaces/MfaPushEnrollmentQrMembers.mdx | 24 +- .../Screens/interfaces/MfaPushListMembers.mdx | 24 +- .../interfaces/MfaPushPollingControl.mdx | 8 +- .../interfaces/MfaPushWelcomeMembers.mdx | 24 +- ...faRecoveryCodeChallengeContinueOptions.mdx | 4 +- .../MfaRecoveryCodeChallengeMembers.mdx | 24 +- ...eryCodeChallengeNewCodeContinueOptions.mdx | 2 +- ...MfaRecoveryCodeChallengeNewCodeMembers.mdx | 22 +- ...aRecoveryCodeEnrollmentContinueOptions.mdx | 4 +- .../MfaRecoveryCodeEnrollmentMembers.mdx | 22 +- .../interfaces/MfaSmsChallengeMembers.mdx | 32 +- .../interfaces/MfaSmsChallengeOptions.mdx | 6 +- .../interfaces/MfaSmsEnrollmentMembers.mdx | 26 +- .../interfaces/MfaSmsEnrollmentOptions.mdx | 6 +- .../Screens/interfaces/MfaSmsListMembers.mdx | 24 +- .../Screens/interfaces/MfaSmsListOptions.mdx | 4 +- .../MfaVoiceChallengeContinueOptions.mdx | 6 +- .../interfaces/MfaVoiceChallengeMembers.mdx | 32 +- .../MfaVoiceEnrollmentContinueOptions.mdx | 4 +- .../interfaces/MfaVoiceEnrollmentMembers.mdx | 26 +- ...bAuthnChangeKeyNicknameContinueOptions.mdx | 4 +- .../MfaWebAuthnChangeKeyNicknameMembers.mdx | 22 +- .../MfaWebAuthnEnrollmentSuccessMembers.mdx | 22 +- .../interfaces/MfaWebAuthnErrorMembers.mdx | 28 +- .../MfaWebAuthnNotAvailableErrorMembers.mdx | 22 +- .../MfaWebAuthnPlatformChallengeMembers.mdx | 26 +- ...thnPlatformChallengeReportErrorOptions.mdx | 4 +- ...atformChallengeTryAnotherMethodOptions.mdx | 2 +- .../MfaWebAuthnPlatformEnrollmentMembers.mdx | 28 +- .../MfaWebAuthnRoamingChallengeMembers.mdx | 26 +- ...uthnRoamingChallengeReportErrorOptions.mdx | 4 +- ...oamingChallengeTryAnotherMethodOptions.mdx | 2 +- .../MfaWebAuthnRoamingEnrollmentMembers.mdx | 26 +- ...amingEnrollmentTryAnotherMethodOptions.mdx | 2 +- .../interfaces/OrganizationMembers.mdx | 14 +- .../interfaces/OrganizationPickerMembers.mdx | 24 +- .../OrganizationSelectionMembers.mdx | 22 +- .../Screens/interfaces/Organizations.mdx | 10 +- .../Screens/interfaces/OtpCodeOptions.mdx | 4 +- .../Screens/interfaces/PasskeyCreate.mdx | 79 ++--- .../interfaces/PasskeyCreateResponse.mdx | 12 +- .../PasskeyEnrollmentLocalMembers.mdx | 24 +- .../interfaces/PasskeyEnrollmentMembers.mdx | 24 +- .../interfaces/PasswordComplexityRule.mdx | 14 +- .../Screens/interfaces/PasswordPolicy.mdx | 10 +- .../interfaces/PasswordValidationResult.mdx | 6 +- .../interfaces/PhoneChallengeOptions.mdx | 6 +- .../interfaces/PhoneEnrollmentOptions.mdx | 4 +- .../PhoneIdentifierChallengeMembers.mdx | 32 +- .../PhoneIdentifierEnrollmentMembers.mdx | 24 +- .../js-sdk/Screens/interfaces/PhonePrefix.mdx | 8 +- .../Screens/interfaces/PromptMembers.mdx | 4 +- .../interfaces/RedeemTicketMembers.mdx | 22 +- .../interfaces/ReportBrowserErrorOptions.mdx | 4 +- .../Screens/interfaces/ResendCodeOptions.mdx | 2 +- .../interfaces/ResendCodeOptionsPayload.mdx | 2 +- .../interfaces/ResendCodePayloadOptions.mdx | 2 +- .../Screens/interfaces/ResendControl.mdx | 4 +- .../interfaces/ResetPasswordEmailMembers.mdx | 22 +- .../interfaces/ResetPasswordEmailOptions.mdx | 2 +- .../interfaces/ResetPasswordErrorMembers.mdx | 20 +- .../interfaces/ResetPasswordMembers.mdx | 24 +- .../ResetPasswordMfaEmailChallengeMembers.mdx | 28 +- ...PasswordMfaOtpChallengeContinueOptions.mdx | 4 +- .../ResetPasswordMfaOtpChallengeMembers.mdx | 24 +- ...MfaOtpChallengeTryAnotherMethodOptions.mdx | 2 +- ...sswordMfaPhoneChallengeContinueOptions.mdx | 4 +- .../ResetPasswordMfaPhoneChallengeMembers.mdx | 24 +- ...aPhoneChallengeTryAnotherMethodOptions.mdx | 4 +- ...setPasswordMfaPushChallengePushMembers.mdx | 30 +- ...asswordMfaRecoveryCodeChallengeMembers.mdx | 24 +- .../ResetPasswordMfaSmsChallengeMembers.mdx | 30 +- .../ResetPasswordMfaSmsChallengeOptions.mdx | 4 +- ...sswordMfaVoiceChallengeContinueOptions.mdx | 4 +- .../ResetPasswordMfaVoiceChallengeMembers.mdx | 30 +- ...bAuthnPlatformChallengeContinueOptions.mdx | 4 +- ...ordMfaWebAuthnPlatformChallengeMembers.mdx | 26 +- ...thnPlatformChallengeReportErrorOptions.mdx | 4 +- ...atformChallengeTryAnotherMethodOptions.mdx | 2 +- ...wordMfaWebAuthnRoamingChallengeMembers.mdx | 26 +- ...bAuthnRoamingChallengeShowErrorOptions.mdx | 6 +- ...oamingChallengeTryAnotherMethodOptions.mdx | 4 +- ...nRoamingChallengeUseSecurityKeyOptions.mdx | 4 +- .../interfaces/ResetPasswordOptions.mdx | 6 +- .../ResetPasswordRequestMembers.mdx | 26 +- .../ResetPasswordRequestOptions.mdx | 6 +- .../ResetPasswordSuccessMembers.mdx | 20 +- .../js-sdk/Screens/interfaces/Scope.mdx | 6 +- .../Screens/interfaces/ScreenMembers.mdx | 20 +- .../ScreenMembersOnAcceptInvitation.mdx | 20 +- .../interfaces/ScreenMembersOnConsent.mdx | 24 +- .../ScreenMembersOnCustomizedConsent.mdx | 24 +- .../ScreenMembersOnDeviceCodeConfirmation.mdx | 20 +- ...creenMembersOnEmailIdentifierChallenge.mdx | 20 +- .../ScreenMembersOnEmailOTPChallenge.mdx | 20 +- ...ScreenMembersOnEmailVerificationResult.mdx | 22 +- .../interfaces/ScreenMembersOnLogin.mdx | 24 +- .../interfaces/ScreenMembersOnLoginId.mdx | 26 +- .../ScreenMembersOnLoginPassword.mdx | 26 +- ...eenMembersOnLoginPasswordlessEmailCode.mdx | 26 +- ...ScreenMembersOnLoginPasswordlessSmsOtp.mdx | 26 +- .../ScreenMembersOnMfaCountryCodes.mdx | 20 +- .../ScreenMembersOnMfaEmailChallenge.mdx | 20 +- .../ScreenMembersOnMfaEmailList.mdx | 20 +- .../ScreenMembersOnMfaEnrollResult.mdx | 20 +- .../ScreenMembersOnMfaLoginOptions.mdx | 20 +- .../ScreenMembersOnMfaOtpChallenge.mdx | 20 +- .../ScreenMembersOnMfaOtpEnrollmentCode.mdx | 20 +- .../ScreenMembersOnMfaOtpEnrollmentQr.mdx | 20 +- .../ScreenMembersOnMfaPhoneChallenge.mdx | 20 +- .../ScreenMembersOnMfaPushChallengePush.mdx | 20 +- .../ScreenMembersOnMfaPushEnrollmentQr.mdx | 20 +- .../ScreenMembersOnMfaPushWelcome.mdx | 22 +- ...mbersOnMfaRecoveryCodeChallengeNewCode.mdx | 20 +- ...reenMembersOnMfaRecoveryCodeEnrollment.mdx | 20 +- .../ScreenMembersOnMfaSmsChallenge.mdx | 20 +- .../ScreenMembersOnMfaSmsEnrollment.mdx | 20 +- .../ScreenMembersOnMfaVoiceChallenge.mdx | 20 +- ...nMembersOnMfaWebAuthnChangeKeyNickname.mdx | 20 +- ...nMembersOnMfaWebAuthnEnrollmentSuccess.mdx | 20 +- .../ScreenMembersOnMfaWebAuthnError.mdx | 20 +- ...nMembersOnMfaWebAuthnPlatformChallenge.mdx | 24 +- ...MembersOnMfaWebAuthnPlatformEnrollment.mdx | 22 +- ...enMembersOnMfaWebAuthnRoamingChallenge.mdx | 26 +- ...nMembersOnMfaWebAuthnRoamingEnrollment.mdx | 24 +- .../ScreenMembersOnOrganizationSelection.mdx | 32 +- .../ScreenMembersOnPasskeyEnrollment.mdx | 26 +- .../ScreenMembersOnPasskeyEnrollmentLocal.mdx | 22 +- ...creenMembersOnPhoneIdentifierChallenge.mdx | 20 +- ...reenMembersOnPhoneIdentifierEnrollment.mdx | 22 +- .../ScreenMembersOnResetPassword.mdx | 20 +- .../ScreenMembersOnResetPasswordEmail.mdx | 20 +- .../ScreenMembersOnResetPasswordError.mdx | 20 +- ...embersOnResetPasswordMfaEmailChallenge.mdx | 20 +- ...embersOnResetPasswordMfaPhoneChallenge.mdx | 20 +- ...ersOnResetPasswordMfaPushChallengePush.mdx | 20 +- ...nMembersOnResetPasswordMfaSmsChallenge.mdx | 20 +- ...embersOnResetPasswordMfaVoiceChallenge.mdx | 20 +- ...etPasswordMfaWebAuthnPlatformChallenge.mdx | 24 +- ...setPasswordMfaWebAuthnRoamingChallenge.mdx | 24 +- .../ScreenMembersOnResetPasswordRequest.mdx | 20 +- .../ScreenMembersOnResetPasswordSuccess.mdx | 20 +- .../interfaces/ScreenMembersOnSignup.mdx | 22 +- .../interfaces/ScreenMembersOnSignupId.mdx | 22 +- .../ScreenMembersOnSignupPassword.mdx | 24 +- .../interfaces/SelectCountryCodeOptions.mdx | 6 +- .../interfaces/SelectMfaEmailOptions.mdx | 4 +- .../interfaces/SelectMfaPushDeviceOptions.mdx | 4 +- .../interfaces/SelectOrganizationOptions.mdx | 6 +- .../Screens/interfaces/ShowErrorOptions.mdx | 4 +- .../Screens/interfaces/SignupIdMembers.mdx | 30 +- .../Screens/interfaces/SignupMembers.mdx | 32 +- .../Screens/interfaces/SignupOptions.mdx | 10 +- .../interfaces/SignupPasswordMembers.mdx | 26 +- .../interfaces/SignupPasswordOptions.mdx | 12 +- .../interfaces/SignupPayloadOptions.mdx | 12 +- .../Screens/interfaces/StartResendOptions.mdx | 8 +- .../interfaces/SubmitCaptchaOptions.mdx | 4 +- .../Screens/interfaces/SubmitCodeOptions.mdx | 6 +- .../Screens/interfaces/SubmitOTPOptions.mdx | 8 +- .../SubmitPasskeyCredentialOptions.mdx | 2 +- .../Screens/interfaces/TenantMembers.mdx | 10 +- .../Screens/interfaces/TransactionMembers.mdx | 20 +- .../interfaces/TransactionMembersOnLogin.mdx | 30 +- .../TransactionMembersOnLoginId.mdx | 32 +- .../TransactionMembersOnLoginPassword.mdx | 32 +- ...ionMembersOnLoginPasswordlessEmailCode.mdx | 22 +- ...actionMembersOnLoginPasswordlessSmsOtp.mdx | 22 +- .../TransactionMembersOnResetPassword.mdx | 22 +- ...ansactionMembersOnResetPasswordRequest.mdx | 26 +- .../interfaces/TransactionMembersOnSignup.mdx | 30 +- .../TransactionMembersOnSignupId.mdx | 28 +- .../TransactionMembersOnSignupPassword.mdx | 28 +- ...TryAnotherMethodMfaOtpChallengeOptions.mdx | 2 +- .../interfaces/TryAnotherMethodOptions.mdx | 2 +- .../TryAnotherMethodPayloadOptions.mdx | 2 +- .../interfaces/UntrustedDataMembers.mdx | 6 +- ...ntrustedDataMembersOnMfaEmailChallenge.mdx | 6 +- .../UntrustedDataMembersOnMfaOtpChallenge.mdx | 6 +- ...ustedDataMembersOnMfaPushChallengePush.mdx | 6 +- .../UntrustedDataMembersOnMfaSmsChallenge.mdx | 6 +- ...ntrustedDataMembersOnMfaVoiceChallenge.mdx | 6 +- .../js-sdk/Screens/interfaces/UserMembers.mdx | 26 +- .../Screens/interfaces/UsernamePolicy.mdx | 10 +- .../interfaces/UsernameValidationError.mdx | 8 +- .../interfaces/UsernameValidationResult.mdx | 6 +- .../VerifyPlatformAuthenticatorOptions.mdx | 4 +- .../interfaces/VerifySecurityKeyOptions.mdx | 4 +- .../WebAuthnEnrollSuccessContinueOptions.mdx | 2 +- .../interfaces/WebAuthnErrorDetails.mdx | 6 +- .../interfaces/WithRememberOptions.mdx | 4 +- .../type-aliases/AuthenticatorTransport.mdx | 2 +- .../Screens/type-aliases/IdentifierType.mdx | 2 +- .../type-aliases/MfaEnrollFactorType.mdx | 2 +- .../type-aliases/MfaLoginFactorType.mdx | 2 +- .../type-aliases/MfaPollingOptions.mdx | 8 +- .../type-aliases/OnStatusChangeCallback.mdx | 2 +- .../type-aliases/ScreenIdentifierType.mdx | 2 +- .../Screens/type-aliases/WebAuthnType.mdx | 2 +- 364 files changed, 3865 insertions(+), 9119 deletions(-) diff --git a/main/docs.json b/main/docs.json index 342bcc931..78df9b24a 100644 --- a/main/docs.json +++ b/main/docs.json @@ -1236,86 +1236,121 @@ { "group": "Classes", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AcceptInvitation", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Consent", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/CustomizedConsent", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivation", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationAllowed", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationDenied", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeConfirmation", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailOTPChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailVerificationResult", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/InterstitialCaptcha", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Login", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginEmailVerification", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessEmailCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessSmsOtp", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Logout", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutAborted", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutComplete", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaBeginEnrollOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaCountryCodes", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaDetectBrowserCapabilities", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailList", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEnrollResult", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaLoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushEnrollmentQr", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushList", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushWelcome", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsList", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationPicker", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationSelection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollmentLocal", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/RedeemTicket", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordEmail", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordRequest", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordSuccess", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Signup", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupId", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError" + { + "group": "Login", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Login", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginEmailVerification", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessEmailCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessSmsOtp", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Logout", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutAborted", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutComplete" + ] + }, + { + "group": "Sign up", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Signup", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupId", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupPassword" + ] + }, + { + "group": "MFA", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaBeginEnrollOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaCountryCodes", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaDetectBrowserCapabilities", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailList", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEnrollResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaLoginOptions", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushEnrollmentQr", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushList", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushWelcome", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsList", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment" + ] + }, + { + "group": "Password", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPassword", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordEmail", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordRequest", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordSuccess" + ] + }, + { + "group": "Device", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationAllowed", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationDenied", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeConfirmation" + ] + }, + { + "group": "Consent", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Consent", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/CustomizedConsent" + ] + }, + { + "group": "Other", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AcceptInvitation", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailOTPChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailVerificationResult", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/InterstitialCaptcha", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationPicker", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationSelection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollmentLocal", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierChallenge", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierEnrollment", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/RedeemTicket", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError" + ] + } ] }, { diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AcceptInvitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AcceptInvitation.mdx index abbc843ef..180da3b05 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AcceptInvitation.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AcceptInvitation.mdx @@ -2,7 +2,7 @@ title: "AcceptInvitation" --- -Defined in: [src/screens/accept-invitation/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L16) +Defined in: [src/screens/accept-invitation/index.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L16) Class implementing the accept-invitation screen functionality. This screen is displayed when a user needs to accept an invitation to an organization. @@ -10,38 +10,10 @@ This screen is displayed when a user needs to accept an invitation to an organiz <RequestExample> ```ts -export default class AcceptInvitation extends BaseContext implements AcceptInvitationMembers { - static screenIdentifier: string = ScreenIds.ACCEPT_INVITATION; - screen: ScreenOptions; - - /** - * Creates an instance of AcceptInvitation screen manager. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Accepts the invitation to the organization. - * @param payload Optional custom options to include with the request. - * @example - * ```typescript - * import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation'; - * - * const acceptInvitation = new AcceptInvitation(); - * await acceptInvitation.acceptInvitation(); - * ``` - */ - async acceptInvitation(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [AcceptInvitation.screenIdentifier, 'acceptInvitation'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.DEFAULT }); - } -} +import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation'; + +const acceptInvitation = new AcceptInvitation(); +await acceptInvitation.acceptInvitation(); ``` </RequestExample> @@ -58,7 +30,7 @@ export default class AcceptInvitation extends BaseContext implements AcceptInvit <ParamField body="AcceptInvitation" type="Constructor"> {/*> **new AcceptInvitation**(): `AcceptInvitation`*/} -Defined in: [src/screens/accept-invitation/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L23) +Defined in: [src/screens/accept-invitation/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L23) Creates an instance of AcceptInvitation screen manager. @@ -76,7 +48,7 @@ Creates an instance of AcceptInvitation screen manager. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -91,7 +63,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -106,7 +78,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -121,7 +93,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -136,7 +108,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation">ScreenMembersOnAcceptInvitation</a></span>}> {/*> **screen**: [`ScreenMembersOnAcceptInvitation`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation)*/} -Defined in: [src/screens/accept-invitation/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L18) +Defined in: [src/screens/accept-invitation/index.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L18) #### Implementation of @@ -151,7 +123,7 @@ Defined in: [src/screens/accept-invitation/index.ts:18](https://github.com/auth0 <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -166,7 +138,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -181,7 +153,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -196,7 +168,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -211,7 +183,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.ACCEPT_INVITATION`*/} -Defined in: [src/screens/accept-invitation/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L17) +Defined in: [src/screens/accept-invitation/index.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L17) #### Overrides @@ -223,7 +195,7 @@ Defined in: [src/screens/accept-invitation/index.ts:17](https://github.com/auth0 <ParamField body='acceptInvitation' type='Promise<void>'> {/*> **acceptInvitation**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/accept-invitation/index.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L40) +Defined in: [src/screens/accept-invitation/index.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/accept-invitation/index.ts#L40) Accepts the invitation to the organization. @@ -257,7 +229,7 @@ await acceptInvitation.acceptInvitation(); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.mdx index edaca5c80..6c07c0abc 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.mdx @@ -2,28 +2,11 @@ title: "AculError" --- -Defined in: [src/utils/errors.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L10) +Defined in: [src/utils/errors.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L10) AculError -<RequestExample> -```ts -export class AculError extends Error { - public readonly code: string; - public readonly field?: string; - - constructor(message: string, field?: string) { - super(message); - this.name = new.target.name; - this.code = 'ACUL_ERROR'; - this.field = field; - Object.setPrototypeOf(this, new.target.prototype); - } -} -``` -</RequestExample> - ## Param The error message. @@ -51,7 +34,7 @@ Throws an error if the message is empty. <ParamField body="AculError" type="Constructor"> {/*> **new AculError**(`message`, `field?`): `AculError`*/} -Defined in: [src/utils/errors.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L14) +Defined in: [src/utils/errors.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L14) <Expandable title="Parameters"> <ParamField body='message' type='string'> @@ -73,12 +56,12 @@ Defined in: [src/utils/errors.ts:14](https://github.com/auth0/universal-login/bl <ParamField body='code' type='string'> {/*> `readonly` **code**: `string`*/} -Defined in: [src/utils/errors.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L11) +Defined in: [src/utils/errors.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L11) </ParamField> <ParamField body='field?' type='string'> {/*> `readonly` `optional` **field**: `string`*/} -Defined in: [src/utils/errors.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L12) +Defined in: [src/utils/errors.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L12) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError.mdx index 217815fd9..2763b0154 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError.mdx @@ -2,24 +2,11 @@ title: "Auth0ServerError" --- -Defined in: [src/utils/errors.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L63) +Defined in: [src/utils/errors.ts:63](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L63) Auth0ServerError -<RequestExample> -```ts -export class Auth0ServerError extends AculError { - public readonly code = 'AUTH0_SERVER_ERROR'; - - constructor(message: string, field?: string) { - super(message, field); - Object.setPrototypeOf(this, new.target.prototype); - } -} -``` -</RequestExample> - ## Param The error message. @@ -37,7 +24,7 @@ The optional field associated with the error. <ParamField body="Auth0ServerError" type="Constructor"> {/*> **new Auth0ServerError**(`message`, `field?`): `Auth0ServerError`*/} -Defined in: [src/utils/errors.ts:66](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L66) +Defined in: [src/utils/errors.ts:66](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L66) <Expandable title="Parameters"> <ParamField body='message' type='string'> @@ -59,7 +46,7 @@ Defined in: [src/utils/errors.ts:66](https://github.com/auth0/universal-login/bl <ParamField body='code' type='"AUTH0_SERVER_ERROR"'> {/*> `readonly` **code**: `"AUTH0_SERVER_ERROR"` = `'AUTH0_SERVER_ERROR'`*/} -Defined in: [src/utils/errors.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L64) +Defined in: [src/utils/errors.ts:64](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L64) #### Overrides @@ -70,7 +57,7 @@ Defined in: [src/utils/errors.ts:64](https://github.com/auth0/universal-login/bl <ParamField body='field?' type='string'> {/*> `readonly` `optional` **field**: `string`*/} -Defined in: [src/utils/errors.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L12) +Defined in: [src/utils/errors.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L12) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Consent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Consent.mdx index 305b32b5b..a00656dde 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Consent.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Consent.mdx @@ -2,121 +2,23 @@ title: "Consent" --- -Defined in: [src/screens/consent/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/consent/index.ts#L13) +Defined in: [src/screens/consent/index.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/consent/index.ts#L13) ConsentMembers <RequestExample> ```ts -export default class Consent extends BaseContext implements ConsentMembers { - static screenIdentifier: string = ScreenIds.CONSENT; - - /** - * Holds the specific screen data and properties for the Consent screen, - * processed by `ScreenOverride`. This includes the list of `scopes` being requested - * and the `hideScopes` flag. - * @type {ScreenMembersOnConsent} - * @public - */ - public screen: ScreenMembersOnConsent; - - /** - * Creates an instance of the `Consent` screen manager. - * The constructor initializes the `BaseContext` and sets up the `screen` property - * with an instance of `ScreenOverride` tailored for the consent screen. - * @throws {Error} If the Universal Login Context is not available or if the - * current screen name in the context does not match `Consent.screenIdentifier`. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Submits the user's decision to accept (grant) the requested permissions. - * This method prepares and posts form data to the `/u/consent?state=<transaction_state>` endpoint - * with `action: "accept"`. The transaction state is automatically included in both the - * URL query parameter and the form body. - * - * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs - * to be sent with the request. These parameters will be - * included in the form data submitted to the server. - * @returns {Promise<void>} A promise that resolves once the form submission is initiated. - * Typically, a successful submission leads to a server-side redirect. - * @throws {Error} Throws an error if `FormHandler` encounters an unrecoverable issue - * during submission (e.g., network error). Server-side validation errors - * from Auth0 (like "invalid_request") are not thrown as JavaScript errors - * but are made available in `this.transaction.errors` after the operation. - * @example - * ```typescript - * import Consent from '@auth0/auth0-acul-js/consent'; - * const consentManager = new Consent(); - * const handleAccept = async () => { - * try { - * await consentManager.accept(); - * console.log('Consent accepted successfully.'); - * } catch (err) { - * console.error('Error accepting consent:', err); - * } - * }; - * ``` - */ - async accept(payload?: CustomOptions): Promise<void> { - const formOptions: SDKFormOptions = { - state: this.transaction.state, // For form body - telemetry: [Consent.screenIdentifier, 'accept'] - }; - - const submitPayload = { - ...payload, - action: FormActions.ACCEPT, - }; - - await new FormHandler(formOptions).submitData<typeof submitPayload>(submitPayload); - } - - /** - * Submits the user's decision to deny (reject) the requested permissions. - * This method prepares and posts form data to the `/u/consent?state=<transaction_state>` endpoint - * with `action: "deny"`. The transaction state is automatically included in both the - * URL query parameter and the form body. - * - * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs - * to be sent with the request. These parameters will be - * included in the form data submitted to the server. - * @returns {Promise<void>} A promise that resolves once the form submission is initiated. - * A successful submission usually results in a server-side redirect. - * @throws {Error} Throws an error if `FormHandler` encounters an issue (e.g., network error). - * Server-side validation errors are reflected in `this.transaction.errors`. - * @example - * ```typescript - * import Consent from '@auth0/auth0-acul-js/consent'; - * const consentManager = new Consent(); - * const handleDeny = async () => { - * try { - * await consentManager.deny(); - * console.log('Form denied successfully.'); - * } catch (err) { - * console.error('Failed to deny form:', error); - * } - * }; - */ - async deny(payload?: CustomOptions): Promise<void> { - const formOptions: SDKFormOptions = { - state: this.transaction.state, // For form body - telemetry: [Consent.screenIdentifier, 'deny'] - }; - - const submitPayload = { - ...payload, - action: FormActions.DENY, - }; - - await new FormHandler(formOptions).submitData<typeof submitPayload>(submitPayload); - } -} +import Consent from '@auth0/auth0-acul-js/consent'; +const consentManager = new Consent(); +const handleAccept = async () => { + try { + await consentManager.accept(); + console.log('Consent accepted successfully.'); + } catch (err) { + console.error('Error accepting consent:', err); + } +}; ``` </RequestExample> @@ -133,7 +35,7 @@ export default class Consent extends BaseContext implements ConsentMembers { <ParamField body="Consent" type="Constructor"> {/*> **new Consent**(): `Consent`*/} -Defined in: [src/screens/consent/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/consent/index.ts#L32) +Defined in: [src/screens/consent/index.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/consent/index.ts#L32) Creates an instance of the `Consent` screen manager. The constructor initializes the `BaseContext` and sets up the `screen` property @@ -158,7 +60,7 @@ current screen name in the context does not match `Consent.screenIdentifier`. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -173,7 +75,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -188,7 +90,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -203,7 +105,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -218,7 +120,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent">ScreenMembersOnConsent</a></span>}> {/*> **screen**: [`ScreenMembersOnConsent`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent)*/} -Defined in: [src/screens/consent/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/consent/index.ts#L23) +Defined in: [src/screens/consent/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/consent/index.ts#L23) Holds the specific screen data and properties for the Consent screen, processed by `ScreenOverride`. This includes the list of `scopes` being requested @@ -237,7 +139,7 @@ and the `hideScopes` flag. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -252,7 +154,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -267,7 +169,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -282,7 +184,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -297,7 +199,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.CONSENT`*/} -Defined in: [src/screens/consent/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/consent/index.ts#L14) +Defined in: [src/screens/consent/index.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/consent/index.ts#L14) #### Overrides @@ -309,7 +211,7 @@ Defined in: [src/screens/consent/index.ts:14](https://github.com/auth0/universal <ParamField body='accept' type='Promise<void>'> {/*> **accept**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/consent/index.ts:67](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/consent/index.ts#L67) +Defined in: [src/screens/consent/index.ts:67](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/consent/index.ts#L67) Submits the user's decision to accept (grant) the requested permissions. This method prepares and posts form data to the `/u/consent?state=<transaction_state>` endpoint @@ -364,7 +266,7 @@ const handleAccept = async () => { <ParamField body='deny' type='Promise<void>'> {/*> **deny**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/consent/index.ts:107](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/consent/index.ts#L107) +Defined in: [src/screens/consent/index.ts:107](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/consent/index.ts#L107) Submits the user's decision to deny (reject) the requested permissions. This method prepares and posts form data to the `/u/consent?state=<transaction_state>` endpoint @@ -417,7 +319,7 @@ const handleDeny = async () => { <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/CustomizedConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/CustomizedConsent.mdx index 46acf2d66..6877db3fb 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/CustomizedConsent.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/CustomizedConsent.mdx @@ -2,102 +2,11 @@ title: "CustomizedConsent" --- -Defined in: [src/screens/customized-consent/index.ts:70](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L70) +Defined in: [src/screens/customized-consent/index.ts:70](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L70) CustomizedConsent -<RequestExample> -```ts -export default class CustomizedConsent extends BaseContext implements CustomizedConsentMembers { - /** - * The unique identifier for the Customized Consent screen. - * This static property is used by the SDK's `BaseContext` to ensure that the - * class is instantiated in the correct screen context. - * @type {string} - * static - * @readonly - */ - static screenIdentifier: string = ScreenIds.CUSTOMIZED_CONSENT; - - /** - * Holds the specific screen data and properties for the Customized Consent screen, - * processed by `ScreenOverride`. This includes `scopes` and `authorizationDetails`. - * @type {ScreenMembersOnCustomizedConsent} - * @public - */ - public screen: ScreenMembersOnCustomizedConsent; - - /** - * Creates an instance of the `CustomizedConsent` screen manager. - * The constructor initializes the `BaseContext` and sets up the `screen` property - * with an instance of `ScreenOverride` tailored for the customized consent screen. - * @throws {Error} If the Universal Login Context is not available or if the - * current screen name in the context does not match `CustomizedConsent.screenIdentifier`. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Submits the user's decision to accept (grant) the requested permissions and authorization details. - * This method prepares and posts form data to the `/u/customized-consent?state=<transaction_state>` endpoint - * with `action: "accept"`. The transaction state is automatically included in both the - * URL query parameter and the form body. - * - * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs - * to be sent with the request. These parameters will be - * included in the form data submitted to the server. - * @returns {Promise<void>} A promise that resolves once the form submission is initiated. - * Typically, a successful submission leads to a server-side redirect. - * @throws {Error} Throws an error if `FormHandler` encounters an unrecoverable issue - * during submission (e.g., network error). Server-side validation errors - * from Auth0 (like "invalid_request") are not thrown as JavaScript errors - * but are made available in `this.transaction.errors` after the operation. - */ - async accept(payload?: CustomOptions): Promise<void> { - const formOptions: SDKFormOptions = { - state: this.transaction.state, // For form body - telemetry: [CustomizedConsent.screenIdentifier, 'accept'], - }; - const submitPayload = { - ...payload, - action: FormActions.ACCEPT, - }; - await new FormHandler(formOptions).submitData<typeof submitPayload>(submitPayload); - } - - /** - * Submits the user's decision to deny (reject) the requested permissions and authorization details. - * This method prepares and posts form data to the `/u/customized-consent?state=<transaction_state>` endpoint - * with `action: "deny"`. The transaction state is automatically included in both the - * URL query parameter and the form body. - * - * @param {CustomOptions} [payload] - Optional. An object for any custom key-value pairs - * to be sent with the request. These parameters will be - * included in the form data submitted to the server. - * @returns {Promise<void>} A promise that resolves once the form submission is initiated. - * A successful submission usually results in a server-side redirect. - * @throws {Error} Throws an error if `FormHandler` encounters an issue (e.g., network error). - * Server-side validation errors are reflected in `this.transaction.errors`. - */ - async deny(payload?: CustomOptions): Promise<void> { - const formOptions: SDKFormOptions = { - state: this.transaction.state, // For form body - telemetry: [CustomizedConsent.screenIdentifier, 'deny'], - }; - const submitPayload = { - ...payload, - action: FormActions.DENY, - }; - await new FormHandler(formOptions).submitData<typeof submitPayload>(submitPayload); - } -} -``` -</RequestExample> - ## Example ```typescript @@ -160,7 +69,7 @@ async function onDenyConsent() { <ParamField body="CustomizedConsent" type="Constructor"> {/*> **new CustomizedConsent**(): `CustomizedConsent`*/} -Defined in: [src/screens/customized-consent/index.ts:96](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L96) +Defined in: [src/screens/customized-consent/index.ts:96](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L96) Creates an instance of the `CustomizedConsent` screen manager. The constructor initializes the `BaseContext` and sets up the `screen` property @@ -185,7 +94,7 @@ current screen name in the context does not match `CustomizedConsent.screenIdent <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -200,7 +109,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -215,7 +124,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -230,7 +139,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -245,7 +154,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent">ScreenMembersOnCustomizedConsent</a></span>}> {/*> **screen**: [`ScreenMembersOnCustomizedConsent`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent)*/} -Defined in: [src/screens/customized-consent/index.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L87) +Defined in: [src/screens/customized-consent/index.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L87) Holds the specific screen data and properties for the Customized Consent screen, processed by `ScreenOverride`. This includes `scopes` and `authorizationDetails`. @@ -263,7 +172,7 @@ processed by `ScreenOverride`. This includes `scopes` and `authorizationDetails` <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -278,7 +187,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -293,7 +202,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -308,7 +217,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -323,7 +232,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `readonly` `static` **screenIdentifier**: `string` = `ScreenIds.CUSTOMIZED_CONSENT`*/} -Defined in: [src/screens/customized-consent/index.ts:79](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L79) +Defined in: [src/screens/customized-consent/index.ts:79](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L79) The unique identifier for the Customized Consent screen. This static property is used by the SDK's `BaseContext` to ensure that the @@ -339,7 +248,7 @@ class is instantiated in the correct screen context. <ParamField body='accept' type='Promise<void>'> {/*> **accept**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/customized-consent/index.ts:118](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L118) +Defined in: [src/screens/customized-consent/index.ts:118](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L118) Submits the user's decision to accept (grant) the requested permissions and authorization details. This method prepares and posts form data to the `/u/customized-consent?state=<transaction_state>` endpoint @@ -379,7 +288,7 @@ Throws an error if `FormHandler` encounters an unrecoverable issue <ParamField body='deny' type='Promise<void>'> {/*> **deny**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/customized-consent/index.ts:144](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L144) +Defined in: [src/screens/customized-consent/index.ts:144](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/customized-consent/index.ts#L144) Submits the user's decision to deny (reject) the requested permissions and authorization details. This method prepares and posts form data to the `/u/customized-consent?state=<transaction_state>` endpoint @@ -417,7 +326,7 @@ Throws an error if `FormHandler` encounters an issue (e.g., network error). <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivation.mdx index dc764e4bc..f6858c10d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivation.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivation.mdx @@ -2,7 +2,7 @@ title: "DeviceCodeActivation" --- -Defined in: [src/screens/device-code-activation/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation/index.ts#L12) +Defined in: [src/screens/device-code-activation/index.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-activation/index.ts#L12) Class implementing the Device Code Activation screen functionality. This screen is displayed when the user needs to enter the code on their device to activate it. @@ -10,53 +10,14 @@ This screen is displayed when the user needs to enter the code on their device t <RequestExample> ```ts -export default class DeviceCodeActivation extends BaseContext implements DeviceCodeActivationMembers { - static screenIdentifier: string = ScreenIds.DEVICE_CODE_ACTIVATION; - - /** - * Creates an instance of the DeviceCodeActivation screen. - */ - constructor() { - super(); - } - - /** - * Submits the device code entered by the user. - * This action is triggered when the user enters the code displayed on their device and submits the form. - * - * @param {object} payload - An object containing the code entered by the user and any custom payload. - * @param {string} payload.code - The device code entered by the user. - * - * @returns {Promise<void>} A promise that resolves when the code is successfully submitted. - * @example - * ```typescript - * import DeviceCodeActivation from '@auth0/auth0-acul-js/device-code-activation'; - * const deviceCodeActivationManager = new DeviceCodeActivation(); - * async function activateDeviceCode(code) { - * try { - * await deviceCodeActivationManager.continue({ code }); - * console.log('Device code activation successful.'); - * } catch (error) { - * console.error('Error during device code activation:', error); - * } - * } - * ``` - * Rejects with an error if the submission fails. - */ - async continue(payload: ContinueOptions): Promise<void> { - if (!payload || !payload.code) { - return Promise.reject(new Error('The code parameter is required.')); - } - - const formOptions: FormOptions = { - state: this.transaction.state, - telemetry: [DeviceCodeActivation.screenIdentifier, 'continue'], - }; - - await new FormHandler(formOptions).submitData({ - ...payload, - action: FormActions.DEFAULT, - }); +import DeviceCodeActivation from '@auth0/auth0-acul-js/device-code-activation'; +const deviceCodeActivationManager = new DeviceCodeActivation(); +async function activateDeviceCode(code) { + try { + await deviceCodeActivationManager.continue({ code }); + console.log('Device code activation successful.'); + } catch (error) { + console.error('Error during device code activation:', error); } } ``` @@ -75,7 +36,7 @@ export default class DeviceCodeActivation extends BaseContext implements DeviceC <ParamField body="DeviceCodeActivation" type="Constructor"> {/*> **new DeviceCodeActivation**(): `DeviceCodeActivation`*/} -Defined in: [src/screens/device-code-activation/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation/index.ts#L18) +Defined in: [src/screens/device-code-activation/index.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-activation/index.ts#L18) Creates an instance of the DeviceCodeActivation screen. @@ -93,7 +54,7 @@ Creates an instance of the DeviceCodeActivation screen. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -108,7 +69,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -123,7 +84,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -138,7 +99,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -153,7 +114,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -168,7 +129,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -183,7 +144,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -198,7 +159,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -213,7 +174,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -228,7 +189,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.DEVICE_CODE_ACTIVATION`*/} -Defined in: [src/screens/device-code-activation/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation/index.ts#L13) +Defined in: [src/screens/device-code-activation/index.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-activation/index.ts#L13) #### Overrides @@ -240,7 +201,7 @@ Defined in: [src/screens/device-code-activation/index.ts:13](https://github.com/ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/device-code-activation/index.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation/index.ts#L45) +Defined in: [src/screens/device-code-activation/index.ts:45](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-activation/index.ts#L45) Submits the device code entered by the user. This action is triggered when the user enters the code displayed on their device and submits the form. @@ -284,7 +245,7 @@ Rejects with an error if the submission fails. <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationAllowed.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationAllowed.mdx index d35745a86..dd94db3f0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationAllowed.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationAllowed.mdx @@ -2,27 +2,12 @@ title: "DeviceCodeActivationAllowed" --- -Defined in: [src/screens/device-code-activation-allowed/index.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation-allowed/index.ts#L10) +Defined in: [src/screens/device-code-activation-allowed/index.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-activation-allowed/index.ts#L10) Class implementing the Device Code Activation Allowed screen functionality. This screen is displayed when the device code activation is allowed. -<RequestExample> -```ts -export default class DeviceCodeActivationAllowed extends BaseContext implements DeviceCodeActivationAllowedMembers { - static screenIdentifier: string = ScreenIds.DEVICE_CODE_ACTIVATION_ALLOWED; - - /** - * Creates an instance of DeviceCodeActivationAllowed screen manager. - */ - constructor() { - super(); - } -} -``` -</RequestExample> - ## Extends - `BaseContext` @@ -36,7 +21,7 @@ export default class DeviceCodeActivationAllowed extends BaseContext implements <ParamField body="DeviceCodeActivationAllowed" type="Constructor"> {/*> **new DeviceCodeActivationAllowed**(): `DeviceCodeActivationAllowed`*/} -Defined in: [src/screens/device-code-activation-allowed/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation-allowed/index.ts#L16) +Defined in: [src/screens/device-code-activation-allowed/index.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-activation-allowed/index.ts#L16) Creates an instance of DeviceCodeActivationAllowed screen manager. @@ -54,7 +39,7 @@ Creates an instance of DeviceCodeActivationAllowed screen manager. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -69,7 +54,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -84,7 +69,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -99,7 +84,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -114,7 +99,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -129,7 +114,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -144,7 +129,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -159,7 +144,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -174,7 +159,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -189,7 +174,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.DEVICE_CODE_ACTIVATION_ALLOWED`*/} -Defined in: [src/screens/device-code-activation-allowed/index.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation-allowed/index.ts#L11) +Defined in: [src/screens/device-code-activation-allowed/index.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-activation-allowed/index.ts#L11) #### Overrides @@ -201,7 +186,7 @@ Defined in: [src/screens/device-code-activation-allowed/index.ts:11](https://git <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationDenied.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationDenied.mdx index d30a4377b..7bc71baef 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationDenied.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationDenied.mdx @@ -2,27 +2,12 @@ title: "DeviceCodeActivationDenied" --- -Defined in: [src/screens/device-code-activation-denied/index.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation-denied/index.ts#L10) +Defined in: [src/screens/device-code-activation-denied/index.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-activation-denied/index.ts#L10) Class implementing the Device Code Activation Denied screen functionality. This screen is displayed when the device code activation is denied. -<RequestExample> -```ts -export default class DeviceCodeActivationDenied extends BaseContext implements DeviceCodeActivationDeniedMembers { - static screenIdentifier: string = ScreenIds.DEVICE_CODE_ACTIVATION_DENIED; - - /** - * Creates an instance of DeviceCodeActivationDenied screen manager. - */ - constructor() { - super(); - } -} -``` -</RequestExample> - ## Extends - `BaseContext` @@ -36,7 +21,7 @@ export default class DeviceCodeActivationDenied extends BaseContext implements D <ParamField body="DeviceCodeActivationDenied" type="Constructor"> {/*> **new DeviceCodeActivationDenied**(): `DeviceCodeActivationDenied`*/} -Defined in: [src/screens/device-code-activation-denied/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation-denied/index.ts#L16) +Defined in: [src/screens/device-code-activation-denied/index.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-activation-denied/index.ts#L16) Creates an instance of DeviceCodeActivationDenied screen manager. @@ -54,7 +39,7 @@ Creates an instance of DeviceCodeActivationDenied screen manager. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -69,7 +54,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -84,7 +69,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -99,7 +84,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -114,7 +99,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -129,7 +114,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -144,7 +129,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -159,7 +144,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -174,7 +159,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -189,7 +174,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.DEVICE_CODE_ACTIVATION_DENIED`*/} -Defined in: [src/screens/device-code-activation-denied/index.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-activation-denied/index.ts#L11) +Defined in: [src/screens/device-code-activation-denied/index.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-activation-denied/index.ts#L11) #### Overrides @@ -201,7 +186,7 @@ Defined in: [src/screens/device-code-activation-denied/index.ts:11](https://gith <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeConfirmation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeConfirmation.mdx index 1b4e8cd79..9a71f8ea4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeConfirmation.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeConfirmation.mdx @@ -2,7 +2,7 @@ title: "DeviceCodeConfirmation" --- -Defined in: [src/screens/device-code-confirmation/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L19) +Defined in: [src/screens/device-code-confirmation/index.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L19) Class implementing the Device Code Confirmation screen functionality. This screen is displayed when the user needs to confirm the device code. @@ -10,57 +10,10 @@ This screen is displayed when the user needs to confirm the device code. <RequestExample> ```ts -export default class DeviceCodeConfirmation extends BaseContext implements DeviceCodeConfirmationMembers { - static screenIdentifier: string = ScreenIds.DEVICE_CODE_CONFIRMATION; - screen: screenOptions; - - /** - * Creates an instance of the DeviceCodeConfirmation screen. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Confirms the device code. - * @param payload Optional custom options to include with the request. - * @example - * ```typescript - * import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation'; - * - * const deviceCodeConfirmation = new DeviceCodeConfirmation(); - * await deviceCodeConfirmation.confirm(); - * ``` - */ - async confirm(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [DeviceCodeConfirmation.screenIdentifier, FormActions.CONFIRM], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.CONFIRM }); - } - - /** - * Cancels the device code flow. - * @param payload Optional custom options to include with the request. - * @example - * ```typescript - * import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation'; - * - * const deviceCodeConfirmation = new DeviceCodeConfirmation(); - * await deviceCodeConfirmation.cancel(); - * ``` - */ - async cancel(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [DeviceCodeConfirmation.screenIdentifier, FormActions.CANCEL], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.CANCEL }); - } -} +import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation'; + +const deviceCodeConfirmation = new DeviceCodeConfirmation(); +await deviceCodeConfirmation.confirm(); ``` </RequestExample> @@ -77,7 +30,7 @@ export default class DeviceCodeConfirmation extends BaseContext implements Devic <ParamField body="DeviceCodeConfirmation" type="Constructor"> {/*> **new DeviceCodeConfirmation**(): `DeviceCodeConfirmation`*/} -Defined in: [src/screens/device-code-confirmation/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L26) +Defined in: [src/screens/device-code-confirmation/index.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L26) Creates an instance of the DeviceCodeConfirmation screen. @@ -95,7 +48,7 @@ Creates an instance of the DeviceCodeConfirmation screen. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -110,7 +63,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -125,7 +78,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -140,7 +93,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -155,7 +108,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation">ScreenMembersOnDeviceCodeConfirmation</a></span>}> {/*> **screen**: [`ScreenMembersOnDeviceCodeConfirmation`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation)*/} -Defined in: [src/screens/device-code-confirmation/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L21) +Defined in: [src/screens/device-code-confirmation/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L21) #### Implementation of @@ -170,7 +123,7 @@ Defined in: [src/screens/device-code-confirmation/index.ts:21](https://github.co <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -185,7 +138,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -200,7 +153,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -215,7 +168,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -230,7 +183,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.DEVICE_CODE_CONFIRMATION`*/} -Defined in: [src/screens/device-code-confirmation/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L20) +Defined in: [src/screens/device-code-confirmation/index.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L20) #### Overrides @@ -242,7 +195,7 @@ Defined in: [src/screens/device-code-confirmation/index.ts:20](https://github.co <ParamField body='cancel' type='Promise<void>'> {/*> **cancel**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/device-code-confirmation/index.ts:62](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L62) +Defined in: [src/screens/device-code-confirmation/index.ts:62](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L62) Cancels the device code flow. @@ -276,7 +229,7 @@ await deviceCodeConfirmation.cancel(); <ParamField body='confirm' type='Promise<void>'> {/*> **confirm**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/device-code-confirmation/index.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L43) +Defined in: [src/screens/device-code-confirmation/index.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-confirmation/index.ts#L43) Confirms the device code. @@ -310,7 +263,7 @@ await deviceCodeConfirmation.confirm(); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailIdentifierChallenge.mdx index b117d3c09..a9a195412 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailIdentifierChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailIdentifierChallenge.mdx @@ -2,106 +2,16 @@ title: "EmailIdentifierChallenge" --- -Defined in: [src/screens/email-identifier-challenge/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L18) +Defined in: [src/screens/email-identifier-challenge/index.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L18) <RequestExample> ```ts -export default class EmailIdentifierChallenge extends BaseContext implements EmailIdentifierChallengeMembers { - screen: ScreenOptions; - static screenIdentifier: string = ScreenIds.EMAIL_IDENTIFIER_CHALLENGE; - - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * @example - * import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; - * - * const emailIdentifierChallenge = new EmailIdentifierChallenge(); - * emailIdentifierChallenge.submitEmailChallenge({ - * code: "<string>" - * }); - */ - async submitEmailChallenge(payload: EmailChallengeOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [EmailIdentifierChallenge.screenIdentifier, 'submitEmailChallenge'], - }; - await new FormHandler(options).submitData(payload); - } - - /** - * @example - * import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; - * - * const emailIdentifierChallenge = new EmailIdentifierChallenge(); - * emailIdentifierChallenge.resendCode(); - */ - async resendCode(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [EmailIdentifierChallenge.screenIdentifier, 'resendCode'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND_CODE }); - } - - /** - * @example - * import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; - * - * const emailIdentifierChallenge = new EmailIdentifierChallenge(); - * emailIdentifierChallenge.returnToPrevious(); - */ - async returnToPrevious(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [EmailIdentifierChallenge.screenIdentifier, 'returnToPrevious'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.BACK }); - } - /** - * Gets resend functionality with timeout management for this screen - * @param options - Configuration options for resend functionality - * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) - * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) - * @param options.onTimeout - Callback to execute when timeout countdown reaches zero - * @returns ResendControl object with startResend method - * @utilityFeature - * - * @example - * import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; - * const handleStatusChange = (remainingSeconds, isDisabled) => { - * setDisabled(isDisabled); - * setRemaining(remainingSeconds); - * }; - * - * const handleTimeout = () => { - * console.log('Timeout completed, resend is now available'); - * }; - * - * const { startResend } = emailChallenge.resendManager({ - * timeoutSeconds: 15, - * onStatusChange: handleStatusChange, - * onTimeout: handleTimeout - * }); - * - * // Call startResend when user clicks resend button - * await startResend(); - * - */ - resendManager(options?: StartResendOptions): ResendControl { - return createResendControl( - EmailIdentifierChallenge.screenIdentifier, - () => this.resendCode(), - options, - !!this.screen.data?.resendLimitReached - ); - } -} +import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; +const emailIdentifierChallenge = new EmailIdentifierChallenge(); +emailIdentifierChallenge.submitEmailChallenge({ + code: "<string>" +}); ``` </RequestExample> @@ -118,7 +28,7 @@ export default class EmailIdentifierChallenge extends BaseContext implements Ema <ParamField body="EmailIdentifierChallenge" type="Constructor"> {/*> **new EmailIdentifierChallenge**(): `EmailIdentifierChallenge`*/} -Defined in: [src/screens/email-identifier-challenge/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L22) +Defined in: [src/screens/email-identifier-challenge/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L22) #### Returns @@ -134,7 +44,7 @@ Defined in: [src/screens/email-identifier-challenge/index.ts:22](https://github. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -149,7 +59,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -164,7 +74,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -179,7 +89,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -194,7 +104,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge">ScreenMembersOnEmailIdentifierChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnEmailIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge)*/} -Defined in: [src/screens/email-identifier-challenge/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L19) +Defined in: [src/screens/email-identifier-challenge/index.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L19) #### Implementation of @@ -209,7 +119,7 @@ Defined in: [src/screens/email-identifier-challenge/index.ts:19](https://github. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -224,7 +134,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -239,7 +149,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -254,7 +164,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -269,7 +179,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.EMAIL_IDENTIFIER_CHALLENGE`*/} -Defined in: [src/screens/email-identifier-challenge/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L20) +Defined in: [src/screens/email-identifier-challenge/index.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L20) #### Overrides @@ -281,7 +191,7 @@ Defined in: [src/screens/email-identifier-challenge/index.ts:20](https://github. <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -300,7 +210,7 @@ An array of error objects from the transaction context. <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/email-identifier-challenge/index.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L52) +Defined in: [src/screens/email-identifier-challenge/index.ts:52](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L52) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -330,7 +240,7 @@ emailIdentifierChallenge.resendCode(); <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [src/screens/email-identifier-challenge/index.ts:104](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L104) +Defined in: [src/screens/email-identifier-challenge/index.ts:104](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L104) **`Utility Feature`** @@ -382,7 +292,7 @@ import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-chal <ParamField body='returnToPrevious' type='Promise<void>'> {/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/email-identifier-challenge/index.ts:67](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L67) +Defined in: [src/screens/email-identifier-challenge/index.ts:67](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L67) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -412,7 +322,7 @@ emailIdentifierChallenge.returnToPrevious(); <ParamField body='submitEmailChallenge' type='Promise<void>'> {/*> **submitEmailChallenge**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/email-identifier-challenge/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L37) +Defined in: [src/screens/email-identifier-challenge/index.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L37) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions">EmailChallengeOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailOTPChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailOTPChallenge.mdx index 32913a042..8f682e007 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailOTPChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailOTPChallenge.mdx @@ -2,107 +2,19 @@ title: "EmailOTPChallenge" --- -Defined in: [src/screens/email-otp-challenge/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L14) +Defined in: [src/screens/email-otp-challenge/index.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L14) Represents the Email OTP Challenge screen. <RequestExample> ```ts -export default class EmailOTPChallenge extends BaseContext implements EmailOTPChallengeMembers { - static screenIdentifier: string = ScreenIds.EMAIL_OTP_CHALLENGE; - - constructor() { - super(); - } - - /** - * Submits the OTP code entered by the user. - * @param options Optional parameters to include in the submission. - * @example - * ```typescript - * import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge'; - * - * const emailOTPChallenge = new EmailOTPChallenge(); - * emailOTPChallenge.submitCode({ - * code: '123456', - * }); - * ``` - */ - async submitCode(options: OtpCodeOptions): Promise<void> { - const formOptions: FormOptions = { - state: this.transaction.state, - telemetry: [EmailOTPChallenge.screenIdentifier, 'submitCode'], - }; - const payload = { - ...options, - action: FormActions.DEFAULT, - }; - - await new FormHandler(formOptions).submitData(payload); - } - - /** - * Requests a new OTP code to be sent to the user's email. - * @param options Optional parameters to include in the resend request. - * @example - * ```typescript - * import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge'; - * - * const emailOTPChallenge = new EmailOTPChallenge(); - * emailOTPChallenge.resendCode(); - * ``` - */ - async resendCode(options?: CustomOptions): Promise<void> { - const formOptions: FormOptions = { - state: this.transaction.state, - telemetry: [EmailOTPChallenge.screenIdentifier, 'resendCode'], - }; - - const payload = { - ...options, - action: FormActions.RESEND_CODE, - }; - - await new FormHandler(formOptions).submitData(payload); - } +import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge'; - /** - * Gets resend functionality with timeout management for this screen - * @param options - Configuration options for resend functionality - * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) - * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) - * @param options.onTimeout - Callback to execute when timeout countdown reaches zero - * @returns ResendControl object with startResend method - * @utilityFeature - * - * @example - * ```typescript - * import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge'; - * - * const emailOTPChallenge = new EmailOTPChallenge(); - * const { startResend } = emailOTPChallenge.resendManager({ - * timeoutSeconds: 15, - * onStatusChange: (remainingSeconds, isDisabled) => { - * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); - * }, - * onTimeout: () => { - * console.log('Resend is now available'); - * } - * }); - * - * // Call startResend when user clicks resend button - * startResend(); - * ``` - */ - resendManager(options?: StartResendOptions): ResendControl { - return createResendControl( - EmailOTPChallenge.screenIdentifier, - () => this.resendCode(), - options - ); - } -} +const emailOTPChallenge = new EmailOTPChallenge(); +emailOTPChallenge.submitCode({ + code: '123456', +}); ``` </RequestExample> @@ -119,7 +31,7 @@ export default class EmailOTPChallenge extends BaseContext implements EmailOTPCh <ParamField body="EmailOTPChallenge" type="Constructor"> {/*> **new EmailOTPChallenge**(): `EmailOTPChallenge`*/} -Defined in: [src/screens/email-otp-challenge/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L17) +Defined in: [src/screens/email-otp-challenge/index.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L17) #### Returns @@ -135,7 +47,7 @@ Defined in: [src/screens/email-otp-challenge/index.ts:17](https://github.com/aut <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -150,7 +62,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -165,7 +77,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -180,7 +92,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -195,7 +107,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -210,7 +122,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -225,7 +137,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -240,7 +152,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -255,7 +167,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -270,7 +182,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.EMAIL_OTP_CHALLENGE`*/} -Defined in: [src/screens/email-otp-challenge/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L15) +Defined in: [src/screens/email-otp-challenge/index.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L15) #### Overrides @@ -282,7 +194,7 @@ Defined in: [src/screens/email-otp-challenge/index.ts:15](https://github.com/aut <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -301,7 +213,7 @@ An array of error objects from the transaction context. <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`options?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/email-otp-challenge/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L58) +Defined in: [src/screens/email-otp-challenge/index.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L58) Requests a new OTP code to be sent to the user's email. @@ -335,7 +247,7 @@ emailOTPChallenge.resendCode(); <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [src/screens/email-otp-challenge/index.ts:100](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L100) +Defined in: [src/screens/email-otp-challenge/index.ts:100](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L100) **`Utility Feature`** @@ -384,7 +296,7 @@ startResend(); <ParamField body='submitCode' type='Promise<void>'> {/*> **submitCode**(`options`): `Promise`\<`void`\>*/} -Defined in: [src/screens/email-otp-challenge/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L34) +Defined in: [src/screens/email-otp-challenge/index.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L34) Submits the OTP code entered by the user. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailVerificationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailVerificationResult.mdx index 79f711855..6aa9a54e5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailVerificationResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailVerificationResult.mdx @@ -2,45 +2,11 @@ title: "EmailVerificationResult" --- -Defined in: [src/screens/email-verification-result/index.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-verification-result/index.ts#L38) +Defined in: [src/screens/email-verification-result/index.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-verification-result/index.ts#L38) EmailVerificationResult -<RequestExample> -```ts -export default class EmailVerificationResult extends BaseContext implements EmailVerificationResultMembers { - /** - * static - * @property {string} screenIdentifier - The unique identifier for the Email Verification Result screen. - * This identifier is used by `BaseContext` to ensure the correct screen class is instantiated. - */ - static screenIdentifier: string = ScreenIds.EMAIL_VERIFICATION_RESULT; - - /** - * @property {ScreenOptions} screen - Holds the specific screen data and properties for the - * This includes the verification status and the login link. - */ - screen: ScreenOptions; - - /** - * Initializes a new instance of the `EmailVerificationResult` class. - * It retrieves the screen-specific context and sets up the `screen` property - * @throws {Error} If the Universal Login Context is not available or if the - * current screen name in the context does not match `EmailVerificationResult.screenIdentifier`. - */ - constructor() { - super(); // Calls BaseContext constructor for global context initialization and validation. - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - // This screen is informational. No specific operations like form submissions are defined. - // Users will typically navigate away using the `loginLink` provided in `this.screen.loginLink`. -} -``` -</RequestExample> - ## Example ```typescript @@ -73,7 +39,7 @@ if (loginLink) { <ParamField body="EmailVerificationResult" type="Constructor"> {/*> **new EmailVerificationResult**(): `EmailVerificationResult`*/} -Defined in: [src/screens/email-verification-result/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-verification-result/index.ts#L58) +Defined in: [src/screens/email-verification-result/index.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-verification-result/index.ts#L58) Initializes a new instance of the `EmailVerificationResult` class. It retrieves the screen-specific context and sets up the `screen` property @@ -97,7 +63,7 @@ current screen name in the context does not match `EmailVerificationResult.scree <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -112,7 +78,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -127,7 +93,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -142,7 +108,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -157,7 +123,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult">ScreenMembersOnEmailVerificationResult</a></span>}> {/*> **screen**: [`ScreenMembersOnEmailVerificationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult)*/} -Defined in: [src/screens/email-verification-result/index.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-verification-result/index.ts#L50) +Defined in: [src/screens/email-verification-result/index.ts:50](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-verification-result/index.ts#L50) #### Implementation of @@ -172,7 +138,7 @@ Defined in: [src/screens/email-verification-result/index.ts:50](https://github.c <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -187,7 +153,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -202,7 +168,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -217,7 +183,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -232,7 +198,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.EMAIL_VERIFICATION_RESULT`*/} -Defined in: [src/screens/email-verification-result/index.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/email-verification-result/index.ts#L44) +Defined in: [src/screens/email-verification-result/index.ts:44](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-verification-result/index.ts#L44) static @@ -246,7 +212,7 @@ static <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/InterstitialCaptcha.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/InterstitialCaptcha.mdx index 5fd00ff04..c7db19d66 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/InterstitialCaptcha.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/InterstitialCaptcha.mdx @@ -2,37 +2,16 @@ title: "InterstitialCaptcha" --- -Defined in: [src/screens/interstitial-captcha/index.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/interstitial-captcha/index.ts#L8) +Defined in: [src/screens/interstitial-captcha/index.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/interstitial-captcha/index.ts#L8) <RequestExample> ```ts -export default class InterstitialCaptcha extends BaseContext implements InterstitialCaptchaMembers { - static screenIdentifier: string = ScreenIds.INTERSTITIAL_CAPTCHA; - - constructor() { - super(); - } - /** - * @remarks - * This methods handles InterstitialCaptcha related configuration. - * - * @example - * import InterstitialCaptcha from "@auth0/auth0-acul-js/interstitial-captcha"; - * - * const interstitialCaptcha = new InterstitialCaptcha(); - * interstitialCaptcha.submitCaptcha({ - * captcha: "captchaValue", - * }); - */ - async submitCaptcha(payload: SubmitCaptchaOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [InterstitialCaptcha.screenIdentifier, 'submitCaptcha'], - }; - await new FormHandler(options).submitData<SubmitCaptchaOptions>(payload); - } -} +import InterstitialCaptcha from "@auth0/auth0-acul-js/interstitial-captcha"; +const interstitialCaptcha = new InterstitialCaptcha(); +interstitialCaptcha.submitCaptcha({ + captcha: "captchaValue", +}); ``` </RequestExample> @@ -49,7 +28,7 @@ export default class InterstitialCaptcha extends BaseContext implements Intersti <ParamField body="InterstitialCaptcha" type="Constructor"> {/*> **new InterstitialCaptcha**(): `InterstitialCaptcha`*/} -Defined in: [src/screens/interstitial-captcha/index.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/interstitial-captcha/index.ts#L11) +Defined in: [src/screens/interstitial-captcha/index.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/interstitial-captcha/index.ts#L11) #### Returns @@ -65,7 +44,7 @@ Defined in: [src/screens/interstitial-captcha/index.ts:11](https://github.com/au <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -80,7 +59,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -95,7 +74,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -110,7 +89,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -125,7 +104,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -140,7 +119,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -155,7 +134,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -170,7 +149,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -185,7 +164,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -200,7 +179,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.INTERSTITIAL_CAPTCHA`*/} -Defined in: [src/screens/interstitial-captcha/index.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/interstitial-captcha/index.ts#L9) +Defined in: [src/screens/interstitial-captcha/index.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/interstitial-captcha/index.ts#L9) #### Overrides @@ -212,7 +191,7 @@ Defined in: [src/screens/interstitial-captcha/index.ts:9](https://github.com/aut <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -231,7 +210,7 @@ An array of error objects from the transaction context. <ParamField body='submitCaptcha' type='Promise<void>'> {/*> **submitCaptcha**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/interstitial-captcha/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/interstitial-captcha/index.ts#L26) +Defined in: [src/screens/interstitial-captcha/index.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/interstitial-captcha/index.ts#L26) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions">SubmitCaptchaOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Login.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Login.mdx index 0dcee4130..a10885d70 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Login.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Login.mdx @@ -2,101 +2,19 @@ title: "Login" --- -Defined in: [src/screens/login/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L26) +Defined in: [src/screens/login/index.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login/index.ts#L26) Login screen implementation class <RequestExample> ```ts -export default class Login extends BaseContext implements LoginMembers { - static screenIdentifier: string = ScreenIds.LOGIN; - screen: ScreenOptions; - transaction: TransactionOptions; - - /** - * Creates an instance of Login screen manager - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - const transactionContext = this.getContext('transaction') as TransactionContext; - this.screen = new ScreenOverride(screenContext); - this.transaction = new TransactionOverride(transactionContext); - } - - /** - * Performs login with username/password - * @param payload The login options containing username and password - * @example - * ```typescript - * import Login from "@auth0/auth0-acul-js/login"; - * const loginManager = new Login(); - * loginManager.login({ - * username: "testUser", - * password: "testPassword" - * }); - * ``` - */ - async login(payload: LoginOptions): Promise<void> { - const options: FormOptions = { state: this.transaction.state, telemetry: [Login.screenIdentifier, 'login'] }; - await new FormHandler(options).submitData<LoginOptions>(payload); - } - - /** - * Performs login with social provider - * @param payload The social login options containing connection name - * @example - * ```typescript - * import Login from "@auth0/auth0-acul-js/login"; - * const loginManager = new Login(); - * loginManager.federatedLogin({ - * connection: "google-oauth2" - * }); - * ``` - */ - async federatedLogin(payload: FederatedLoginOptions): Promise<void> { - const options: FormOptions = { state: this.transaction.state, telemetry: [Login.screenIdentifier, 'federatedLogin'] }; - await new FormHandler(options).submitData<FederatedLoginOptions>(payload); - } - - /** - * Picks country code for phone number input - * @param payload Optional custom options - * @example - * ```typescript - * import Login from "@auth0/auth0-acul-js/login"; - * const loginManager = new Login(); - * loginManager.pickCountryCode(); - * ``` - */ - async pickCountryCode(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [Login.screenIdentifier, 'pickCountryCode'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_COUNTRY_CODE, - }); - } - - /** - * Gets the active identifier types for the login screen - * @returns An array of active identifier types or null if none are active - * @example - * ```typescript - * import Login from "@auth0/auth0-acul-js/login"; - * const loginManager = new Login(); - * loginManager.getLoginIdentifiers(); - * ``` - * @utilityFeature - */ - getLoginIdentifiers(): IdentifierType[] | null { - return _getLoginIdentifiers(this.transaction.allowedIdentifiers); - } -} +import Login from "@auth0/auth0-acul-js/login"; +const loginManager = new Login(); +loginManager.login({ + username: "testUser", + password: "testPassword" +}); ``` </RequestExample> @@ -113,7 +31,7 @@ export default class Login extends BaseContext implements LoginMembers { <ParamField body="Login" type="Constructor"> {/*> **new Login**(): `Login`*/} -Defined in: [src/screens/login/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L34) +Defined in: [src/screens/login/index.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login/index.ts#L34) Creates an instance of Login screen manager @@ -131,7 +49,7 @@ Creates an instance of Login screen manager <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -146,7 +64,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -161,7 +79,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -176,7 +94,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -191,7 +109,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin">ScreenMembersOnLogin</a></span>}> {/*> **screen**: [`ScreenMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin)*/} -Defined in: [src/screens/login/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L28) +Defined in: [src/screens/login/index.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login/index.ts#L28) #### Implementation of @@ -206,7 +124,7 @@ Defined in: [src/screens/login/index.ts:28](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -221,7 +139,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin">TransactionMembersOnLogin</a></span>}> {/*> **transaction**: [`TransactionMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin)*/} -Defined in: [src/screens/login/index.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L29) +Defined in: [src/screens/login/index.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login/index.ts#L29) #### Implementation of @@ -236,7 +154,7 @@ Defined in: [src/screens/login/index.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -251,7 +169,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -266,7 +184,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGIN`*/} -Defined in: [src/screens/login/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L27) +Defined in: [src/screens/login/index.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login/index.ts#L27) #### Overrides @@ -278,7 +196,7 @@ Defined in: [src/screens/login/index.ts:27](https://github.com/auth0/universal-l <ParamField body='federatedLogin' type='Promise<void>'> {/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login/index.ts:72](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L72) +Defined in: [src/screens/login/index.ts:72](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login/index.ts#L72) Performs login with social provider @@ -313,7 +231,7 @@ loginManager.federatedLogin({ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -332,7 +250,7 @@ An array of error objects from the transaction context. <ParamField body='getLoginIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType">ScreenIdentifierType</a>[]</span>}> {/*> **getLoginIdentifiers**(): [`ScreenIdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType)[] \| `null`*/} -Defined in: [src/screens/login/index.ts:110](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L110) +Defined in: [src/screens/login/index.ts:110](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login/index.ts#L110) **`Utility Feature`** @@ -361,7 +279,7 @@ loginManager.getLoginIdentifiers(); <ParamField body='login' type='Promise<void>'> {/*> **login**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login/index.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L55) +Defined in: [src/screens/login/index.ts:55](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login/index.ts#L55) Performs login with username/password @@ -397,7 +315,7 @@ loginManager.login({ <ParamField body='pickCountryCode' type='Promise<void>'> {/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login/index.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login/index.ts#L87) +Defined in: [src/screens/login/index.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login/index.ts#L87) Picks country code for phone number input diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginEmailVerification.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginEmailVerification.mdx index 53f0e384c..7a782d68f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginEmailVerification.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginEmailVerification.mdx @@ -2,7 +2,7 @@ title: "LoginEmailVerification" --- -Defined in: [src/screens/login-email-verification/index.ts:77](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L77) +Defined in: [src/screens/login-email-verification/index.ts:77](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L77) LoginEmailVerification classdesc Manages interactions for the "login-email-verification" screen. @@ -18,159 +18,14 @@ transaction state, client information, and internationalization texts. <RequestExample> ```ts -export default class LoginEmailVerification extends BaseContext implements LoginEmailVerificationMembers { - /** - * The unique identifier for the Login Email Verification screen. - * This static property is used by the SDK's `BaseContext` to ensure that the - * class is instantiated in the correct screen context. - * @type {string} - * static - * @readonly - */ - static screenIdentifier: string = ScreenIds.LOGIN_EMAIL_VERIFICATION; - - /** - * Creates an instance of the `LoginEmailVerification` screen manager. - * The constructor initializes the `BaseContext`, which involves parsing the - */ - constructor() { - super(); - } - - /** - * Submits the email verification code entered by the user to Auth0. - * This method prepares and posts the form data, including the verification code - * and the required `action: "default"`, to the `/u/login-email-verification` endpoint. - * - * @param {ContinueWithCodeOptions} payload - An object containing the `code` (string) - * entered by the user. May also contain - * other custom parameters if needed. - * @returns {Promise<void>} A promise that resolves once the form submission is initiated. - * Typically, a successful submission leads to a server-side redirect. - * If the code is incorrect or an error occurs, the page will - * re-render, and `this.transaction.errors` will be populated. - * @throws {Error} If the `payload.code` is missing or not a string. It can also - * throw if `FormHandler` encounters an issue during submission (e.g. network error). - * Auth0 validation errors (e.g. "invalid-code") are not thrown as JS errors - * but are made available in `this.transaction.errors` post-operation. - * - * @example - * ```typescript - * const manager = new LoginEmailVerification(); - * // Assuming 'userInputCode' is a string obtained from a form input - * manager.continueWithCode({ code: userInputCode }) - * .catch(err => { - * // Handle unexpected submission errors - * displayGlobalError("Could not submit your code. Please try again."); - * }); - * // After the operation, check manager.transaction.errors for validation messages. - * ``` - */ - async continueWithCode(payload: ContinueWithCodeOptions): Promise<void> { - if (!payload || typeof payload.code !== 'string') { - throw new Error('The `code` property in the payload is required and must be a string.'); - } - - const formOptions: InternalFormOptions = { - state: this.transaction.state, - telemetry: [LoginEmailVerification.screenIdentifier, 'continueWithCode'] - }; - - // Prepare the data to be submitted. - // The `action: "default"` signals the server to process the code. - const submitPayload = { - ...payload, // Includes the 'code' and any other custom options passed in. - action: FormActions.DEFAULT, - }; - - // Use FormHandler to submit the data. - await new FormHandler(formOptions).submitData<typeof submitPayload>(submitPayload); - } - - /** - * Requests Auth0 to send a new verification code to the user's email address. - * This is typically used when the user didn't receive the original code, or it has expired. - * This method posts form data with `action: "resend-code"` to the - * `/u/login-email-verification` endpoint. - * - * @param {ResendCodeOptions} [payload] - Optional. An object for any custom parameters - * to be sent with the resend request. - * @returns {Promise<void>} A promise that resolves once the resend request is initiated. - * A successful request usually means a new email is dispatched. - * The page might re-render, and `this.transaction.errors` could - * be updated if, for example, rate limits (`too-many-emails`) are hit. - * @throws {Error} If `FormHandler` encounters an issue (e.g. network error). - * Server-side validation errors (e.g. rate limits) are not thrown - * as JS errors but are made available in `this.transaction.errors`. - * - * @example - * ```typescript - * const manager = new LoginEmailVerification(); - * manager.resendCode() - * .then(() => { - * // Inform the user that a new code has been sent. - * showNotification("A new verification code is on its way!"); - * }) - * .catch(err => { - * // Handle unexpected submission errors - * displayGlobalError("Could not request a new code. Please try again later."); - * }); - * // After the operation, check manager.transaction.errors for specific issues. - * ``` - */ - async resendCode(payload?: ResendCodeOptions): Promise<void> { - const formOptions: InternalFormOptions = { - state: this.transaction.state, - telemetry: [LoginEmailVerification.screenIdentifier, 'resendCode'] - }; - - // Prepare the data for resending the code. - // The `action: "resend-code"` signals the server to dispatch a new code. - const submitPayload = { - ...payload, // Includes any custom options passed in. - action: FormActions.RESEND_CODE, - }; - - // Use FormHandler to submit the data. - await new FormHandler(formOptions).submitData<typeof submitPayload>(submitPayload); - } - - /** - * Gets resend functionality with timeout management for this screen - * @param options - Configuration options for resend functionality - * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) - * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) - * @param options.onTimeout - Callback to execute when timeout countdown reaches zero - * @returns ResendControl object with startResend method - * @utilityFeature - * - * @example - * ```typescript - * import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification'; - * - * const loginEmailVerification = new LoginEmailVerification(); - * const { startResend } = loginEmailVerification.resendManager({ - * timeoutSeconds: 15, - * onStatusChange: (remainingSeconds, isDisabled) => { - * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); - * }, - * onTimeout: () => { - * console.log('Resend is now available'); - * } - * }); - * - * // Call startResend when user clicks resend button - * startResend(); - * ``` - */ - resendManager(options?: StartResendOptions): ResendControl { - return createResendControl( - LoginEmailVerification.screenIdentifier, - () => this.resendCode(), - options - ); - } -} +const manager = new LoginEmailVerification(); +// Assuming 'userInputCode' is a string obtained from a form input +manager.continueWithCode({ code: userInputCode }) + .catch(err => { + // Handle unexpected submission errors + displayGlobalError("Could not submit your code. Please try again."); + }); +// After the operation, check manager.transaction.errors for validation messages. ``` </RequestExample> @@ -236,7 +91,7 @@ async function onResendCodeClick() { <ParamField body="LoginEmailVerification" type="Constructor"> {/*> **new LoginEmailVerification**(): `LoginEmailVerification`*/} -Defined in: [src/screens/login-email-verification/index.ts:92](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L92) +Defined in: [src/screens/login-email-verification/index.ts:92](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L92) Creates an instance of the `LoginEmailVerification` screen manager. The constructor initializes the `BaseContext`, which involves parsing the @@ -255,7 +110,7 @@ The constructor initializes the `BaseContext`, which involves parsing the <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -270,7 +125,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -285,7 +140,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -300,7 +155,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -315,7 +170,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -330,7 +185,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -345,7 +200,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -360,7 +215,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -375,7 +230,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -390,7 +245,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `readonly` `static` **screenIdentifier**: `string` = `ScreenIds.LOGIN_EMAIL_VERIFICATION`*/} -Defined in: [src/screens/login-email-verification/index.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L86) +Defined in: [src/screens/login-email-verification/index.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L86) The unique identifier for the Login Email Verification screen. This static property is used by the SDK's `BaseContext` to ensure that the @@ -406,7 +261,7 @@ class is instantiated in the correct screen context. <ParamField body='continueWithCode' type='Promise<void>'> {/*> **continueWithCode**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login-email-verification/index.ts:125](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L125) +Defined in: [src/screens/login-email-verification/index.ts:125](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L125) Submits the email verification code entered by the user to Auth0. This method prepares and posts the form data, including the verification code @@ -460,7 +315,7 @@ manager.continueWithCode({ code: userInputCode }) <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -479,7 +334,7 @@ An array of error objects from the transaction context. <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login-email-verification/index.ts:177](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L177) +Defined in: [src/screens/login-email-verification/index.ts:177](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L177) Requests Auth0 to send a new verification code to the user's email address. This is typically used when the user didn't receive the original code, or it has expired. @@ -535,7 +390,7 @@ manager.resendCode() <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [src/screens/login-email-verification/index.ts:222](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L222) +Defined in: [src/screens/login-email-verification/index.ts:222](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L222) **`Utility Feature`** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginId.mdx index a2ae27a51..5a8c5407d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginId.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginId.mdx @@ -2,252 +2,14 @@ title: "LoginId" --- -Defined in: [src/screens/login-id/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L26) +Defined in: [src/screens/login-id/index.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-id/index.ts#L26) <RequestExample> ```ts -export default class LoginId extends BaseContext implements LoginIdMembers { - static screenIdentifier: string = ScreenIds.LOGIN_ID; - #passkeyController?: AbortController; - #isConditionalUIRegistered = false; - screen: ScreenOptions; - transaction: TransactionOptions; - - /** - * Creates an instance of LoginIdManager. - */ - constructor() { - super(); - - const screenContext = this.getContext('screen') as ScreenContext; - const transactionContext = this.getContext('transaction') as TransactionContext; - - // Add the properties specific to the prompt. - this.screen = new ScreenOverride(screenContext); - this.transaction = new TransactionOverride(transactionContext); - } - - /** - * @example - * - * import LoginId from "@auth0/auth0-acul-js/login-id"; - * - * const loginIdManager = new LoginId(); - * - * loginIdManager.login({ - * username: <usernameFieldValue> - * }); - */ - async login(payload: LoginOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [LoginId.screenIdentifier, 'login'], - }; - - const browserCapabilities = await getBrowserCapabilities(); - await new FormHandler(options).submitData<LoginOptions>({ - ...payload, - ...browserCapabilities - }); - } - - /** - * @example - * import LoginId from "@auth0/auth0-acul-js/login-id"; - * const loginIdManager = new LoginId(); - * - * // Check if alternateConnections is available and has at least one item - * if (!loginIdManager.transaction.alternateConnections) { - * console.error('No alternate connections available.'); - * } - * - * // Select the first available connection (users can select any available connection) - * const selectedConnection = alternateConnections[0]; - * - * // Log the chosen connection for debugging or informational purposes - * console.log(`Selected connection: ${selectedConnection.name}`); - * - * // Proceed with federated login using the selected connection - * loginIdManager.federatedLogin({ - * connection: selectedConnection.name, - * }); - */ - async federatedLogin(payload: FederatedLoginOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [LoginId.screenIdentifier, 'federatedLogin'], - }; - - await new FormHandler(options).submitData<FederatedLoginOptions>(payload); - } - - /** - * @example - * import LoginId from "@auth0/auth0-acul-js/login-id"; - * const loginIdManager = new LoginId(); - * - * // It internally maps users available passkey config provided from auth0 server - * loginIdManager.passkeyLogin(); - */ - async passkeyLogin(payload?: CustomOptions): Promise<void> { - this.#passkeyController?.abort(); - this.#passkeyController = undefined; - - const publicKey = this.screen.publicKey; - if (!publicKey) throw new Error(Errors.PASSKEY_DATA_UNAVAILABLE); - - try { - const passkey = await getPasskeyCredentials(publicKey); - const options: FormOptions = { - state: this.transaction.state, - telemetry: [LoginId.screenIdentifier, 'passkeyLogin'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - passkey: JSON.stringify(passkey), - }); - } catch (err) { - if (err instanceof DOMException && err.name === 'NotAllowedError') { - // User cancelled or timed out the prompt - if (this.#isConditionalUIRegistered) { - try { - await this.registerPasskeyAutofill(); - } catch (e) { - console.warn('Conditional UI restart failed', e); - } - } - return; - } - throw err; // rethrow only unexpected errors - } - } - - /** - * @example - * import LoginId from "@auth0/auth0-acul-js/login-id"; - * const loginIdManager = new LoginId(); - * - * loginIdManager.pickCountryCode(); - */ - async pickCountryCode(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [LoginId.screenIdentifier, 'pickCountryCode'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_COUNTRY_CODE, - }); - } - - /** - * Gets the active identifier types for the login screen - * @returns An array of active identifier types or null if none are active - * @example - * ```typescript - * import LoginId from "@auth0/auth0-acul-js/login"; - * const loginIdManager = new LoginId(); - * loginIdManager.getLoginIdentifiers(); - * ``` - * @utilityFeature - */ - getLoginIdentifiers(): IdentifierType[] | null{ - return _getLoginIdentifiers(this.transaction.allowedIdentifiers); - } - - /** - * Registers the browser's Conditional UI for passkeys (autocomplete experience). - * - * This method initializes a passive WebAuthn credential request using - * `navigator.credentials.get()` with `mediation: "conditional"`. When supported, - * this allows the browser to display stored passkeys directly within the username - * field’s autocomplete dropdown. - * - * Call this **once** when the login screen is initialized (for example, on page load). - * After registration, focusing the username input will automatically display - * matching passkeys as suggestions. Selecting a passkey completes authentication - * without requiring additional user interaction. - * - * --- - * ### Input configuration - * If an `inputId` is provided, the SDK will: - * - Validate that the element exists and is an `<input>`. - * - Overwrite its `autocomplete` attribute with `"webauthn username"`. - * - * This ensures full compatibility with the Conditional Mediation API. - * - * If you do **not** provide an `inputId`, you are responsible for configuring - * the input element manually with the correct attributes: - * - * ```html - * <input id="username" autocomplete="webauthn username" /> - * ``` - * - * --- - * ### Gotchas - * - The `autocomplete` attribute **must exactly** contain `"webauthn username"`. - * Including unrelated tokens such as `"email"` or `"text"` will prevent browsers - * from showing the passkey dropdown. - * - Overwriting the attribute is intentional and required for consistent behavior - * across browsers. Do not rely on merging or extending existing autocomplete values. - * - If Conditional Mediation is not supported by the browser, the SDK will safely no-op. - * - * --- - * @param inputId - Optional ID of the username `<input>` element (without `#`). Example: `"username"`. - * If omitted, the developer must manually ensure the correct `autocomplete` attributes. - * - * @example - * ```ts - * import LoginId from '@auth0/auth0-acul-js/login-id'; - * - * // Example: initializing passkey autocomplete inside an async setup block. - * async function initializeLogin() { - * const loginId = new LoginId(); - * // Make sure associated HTML input exists: - * // <input id="username" autocomplete="webauthn username" /> - * // Conditional UI registration. - * await loginId.registerPasskeyAutofill('username'); - * } - * - * initializeLogin().catch(console.error); - * ``` - * - * @remarks - * This method delegates to the internal `registerPasskeyAutofill()` utility, - * returning a background `AbortController` to manage request lifetime. It should - * only be invoked once per page lifecycle. - * - * @category Passkeys - * @utilityFeature - */ - async registerPasskeyAutofill(inputId?: string): Promise<void> { - const publicKey = this.screen.publicKey; - if (!publicKey) throw new Error(Errors.PASSKEY_DATA_UNAVAILABLE); - - this.#passkeyController = await registerPasskeyAutofill({ - publicKey, - inputId, - onResolve: async (cred) => { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [LoginId.screenIdentifier, 'passkeyAutocomplete'], - }; - await new FormHandler(options).submitData({ - passkey: JSON.stringify(cred), - }); - }, - onReject: (err) => { - console.warn('Passkey autocomplete registration failed', err); - throw new SDKUsageError(Errors.PASSKEY_AUTOCOMPLETE_REGISTRATION_FAILED); - }, - }) ?? undefined; - - this.#isConditionalUIRegistered = true; - } -} +import LoginId from "@auth0/auth0-acul-js/login"; +const loginIdManager = new LoginId(); +loginIdManager.getLoginIdentifiers(); ``` </RequestExample> @@ -264,7 +26,7 @@ export default class LoginId extends BaseContext implements LoginIdMembers { <ParamField body="LoginId" type="Constructor"> {/*> **new LoginId**(): `LoginId`*/} -Defined in: [src/screens/login-id/index.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L36) +Defined in: [src/screens/login-id/index.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-id/index.ts#L36) Creates an instance of LoginIdManager. @@ -282,7 +44,7 @@ Creates an instance of LoginIdManager. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -297,7 +59,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -312,7 +74,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -327,7 +89,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -342,7 +104,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId">ScreenMembersOnLoginId</a></span>}> {/*> **screen**: [`ScreenMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId)*/} -Defined in: [src/screens/login-id/index.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L30) +Defined in: [src/screens/login-id/index.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-id/index.ts#L30) #### Implementation of @@ -357,7 +119,7 @@ Defined in: [src/screens/login-id/index.ts:30](https://github.com/auth0/universa <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -372,7 +134,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId">TransactionMembersOnLoginId</a></span>}> {/*> **transaction**: [`TransactionMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId)*/} -Defined in: [src/screens/login-id/index.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L31) +Defined in: [src/screens/login-id/index.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-id/index.ts#L31) #### Implementation of @@ -387,7 +149,7 @@ Defined in: [src/screens/login-id/index.ts:31](https://github.com/auth0/universa <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -402,7 +164,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -417,7 +179,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGIN_ID`*/} -Defined in: [src/screens/login-id/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L27) +Defined in: [src/screens/login-id/index.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-id/index.ts#L27) #### Overrides @@ -431,7 +193,7 @@ Defined in: [src/screens/login-id/index.ts:27](https://github.com/auth0/universa <ParamField body='federatedLogin' type='Promise<void>'> {/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login-id/index.ts:92](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L92) +Defined in: [src/screens/login-id/index.ts:92](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-id/index.ts#L92) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions">FederatedLoginOptions</a></span>}> @@ -475,7 +237,7 @@ loginIdManager.federatedLogin({ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -494,7 +256,7 @@ An array of error objects from the transaction context. <ParamField body='getLoginIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType">ScreenIdentifierType</a>[]</span>}> {/*> **getLoginIdentifiers**(): [`ScreenIdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType)[] \| `null`*/} -Defined in: [src/screens/login-id/index.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L173) +Defined in: [src/screens/login-id/index.ts:173](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-id/index.ts#L173) **`Utility Feature`** @@ -523,7 +285,7 @@ loginIdManager.getLoginIdentifiers(); <ParamField body='login' type='Promise<void>'> {/*> **login**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login-id/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L58) +Defined in: [src/screens/login-id/index.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-id/index.ts#L58) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions">LoginOptions</a></span>}> @@ -556,7 +318,7 @@ loginIdManager.login({ <ParamField body='passkeyLogin' type='Promise<void>'> {/*> **passkeyLogin**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login-id/index.ts:109](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L109) +Defined in: [src/screens/login-id/index.ts:109](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-id/index.ts#L109) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -587,7 +349,7 @@ loginIdManager.passkeyLogin(); <ParamField body='pickCountryCode' type='Promise<void>'> {/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login-id/index.ts:150](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L150) +Defined in: [src/screens/login-id/index.ts:150](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-id/index.ts#L150) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -618,7 +380,7 @@ loginIdManager.pickCountryCode(); <ParamField body='registerPasskeyAutofill' type='Promise<void>'> {/*> **registerPasskeyAutofill**(`inputId?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login-id/index.ts:242](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-id/index.ts#L242) +Defined in: [src/screens/login-id/index.ts:242](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-id/index.ts#L242) **`Utility Feature`** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPassword.mdx index 32433d2c5..451bcd892 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPassword.mdx @@ -2,76 +2,17 @@ title: "LoginPassword" --- -Defined in: [src/screens/login-password/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-password/index.ts#L20) +Defined in: [src/screens/login-password/index.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-password/index.ts#L20) <RequestExample> ```ts -export default class LoginPassword extends BaseContext implements LoginPasswordMembers { - static screenIdentifier: string = ScreenIds.LOGIN_PASSWORD; - screen: ScreenOptions; - transaction: TransactionOptions; - - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - const transactionContext = this.getContext('transaction') as TransactionContext; - - this.screen = new ScreenOverride(screenContext); - this.transaction = new TransactionOverride(transactionContext); - } - /** - * @remarks - * This methods handles login-password related configuration. - * - * @example - * import LoginPassword from "@auth0/auth0-acul-js/login-password"; - * - * const loginPasswordManager = new LoginPassword(); - * loginPasswordManager.login({ - * username: "testUser", - * password: "******" - * }); - */ - async login(payload: LoginPasswordOptions): Promise<void> { - const options: FormOptions = { state: this.transaction.state, telemetry: [LoginPassword.screenIdentifier, 'login'] }; - const browserCapabilities = await getBrowserCapabilities(); - await new FormHandler(options).submitData<LoginPasswordOptions>({ - ...payload, - ...browserCapabilities, - }); - } - - /** - * @example - * import LoginPassword from "@auth0/auth0-acul-js/login-id"; - * const loginIdManager = new LoginPassword(); - * - * // Check if alternateConnections is available and has at least one item - * if (!loginIdManager.transaction.alternateConnections) { - * console.error('No alternate connections available.'); - * } - * - * // Select the first available connection (users can select any available connection) - * const selectedConnection = alternateConnections[0]; - * - * // Log the chosen connection for debugging or informational purposes - * console.log(`Selected connection: ${selectedConnection.name}`); - * - * // Proceed with federated login using the selected connection - * loginIdManager.federatedLogin({ - * connection: selectedConnection.name, - * }); - */ - async federatedLogin(payload: FederatedLoginOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [LoginPassword.screenIdentifier, 'federatedLogin'], - }; - - await new FormHandler(options).submitData<FederatedLoginOptions>(payload); - } -} +import LoginPassword from "@auth0/auth0-acul-js/login-password"; +const loginPasswordManager = new LoginPassword(); +loginPasswordManager.login({ + username: "testUser", + password: "******" +}); ``` </RequestExample> @@ -88,7 +29,7 @@ export default class LoginPassword extends BaseContext implements LoginPasswordM <ParamField body="LoginPassword" type="Constructor"> {/*> **new LoginPassword**(): `LoginPassword`*/} -Defined in: [src/screens/login-password/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-password/index.ts#L25) +Defined in: [src/screens/login-password/index.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-password/index.ts#L25) #### Returns @@ -104,7 +45,7 @@ Defined in: [src/screens/login-password/index.ts:25](https://github.com/auth0/un <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -119,7 +60,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -134,7 +75,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -149,7 +90,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -164,7 +105,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword">ScreenMembersOnLoginPassword</a></span>}> {/*> **screen**: [`ScreenMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword)*/} -Defined in: [src/screens/login-password/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-password/index.ts#L22) +Defined in: [src/screens/login-password/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-password/index.ts#L22) #### Implementation of @@ -179,7 +120,7 @@ Defined in: [src/screens/login-password/index.ts:22](https://github.com/auth0/un <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -194,7 +135,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword">TransactionMembersOnLoginPassword</a></span>}> {/*> **transaction**: [`TransactionMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword)*/} -Defined in: [src/screens/login-password/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-password/index.ts#L23) +Defined in: [src/screens/login-password/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-password/index.ts#L23) #### Implementation of @@ -209,7 +150,7 @@ Defined in: [src/screens/login-password/index.ts:23](https://github.com/auth0/un <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -224,7 +165,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -239,7 +180,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGIN_PASSWORD`*/} -Defined in: [src/screens/login-password/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-password/index.ts#L21) +Defined in: [src/screens/login-password/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-password/index.ts#L21) #### Overrides @@ -251,7 +192,7 @@ Defined in: [src/screens/login-password/index.ts:21](https://github.com/auth0/un <ParamField body='federatedLogin' type='Promise<void>'> {/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login-password/index.ts:76](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-password/index.ts#L76) +Defined in: [src/screens/login-password/index.ts:76](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-password/index.ts#L76) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions">FederatedLoginPasswordOptions</a></span>}> @@ -295,7 +236,7 @@ loginIdManager.federatedLogin({ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -314,7 +255,7 @@ An array of error objects from the transaction context. <ParamField body='login' type='Promise<void>'> {/*> **login**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login-password/index.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-password/index.ts#L46) +Defined in: [src/screens/login-password/index.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-password/index.ts#L46) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions">LoginPasswordOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx index 716798ac2..43a3ac305 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx @@ -2,97 +2,26 @@ title: "LoginPasswordlessEmailCode" --- -Defined in: [src/screens/login-passwordless-email-code/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L21) +Defined in: [src/screens/login-passwordless-email-code/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L21) <RequestExample> ```ts -export default class LoginPasswordlessEmailCode extends BaseContext implements LoginPasswordlessEmailCodeMembers { - static screenIdentifier: string = ScreenIds.LOGIN_PASSWORDLESS_EMAIL_CODE; - screen: ScreenOptions; - transaction: TransactionOptions; - - constructor() { - super(); - - const screenContext = this.getContext('screen') as ScreenContext; - const transactionContext = this.getContext('transaction') as TransactionContext; - - this.screen = new ScreenOverride(screenContext); - this.transaction = new TransactionOverride(transactionContext); - } - - /** - * @example - * //Creates an instance of LoginPasswordlessEmailCode and calls the method with sample data. - * import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code'; - * - * //Method to continue the login process using email and code. - * const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode(); - * loginPasswordlessEmailCode.submitCode({ - * email: "test@domain.com"; - * code: "<string>"; - * }); - */ - async submitCode(payload: SubmitCodeOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [LoginPasswordlessEmailCode.screenIdentifier, 'submitCode'], - }; - - await new FormHandler(options).submitData<SubmitCodeOptions>(payload); - } +import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code'; - /** - * @example - * import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code'; - * - * const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode(); - * loginPasswordlessEmailCode.resendCode(); - */ - async resendCode(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [LoginPasswordlessEmailCode.screenIdentifier, 'resendCode'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND }); +const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode(); +const { startResend } = loginPasswordlessEmailCode.resendManager({ + timeoutSeconds: 60, + onStatusChange: (remainingSeconds, isDisabled) => { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + }, + onTimeout: () => { + console.log('Resend is now available'); } +}); - /** - * Creates a resend control manager for handling email code resend operations. - * - * @param options Configuration options for the resend control - * @returns A ResendControl object with resend functionality and state management - * @utilityFeature - * - * @example - * ```typescript - * import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code'; - * - * const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode(); - * const { startResend } = loginPasswordlessEmailCode.resendManager({ - * timeoutSeconds: 60, - * onStatusChange: (remainingSeconds, isDisabled) => { - * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); - * }, - * onTimeout: () => { - * console.log('Resend is now available'); - * } - * }); - * - * // Call startResend when user clicks resend button - * startResend(); - * ``` - */ - resendManager(options?: StartResendOptions): ResendControl { - return createResendControl( - LoginPasswordlessEmailCode.screenIdentifier, - () => this.resendCode(), - options - ); - } -} +// Call startResend when user clicks resend button +startResend(); ``` </RequestExample> @@ -109,7 +38,7 @@ export default class LoginPasswordlessEmailCode extends BaseContext implements L <ParamField body="LoginPasswordlessEmailCode" type="Constructor"> {/*> **new LoginPasswordlessEmailCode**(): `LoginPasswordlessEmailCode`*/} -Defined in: [src/screens/login-passwordless-email-code/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L26) +Defined in: [src/screens/login-passwordless-email-code/index.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L26) #### Returns @@ -125,7 +54,7 @@ Defined in: [src/screens/login-passwordless-email-code/index.ts:26](https://gith <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -140,7 +69,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -155,7 +84,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -170,7 +99,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -185,7 +114,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode">ScreenMembersOnLoginPasswordlessEmailCode</a></span>}> {/*> **screen**: [`ScreenMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode)*/} -Defined in: [src/screens/login-passwordless-email-code/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L23) +Defined in: [src/screens/login-passwordless-email-code/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L23) #### Implementation of @@ -200,7 +129,7 @@ Defined in: [src/screens/login-passwordless-email-code/index.ts:23](https://gith <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -215,7 +144,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode">TransactionMembersOnLoginPasswordlessEmailCode</a></span>}> {/*> **transaction**: [`TransactionMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode)*/} -Defined in: [src/screens/login-passwordless-email-code/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L24) +Defined in: [src/screens/login-passwordless-email-code/index.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L24) #### Implementation of @@ -230,7 +159,7 @@ Defined in: [src/screens/login-passwordless-email-code/index.ts:24](https://gith <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -245,7 +174,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -260,7 +189,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGIN_PASSWORDLESS_EMAIL_CODE`*/} -Defined in: [src/screens/login-passwordless-email-code/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L22) +Defined in: [src/screens/login-passwordless-email-code/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L22) #### Overrides @@ -272,7 +201,7 @@ Defined in: [src/screens/login-passwordless-email-code/index.ts:22](https://gith <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -291,7 +220,7 @@ An array of error objects from the transaction context. <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login-passwordless-email-code/index.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L64) +Defined in: [src/screens/login-passwordless-email-code/index.ts:64](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L64) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -321,7 +250,7 @@ loginPasswordlessEmailCode.resendCode(); <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [src/screens/login-passwordless-email-code/index.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L99) +Defined in: [src/screens/login-passwordless-email-code/index.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L99) **`Utility Feature`** @@ -370,7 +299,7 @@ startResend(); <ParamField body='submitCode' type='Promise<void>'> {/*> **submitCode**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login-passwordless-email-code/index.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L48) +Defined in: [src/screens/login-passwordless-email-code/index.ts:48](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L48) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions">SubmitCodeOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessSmsOtp.mdx index 1ed3e38d3..e59a43d43 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessSmsOtp.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessSmsOtp.mdx @@ -2,96 +2,26 @@ title: "LoginPasswordlessSmsOtp" --- -Defined in: [src/screens/login-passwordless-sms-otp/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L21) +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L21) <RequestExample> ```ts -export default class LoginPasswordlessSmsOtp extends BaseContext implements LoginPasswordlessSmsOtpMembers { - static screenIdentifier: string = ScreenIds.LOGIN_PASSWORDLESS_SMS_OTP; - screen: ScreenOptions; - transaction: TransactionOptions; - - constructor() { - super(); - - const screenContext = this.getContext('screen') as ScreenContext; - const transactionContext = this.getContext('transaction') as TransactionContext; - - this.screen = new ScreenOverride(screenContext); - this.transaction = new TransactionOverride(transactionContext); - } - - /** - * @example - * import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; - * const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); - * - * loginPasswordlessSmsOtp.submitOTP({ - * username: "test@domain.com"; - * code: "<string>"; - * }); - */ - async submitOTP(payload: SubmitOTPOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [LoginPasswordlessSmsOtp.screenIdentifier, 'submitOTP'], - }; - await new FormHandler(options).submitData<SubmitOTPOptions>({ ...payload, action: FormActions.DEFAULT }); - } +import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; - /** - * @example - * import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; - * - * const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); - * loginPasswordlessSmsOtp.resendOTP(); - */ - async resendOTP(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [LoginPasswordlessSmsOtp.screenIdentifier, 'resendOTP'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND }); +const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); +const { startResend } = loginPasswordlessSmsOtp.resendManager({ + timeoutSeconds: 15, + onStatusChange: (remainingSeconds, isDisabled) => { + console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); + }, + onTimeout: () => { + console.log('Resend is now available'); } +}); - /** - * Gets resend functionality with timeout management for this screen - * @param options - Configuration options for resend functionality - * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) - * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) - * @param options.onTimeout - Callback to execute when timeout countdown reaches zero - * @returns ResendControl object with startResend method - * @utilityFeature - * - * @example - * ```typescript - * import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; - * - * const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); - * const { startResend } = loginPasswordlessSmsOtp.resendManager({ - * timeoutSeconds: 15, - * onStatusChange: (remainingSeconds, isDisabled) => { - * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); - * }, - * onTimeout: () => { - * console.log('Resend is now available'); - * } - * }); - * - * // Call startResend when user clicks resend button - * startResend(); - * ``` - */ - resendManager(options?: StartResendOptions): ResendControl { - return createResendControl( - LoginPasswordlessSmsOtp.screenIdentifier, - () => this.resendOTP(), - options - ); - } -} +// Call startResend when user clicks resend button +startResend(); ``` </RequestExample> @@ -108,7 +38,7 @@ export default class LoginPasswordlessSmsOtp extends BaseContext implements Logi <ParamField body="LoginPasswordlessSmsOtp" type="Constructor"> {/*> **new LoginPasswordlessSmsOtp**(): `LoginPasswordlessSmsOtp`*/} -Defined in: [src/screens/login-passwordless-sms-otp/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L26) +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L26) #### Returns @@ -124,7 +54,7 @@ Defined in: [src/screens/login-passwordless-sms-otp/index.ts:26](https://github. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -139,7 +69,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -154,7 +84,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -169,7 +99,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -184,7 +114,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp">ScreenMembersOnLoginPasswordlessSmsOtp</a></span>}> {/*> **screen**: [`ScreenMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp)*/} -Defined in: [src/screens/login-passwordless-sms-otp/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L23) +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L23) #### Implementation of @@ -199,7 +129,7 @@ Defined in: [src/screens/login-passwordless-sms-otp/index.ts:23](https://github. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -214,7 +144,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp">TransactionMembersOnLoginPasswordlessSmsOtp</a></span>}> {/*> **transaction**: [`TransactionMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp)*/} -Defined in: [src/screens/login-passwordless-sms-otp/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L24) +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L24) #### Implementation of @@ -229,7 +159,7 @@ Defined in: [src/screens/login-passwordless-sms-otp/index.ts:24](https://github. <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -244,7 +174,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -259,7 +189,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGIN_PASSWORDLESS_SMS_OTP`*/} -Defined in: [src/screens/login-passwordless-sms-otp/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L22) +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L22) #### Overrides @@ -271,7 +201,7 @@ Defined in: [src/screens/login-passwordless-sms-otp/index.ts:22](https://github. <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -290,7 +220,7 @@ An array of error objects from the transaction context. <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [src/screens/login-passwordless-sms-otp/index.ts:98](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L98) +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:98](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L98) **`Utility Feature`** @@ -339,7 +269,7 @@ startResend(); <ParamField body='resendOTP' type='Promise<void>'> {/*> **resendOTP**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login-passwordless-sms-otp/index.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L61) +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:61](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L61) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -369,7 +299,7 @@ loginPasswordlessSmsOtp.resendOTP(); <ParamField body='submitOTP' type='Promise<void>'> {/*> **submitOTP**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/login-passwordless-sms-otp/index.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L46) +Defined in: [src/screens/login-passwordless-sms-otp/index.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L46) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions">SubmitOTPOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Logout.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Logout.mdx index 746b6b6bb..6854c3118 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Logout.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Logout.mdx @@ -2,7 +2,7 @@ title: "Logout" --- -Defined in: [src/screens/logout/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout/index.ts#L15) +Defined in: [src/screens/logout/index.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/logout/index.ts#L15) Class implementing the logout screen functionality. This screen allows users to confirm or deny the logout action. @@ -10,40 +10,11 @@ This screen allows users to confirm or deny the logout action. <RequestExample> ```ts -export default class Logout extends BaseContext implements LogoutMembers { - static screenIdentifier: string = ScreenIds.LOGOUT; - - /** - * Creates an instance of the Logout screen manager. - */ - constructor() { - super(); - } - - /** - * Confirms the logout action (accept or deny). - * @param payload The options containing the action to perform. - * @example - * ```typescript - * import Logout from '@auth0/auth0-acul-js/logout'; - * - * const logout = new Logout(); - * - * await logout.confirmLogout({ action: 'accept' }); - * ``` - */ - async confirmLogout(payload: ConfirmLogoutOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [Logout.screenIdentifier, 'confirmLogout'], - }; - - await new FormHandler(options).submitData<ConfirmLogoutOptions>({ - ...payload, - action: payload.action, - }); - } -} +import Logout from '@auth0/auth0-acul-js/logout'; + +const logout = new Logout(); + +await logout.confirmLogout({ action: 'accept' }); ``` </RequestExample> @@ -60,7 +31,7 @@ export default class Logout extends BaseContext implements LogoutMembers { <ParamField body="Logout" type="Constructor"> {/*> **new Logout**(): `Logout`*/} -Defined in: [src/screens/logout/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout/index.ts#L21) +Defined in: [src/screens/logout/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/logout/index.ts#L21) Creates an instance of the Logout screen manager. @@ -78,7 +49,7 @@ Creates an instance of the Logout screen manager. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -93,7 +64,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -108,7 +79,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -123,7 +94,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -138,7 +109,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -153,7 +124,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -168,7 +139,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -183,7 +154,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -198,7 +169,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -213,7 +184,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGOUT`*/} -Defined in: [src/screens/logout/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout/index.ts#L16) +Defined in: [src/screens/logout/index.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/logout/index.ts#L16) #### Overrides @@ -225,7 +196,7 @@ Defined in: [src/screens/logout/index.ts:16](https://github.com/auth0/universal- <ParamField body='confirmLogout' type='Promise<void>'> {/*> **confirmLogout**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/logout/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout/index.ts#L37) +Defined in: [src/screens/logout/index.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/logout/index.ts#L37) Confirms the logout action (accept or deny). @@ -260,7 +231,7 @@ await logout.confirmLogout({ action: 'accept' }); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutAborted.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutAborted.mdx index 26940ccac..47c6933f2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutAborted.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutAborted.mdx @@ -2,27 +2,12 @@ title: "LogoutAborted" --- -Defined in: [src/screens/logout-aborted/index.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout-aborted/index.ts#L10) +Defined in: [src/screens/logout-aborted/index.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/logout-aborted/index.ts#L10) Class implementing the logout-aborted screen functionality This screen is displayed when a user aborts the logout process. -<RequestExample> -```ts -export default class LogoutAborted extends BaseContext implements LogoutAbortedMembers { - static screenIdentifier: string = ScreenIds.LOGOUT_ABORTED; - - /** - * Creates an instance of LogoutAborted screen manager - */ - constructor() { - super(); - } -} -``` -</RequestExample> - ## Extends - `BaseContext` @@ -36,7 +21,7 @@ export default class LogoutAborted extends BaseContext implements LogoutAbortedM <ParamField body="LogoutAborted" type="Constructor"> {/*> **new LogoutAborted**(): `LogoutAborted`*/} -Defined in: [src/screens/logout-aborted/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout-aborted/index.ts#L16) +Defined in: [src/screens/logout-aborted/index.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/logout-aborted/index.ts#L16) Creates an instance of LogoutAborted screen manager @@ -54,7 +39,7 @@ Creates an instance of LogoutAborted screen manager <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -69,7 +54,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -84,7 +69,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -99,7 +84,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -114,7 +99,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -129,7 +114,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -144,7 +129,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -159,7 +144,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -174,7 +159,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -189,7 +174,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGOUT_ABORTED`*/} -Defined in: [src/screens/logout-aborted/index.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout-aborted/index.ts#L11) +Defined in: [src/screens/logout-aborted/index.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/logout-aborted/index.ts#L11) #### Overrides @@ -201,7 +186,7 @@ Defined in: [src/screens/logout-aborted/index.ts:11](https://github.com/auth0/un <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutComplete.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutComplete.mdx index 374df1bdc..5e76cc3f5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutComplete.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutComplete.mdx @@ -2,27 +2,12 @@ title: "LogoutComplete" --- -Defined in: [src/screens/logout-complete/index.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout-complete/index.ts#L10) +Defined in: [src/screens/logout-complete/index.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/logout-complete/index.ts#L10) Class implementing the logout-complete screen functionality This screen is displayed when a user aborts the logout process. -<RequestExample> -```ts -export default class LogoutComplete extends BaseContext implements LogoutCompleteMembers { - static screenIdentifier: string = ScreenIds.LOGOUT_COMPLETE; - - /** - * Creates an instance of LogoutComplete screen manager - */ - constructor() { - super(); - } -} -``` -</RequestExample> - ## Extends - `BaseContext` @@ -36,7 +21,7 @@ export default class LogoutComplete extends BaseContext implements LogoutComplet <ParamField body="LogoutComplete" type="Constructor"> {/*> **new LogoutComplete**(): `LogoutComplete`*/} -Defined in: [src/screens/logout-complete/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout-complete/index.ts#L16) +Defined in: [src/screens/logout-complete/index.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/logout-complete/index.ts#L16) Creates an instance of LogoutComplete screen manager @@ -54,7 +39,7 @@ Creates an instance of LogoutComplete screen manager <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -69,7 +54,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -84,7 +69,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -99,7 +84,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -114,7 +99,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -129,7 +114,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -144,7 +129,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -159,7 +144,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -174,7 +159,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -189,7 +174,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGOUT_COMPLETE`*/} -Defined in: [src/screens/logout-complete/index.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/logout-complete/index.ts#L11) +Defined in: [src/screens/logout-complete/index.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/logout-complete/index.ts#L11) #### Overrides @@ -201,7 +186,7 @@ Defined in: [src/screens/logout-complete/index.ts:11](https://github.com/auth0/u <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaBeginEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaBeginEnrollOptions.mdx index bf01fb0c4..798332e87 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaBeginEnrollOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaBeginEnrollOptions.mdx @@ -2,7 +2,7 @@ title: "MfaBeginEnrollOptions" --- -Defined in: [src/screens/mfa-begin-enroll-options/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-begin-enroll-options/index.ts#L12) +Defined in: [src/screens/mfa-begin-enroll-options/index.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-begin-enroll-options/index.ts#L12) MFA Begin Enroll Options screen implementation class Handles the selection and enrollment of MFA factors @@ -10,34 +10,10 @@ Handles the selection and enrollment of MFA factors <RequestExample> ```ts -export default class MfaBeginEnrollOptions extends BaseContext implements MfaBeginEnrollOptionsMembers { - static screenIdentifier: string = ScreenIds.MFA_BEGIN_ENROLL_OPTIONS; - /** - * Creates an instance of MFA Begin Enroll Options screen manager - */ - constructor() { - super(); - } - - /** - * Continues the enrollment process with the selected factor - * @param payload The enrollment options including the selected factor - * @example - * ```typescript - * const mfaBeginEnrollOptions = new MfaBeginEnrollOptions(); - * await mfaBeginEnrollOptions.enroll({ - * action: 'push-notification' - * }); - * ``` - */ - async enroll(payload: MfaEnrollOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaBeginEnrollOptions.screenIdentifier, 'enroll'], - }; - await new FormHandler(options).submitData<MfaEnrollOptions>(payload); - } -} +const mfaBeginEnrollOptions = new MfaBeginEnrollOptions(); +await mfaBeginEnrollOptions.enroll({ + action: 'push-notification' +}); ``` </RequestExample> @@ -54,7 +30,7 @@ export default class MfaBeginEnrollOptions extends BaseContext implements MfaBeg <ParamField body="MfaBeginEnrollOptions" type="Constructor"> {/*> **new MfaBeginEnrollOptions**(): `MfaBeginEnrollOptions`*/} -Defined in: [src/screens/mfa-begin-enroll-options/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-begin-enroll-options/index.ts#L17) +Defined in: [src/screens/mfa-begin-enroll-options/index.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-begin-enroll-options/index.ts#L17) Creates an instance of MFA Begin Enroll Options screen manager @@ -72,7 +48,7 @@ Creates an instance of MFA Begin Enroll Options screen manager <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -87,7 +63,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -102,7 +78,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -117,7 +93,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -132,7 +108,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -147,7 +123,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -162,7 +138,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -177,7 +153,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -192,7 +168,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -207,7 +183,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_BEGIN_ENROLL_OPTIONS`*/} -Defined in: [src/screens/mfa-begin-enroll-options/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-begin-enroll-options/index.ts#L13) +Defined in: [src/screens/mfa-begin-enroll-options/index.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-begin-enroll-options/index.ts#L13) #### Overrides @@ -219,7 +195,7 @@ Defined in: [src/screens/mfa-begin-enroll-options/index.ts:13](https://github.co <ParamField body='enroll' type='Promise<void>'> {/*> **enroll**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-begin-enroll-options/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-begin-enroll-options/index.ts#L32) +Defined in: [src/screens/mfa-begin-enroll-options/index.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-begin-enroll-options/index.ts#L32) Continues the enrollment process with the selected factor @@ -253,7 +229,7 @@ await mfaBeginEnrollOptions.enroll({ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaCountryCodes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaCountryCodes.mdx index 1511830dd..22835f25b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaCountryCodes.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaCountryCodes.mdx @@ -2,7 +2,7 @@ title: "MfaCountryCodes" --- -Defined in: [src/screens/mfa-country-codes/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L20) +Defined in: [src/screens/mfa-country-codes/index.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L20) Class implementing the mfa-country-codes screen functionality This screen allows users to select a country code for MFA phone number verification @@ -10,74 +10,19 @@ This screen allows users to select a country code for MFA phone number verificat <RequestExample> ```ts -export default class MfaCountryCodes extends BaseContext implements MfaCountryCodesMembers { - static screenIdentifier: string = ScreenIds.MFA_COUNTRY_CODES; - screen: ScreenOptions; - - /** - * Creates an instance of MfaCountryCodes screen manager - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Selects a country code from the available options - * @param payload The options containing the country code selection action - * @example - * ```typescript - * import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes'; - * - * const mfaCountryCodes = new MfaCountryCodes(); - * - * // Get the available country codes and phone prefixes - * const { screen } = mfaCountryCodes; - * const { phone_prefixes } = screen.data - * const {country_code, phone_prefix} = phone_prefixes[0] - * - * await mfaCountryCodes.selectCountryCode({ - * country_code: 'US', - * phone_prefix: '+1', - * }); - * ``` - */ - async selectCountryCode(payload: SelectCountryCodeOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaCountryCodes.screenIdentifier, 'selectCountryCode'], - }; - const { country_code, phone_prefix } = payload; - const action = `selection-action::${country_code}${phone_prefix}`; - await new FormHandler(options).submitData<SelectCountryCodeOptions>({ - ...payload, - action, - }); - } - - /** - * Navigates back to the previous screen - * @param payload Optional custom options to include with the request - * @example - * ```typescript - * import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes'; - * - * const mfaCountryCodes = new MfaCountryCodes(); - * await mfaCountryCodes.goBack(); - * ``` - */ - async goBack(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaCountryCodes.screenIdentifier, 'goBack'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.BACK, - }); - } -} +import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes'; + +const mfaCountryCodes = new MfaCountryCodes(); + +// Get the available country codes and phone prefixes +const { screen } = mfaCountryCodes; +const { phone_prefixes } = screen.data +const {country_code, phone_prefix} = phone_prefixes[0] + +await mfaCountryCodes.selectCountryCode({ + country_code: 'US', + phone_prefix: '+1', +}); ``` </RequestExample> @@ -94,7 +39,7 @@ export default class MfaCountryCodes extends BaseContext implements MfaCountryCo <ParamField body="MfaCountryCodes" type="Constructor"> {/*> **new MfaCountryCodes**(): `MfaCountryCodes`*/} -Defined in: [src/screens/mfa-country-codes/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L27) +Defined in: [src/screens/mfa-country-codes/index.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L27) Creates an instance of MfaCountryCodes screen manager @@ -112,7 +57,7 @@ Creates an instance of MfaCountryCodes screen manager <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -127,7 +72,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -142,7 +87,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -157,7 +102,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -172,7 +117,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes">ScreenMembersOnMfaCountryCodes</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaCountryCodes`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes)*/} -Defined in: [src/screens/mfa-country-codes/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L22) +Defined in: [src/screens/mfa-country-codes/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L22) #### Implementation of @@ -187,7 +132,7 @@ Defined in: [src/screens/mfa-country-codes/index.ts:22](https://github.com/auth0 <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -202,7 +147,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -217,7 +162,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -232,7 +177,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -247,7 +192,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_COUNTRY_CODES`*/} -Defined in: [src/screens/mfa-country-codes/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L21) +Defined in: [src/screens/mfa-country-codes/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L21) #### Overrides @@ -259,7 +204,7 @@ Defined in: [src/screens/mfa-country-codes/index.ts:21](https://github.com/auth0 <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -278,7 +223,7 @@ An array of error objects from the transaction context. <ParamField body='goBack' type='Promise<void>'> {/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-country-codes/index.ts:77](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L77) +Defined in: [src/screens/mfa-country-codes/index.ts:77](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L77) Navigates back to the previous screen @@ -312,7 +257,7 @@ await mfaCountryCodes.goBack(); <ParamField body='selectCountryCode' type='Promise<void>'> {/*> **selectCountryCode**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-country-codes/index.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L53) +Defined in: [src/screens/mfa-country-codes/index.ts:53](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-country-codes/index.ts#L53) Selects a country code from the available options diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaDetectBrowserCapabilities.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaDetectBrowserCapabilities.mdx index 906ceeb81..6822b772b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaDetectBrowserCapabilities.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaDetectBrowserCapabilities.mdx @@ -2,7 +2,7 @@ title: "MfaDetectBrowserCapabilities" --- -Defined in: [src/screens/mfa-detect-browser-capabilities/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-detect-browser-capabilities/index.ts#L14) +Defined in: [src/screens/mfa-detect-browser-capabilities/index.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-detect-browser-capabilities/index.ts#L14) Class implementing the mfa-detect-browser-capabilities screen functionality This screen detects browser capabilities for MFA authentication methods @@ -10,38 +10,8 @@ This screen detects browser capabilities for MFA authentication methods <RequestExample> ```ts -export default class MfaDetectBrowserCapabilities extends BaseContext implements MfaDetectBrowserCapabilitiesMembers { - static screenIdentifier: string = ScreenIds.MFA_DETECT_BROWSER_CAPABILITIES; - - /** - * Creates an instance of MfaDetectBrowserCapabilities screen manager - */ - constructor() { - super(); - } - - /** - * Picks an authenticator based on browser capabilities - * @param payload The options containing browser capability flags - * @example - * ```typescript - * const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); - * await mfaDetectBrowserCapabilities.detectCapabilities(); - * ``` - */ - async detectCapabilities(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaDetectBrowserCapabilities.screenIdentifier, 'detectCapabilities'], - }; - const browserCapabilities = await getBrowserCapabilities() - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - ...browserCapabilities, - action: 'pick-authenticator', - }); - } -} +const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); +await mfaDetectBrowserCapabilities.detectCapabilities(); ``` </RequestExample> @@ -58,7 +28,7 @@ export default class MfaDetectBrowserCapabilities extends BaseContext implements <ParamField body="MfaDetectBrowserCapabilities" type="Constructor"> {/*> **new MfaDetectBrowserCapabilities**(): `MfaDetectBrowserCapabilities`*/} -Defined in: [src/screens/mfa-detect-browser-capabilities/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-detect-browser-capabilities/index.ts#L20) +Defined in: [src/screens/mfa-detect-browser-capabilities/index.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-detect-browser-capabilities/index.ts#L20) Creates an instance of MfaDetectBrowserCapabilities screen manager @@ -76,7 +46,7 @@ Creates an instance of MfaDetectBrowserCapabilities screen manager <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -91,7 +61,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -106,7 +76,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -121,7 +91,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -136,7 +106,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -151,7 +121,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -166,7 +136,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -181,7 +151,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -196,7 +166,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -211,7 +181,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_DETECT_BROWSER_CAPABILITIES`*/} -Defined in: [src/screens/mfa-detect-browser-capabilities/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-detect-browser-capabilities/index.ts#L15) +Defined in: [src/screens/mfa-detect-browser-capabilities/index.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-detect-browser-capabilities/index.ts#L15) #### Overrides @@ -223,7 +193,7 @@ Defined in: [src/screens/mfa-detect-browser-capabilities/index.ts:15](https://gi <ParamField body='detectCapabilities' type='Promise<void>'> {/*> **detectCapabilities**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-detect-browser-capabilities/index.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-detect-browser-capabilities/index.ts#L33) +Defined in: [src/screens/mfa-detect-browser-capabilities/index.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-detect-browser-capabilities/index.ts#L33) Picks an authenticator based on browser capabilities @@ -255,7 +225,7 @@ await mfaDetectBrowserCapabilities.detectCapabilities(); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailChallenge.mdx index c83d47710..763d899d0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailChallenge.mdx @@ -2,7 +2,7 @@ title: "MfaEmailChallenge" --- -Defined in: [src/screens/mfa-email-challenge/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L27) +Defined in: [src/screens/mfa-email-challenge/index.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L27) Class implementing the mfa-email-challenge screen functionality This screen is shown when a user needs to verify their email during MFA @@ -10,149 +10,13 @@ This screen is shown when a user needs to verify their email during MFA <RequestExample> ```ts -export default class MfaEmailChallenge extends BaseContext implements MfaEmailChallengeMembers { - static screenIdentifier: string = ScreenIds.MFA_EMAIL_CHALLENGE; - screen: ScreenOptions; - untrustedData: UntrustedDataOptions; - - /** - * Creates an instance of MfaEmailChallenge screen manager - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - const untrustedDataContext = this.getContext('untrusted_data') as UntrustedDataContext; - this.screen = new ScreenOverride(screenContext); - this.untrustedData = new UntrustedDataOverride(untrustedDataContext); - } - - /** - * Continues with the email challenge using the provided code - * @param payload The options containing the code and rememberDevice flag - * @example - * ```typescript - * import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; - * - * const mfaEmailChallenge = new MfaEmailChallenge(); - * await mfaEmailChallenge.continue({ - * code: '123456', - * rememberDevice: true - * }); - * ``` - */ - async continue(payload: ContinueOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaEmailChallenge.screenIdentifier, 'continue'], - }; - const { rememberDevice = false, ...restPayload } = payload || {}; - const submitPayload: Record<string, string | number | boolean> = { ...restPayload, action: FormActions.DEFAULT }; - if (rememberDevice) { - submitPayload.rememberBrowser = true; - } - await new FormHandler(options).submitData(submitPayload); - } - - /** - * Resends the email code - * @param payload Optional custom options to include with the request - * @example - * ```typescript - * import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; - * - * const mfaEmailChallenge = new MfaEmailChallenge(); - * await mfaEmailChallenge.resendCode(); - * ``` - */ - async resendCode(payload?: ResendCodeOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaEmailChallenge.screenIdentifier, 'resendCode'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.RESEND_CODE, - }); - } - - /** - * Allows the user to try another MFA method - * @param payload Optional custom options to include with the request - * @example - * ```typescript - * import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; - * - * const mfaEmailChallenge = new MfaEmailChallenge(); - * await mfaEmailChallenge.tryAnotherMethod(); - * ``` - */ - async tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaEmailChallenge.screenIdentifier, 'tryAnotherMethod'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } - - /** - * Submits the action to pick a different Email configuration, if available. - * @param {CustomOptions} [payload] - Optional payload. - * @returns {Promise<void>} - * @example - * ```typescript - * import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; - * - * const mfaEmailChallenge = new MfaEmailChallenge(); - * await mfaEmailChallenge.pickEmail(); - * ``` - */ - async pickEmail(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaEmailChallenge.screenIdentifier, 'pickEmail'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.PICK_EMAIL }); - } +import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; - /** - * Gets resend functionality with timeout management for this screen - * @param options - Configuration options for resend functionality - * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) - * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) - * @param options.onTimeout - Callback to execute when timeout countdown reaches zero - * @returns ResendControl object with startResend method - * @utilityFeature - * - * @example - * ```typescript - * import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; - * - * const mfaEmailChallenge = new MfaEmailChallenge(); - * const { startResend } = mfaEmailChallenge.resendManager({ - * timeoutSeconds: 15, - * onStatusChange: (remainingSeconds, isDisabled) => { - * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); - * }, - * onTimeout: () => { - * console.log('Resend is now available'); - * } - * }); - * - * // Call startResend when user clicks resend button - * startResend(); - * ``` - */ - resendManager(options?: StartResendOptions): ResendControl { - return createResendControl( - MfaEmailChallenge.screenIdentifier, - () => this.resendCode(), - options - ); - } -} +const mfaEmailChallenge = new MfaEmailChallenge(); +await mfaEmailChallenge.continue({ + code: '123456', + rememberDevice: true +}); ``` </RequestExample> @@ -169,7 +33,7 @@ export default class MfaEmailChallenge extends BaseContext implements MfaEmailCh <ParamField body="MfaEmailChallenge" type="Constructor"> {/*> **new MfaEmailChallenge**(): `MfaEmailChallenge`*/} -Defined in: [src/screens/mfa-email-challenge/index.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L35) +Defined in: [src/screens/mfa-email-challenge/index.ts:35](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L35) Creates an instance of MfaEmailChallenge screen manager @@ -187,7 +51,7 @@ Creates an instance of MfaEmailChallenge screen manager <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -202,7 +66,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -217,7 +81,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -232,7 +96,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -247,7 +111,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge">ScreenMembersOnMfaEmailChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge)*/} -Defined in: [src/screens/mfa-email-challenge/index.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L29) +Defined in: [src/screens/mfa-email-challenge/index.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L29) #### Implementation of @@ -262,7 +126,7 @@ Defined in: [src/screens/mfa-email-challenge/index.ts:29](https://github.com/aut <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -277,7 +141,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -292,7 +156,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge">UntrustedDataMembersOnMfaEmailChallenge</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge)*/} -Defined in: [src/screens/mfa-email-challenge/index.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L30) +Defined in: [src/screens/mfa-email-challenge/index.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L30) #### Implementation of @@ -307,7 +171,7 @@ Defined in: [src/screens/mfa-email-challenge/index.ts:30](https://github.com/aut <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -322,7 +186,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_EMAIL_CHALLENGE`*/} -Defined in: [src/screens/mfa-email-challenge/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L28) +Defined in: [src/screens/mfa-email-challenge/index.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L28) #### Overrides @@ -334,7 +198,7 @@ Defined in: [src/screens/mfa-email-challenge/index.ts:28](https://github.com/aut <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-email-challenge/index.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L57) +Defined in: [src/screens/mfa-email-challenge/index.ts:57](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L57) Continues with the email challenge using the provided code @@ -371,7 +235,7 @@ await mfaEmailChallenge.continue({ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -390,7 +254,7 @@ An array of error objects from the transaction context. <ParamField body='pickEmail' type='Promise<void>'> {/*> **pickEmail**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-email-challenge/index.ts:126](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L126) +Defined in: [src/screens/mfa-email-challenge/index.ts:126](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L126) Submits the action to pick a different Email configuration, if available. @@ -424,7 +288,7 @@ await mfaEmailChallenge.pickEmail(); <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-email-challenge/index.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L81) +Defined in: [src/screens/mfa-email-challenge/index.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L81) Resends the email code @@ -458,7 +322,7 @@ await mfaEmailChallenge.resendCode(); <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [src/screens/mfa-email-challenge/index.ts:162](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L162) +Defined in: [src/screens/mfa-email-challenge/index.ts:162](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L162) **`Utility Feature`** @@ -507,7 +371,7 @@ startResend(); <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-email-challenge/index.ts:103](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L103) +Defined in: [src/screens/mfa-email-challenge/index.ts:103](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L103) Allows the user to try another MFA method diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailList.mdx index 1b48de92f..452bdf42f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailList.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailList.mdx @@ -2,7 +2,7 @@ title: "MfaEmailList" --- -Defined in: [src/screens/mfa-email-list/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L20) +Defined in: [src/screens/mfa-email-list/index.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L20) Class implementing the mfa-email-list screen functionality This screen allows users to select an enrolled email address for MFA @@ -10,74 +10,12 @@ This screen allows users to select an enrolled email address for MFA <RequestExample> ```ts -export default class MfaEmailList extends BaseContext implements MfaEmailListMembers { - static screenIdentifier: string = ScreenIds.MFA_EMAIL_LIST; - /** - * The screen object for the mfa-email-list screen - */ - public screen: ScreenOptions; - - /** - * Creates an instance of MfaEmailList screen manager - */ - - constructor() { - super(); // Calls BaseContext constructor for global context initialization and validation. - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Selects an enrolled email address from the list - * @param payload The options containing the selection action - * @example - * ```typescript - * import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list'; - * - * const mfaEmailList = new MfaEmailList(); - * await mfaEmailList.selectMfaEmail({ - * index: 0 // for demonstration we are selecting the first index - * }); - * ``` - */ - async selectMfaEmail(payload: SelectMfaEmailOptions): Promise<void> { - const index = payload?.index; - if (index === undefined || index < 0 || index >= (this.user?.enrolledEmails?.length ?? 0)) { - throw new Error('Index out of bounds.'); - } - - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaEmailList.screenIdentifier, 'selectMfaEmail'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: `selection-action::${index}`, - }); - } - - /** - * Navigates back to the previous screen - * @param payload Optional custom options to include with the request - * @example - * ```typescript - * import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list'; - * - * const mfaEmailList = new MfaEmailList(); - * await mfaEmailList.goBack(); - * ``` - */ - async goBack(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaEmailList.screenIdentifier, 'goBack'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.BACK, - }); - } -} +import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list'; + +const mfaEmailList = new MfaEmailList(); +await mfaEmailList.selectMfaEmail({ + index: 0 // for demonstration we are selecting the first index +}); ``` </RequestExample> @@ -94,7 +32,7 @@ export default class MfaEmailList extends BaseContext implements MfaEmailListMem <ParamField body="MfaEmailList" type="Constructor"> {/*> **new MfaEmailList**(): `MfaEmailList`*/} -Defined in: [src/screens/mfa-email-list/index.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L31) +Defined in: [src/screens/mfa-email-list/index.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L31) Creates an instance of MfaEmailList screen manager @@ -112,7 +50,7 @@ Creates an instance of MfaEmailList screen manager <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -127,7 +65,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -142,7 +80,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -157,7 +95,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -172,7 +110,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList">ScreenMembersOnMfaEmailList</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaEmailList`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList)*/} -Defined in: [src/screens/mfa-email-list/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L25) +Defined in: [src/screens/mfa-email-list/index.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L25) The screen object for the mfa-email-list screen @@ -189,7 +127,7 @@ The screen object for the mfa-email-list screen <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -204,7 +142,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -219,7 +157,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -234,7 +172,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -249,7 +187,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_EMAIL_LIST`*/} -Defined in: [src/screens/mfa-email-list/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L21) +Defined in: [src/screens/mfa-email-list/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L21) #### Overrides @@ -261,7 +199,7 @@ Defined in: [src/screens/mfa-email-list/index.ts:21](https://github.com/auth0/un <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -280,7 +218,7 @@ An array of error objects from the transaction context. <ParamField body='goBack' type='Promise<void>'> {/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-email-list/index.ts:77](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L77) +Defined in: [src/screens/mfa-email-list/index.ts:77](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L77) Navigates back to the previous screen @@ -314,7 +252,7 @@ await mfaEmailList.goBack(); <ParamField body='selectMfaEmail' type='Promise<void>'> {/*> **selectMfaEmail**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-email-list/index.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L50) +Defined in: [src/screens/mfa-email-list/index.ts:50](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-list/index.ts#L50) Selects an enrolled email address from the list diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEnrollResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEnrollResult.mdx index 7bf662512..3ade8c963 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEnrollResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEnrollResult.mdx @@ -2,57 +2,11 @@ title: "MfaEnrollResult" --- -Defined in: [src/screens/mfa-enroll-result/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-enroll-result/index.ts#L34) +Defined in: [src/screens/mfa-enroll-result/index.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-enroll-result/index.ts#L34) MfaEnrollResult -<RequestExample> -```ts -export default class MfaEnrollResult extends BaseContext implements MfaEnrollResultMembers { - /** - * static - * @property {string} screenIdentifier - The unique identifier for the MFA Enroll Result screen. - */ - static screenIdentifier: string = ScreenIds.MFA_ENROLL_RESULT; - - /** - * @property {ScreenOptions} screen - Holds the specific screen data and properties for the - * MFA Enroll Result screen, including the enrollment `status`. - * @public - */ - public screen: ScreenOptions; - - /** - * Creates an instance of MfaEnrollResult screen manager. - * It initializes the `BaseContext` and sets up the `screen` property - * with an instance of `ScreenOverride` tailored for this screen. - * @throws {Error} If the Universal Login Context is not available or if the - * current screen name in the context does not match `MfaEnrollResult.screenIdentifier`. - */ - constructor() { - super(); // Calls BaseContext constructor for global context initialization and validation. - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - // This screen is typically informational. - // If there's a "Continue" button, it would likely be a default action. - // For example, if a `continue()` method was needed: - /* - async continue(payload?: CustomOptions): Promise<void> { - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaEnrollResult.screenIdentifier, 'continue'], - route: '/u/mfa-enroll-result', // Assuming this is the endpoint - }; - await new FormHandler(formOptions).submitData({ ...payload, action: FormActions.DEFAULT }); - } - */ -} -``` -</RequestExample> - ## Example ```typescript @@ -81,7 +35,7 @@ console.log(`Page Title: ${pageTitle}`); <ParamField body="MfaEnrollResult" type="Constructor"> {/*> **new MfaEnrollResult**(): `MfaEnrollResult`*/} -Defined in: [src/screens/mfa-enroll-result/index.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-enroll-result/index.ts#L55) +Defined in: [src/screens/mfa-enroll-result/index.ts:55](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-enroll-result/index.ts#L55) Creates an instance of MfaEnrollResult screen manager. It initializes the `BaseContext` and sets up the `screen` property @@ -106,7 +60,7 @@ current screen name in the context does not match `MfaEnrollResult.screenIdentif <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -121,7 +75,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -136,7 +90,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -151,7 +105,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -166,7 +120,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult">ScreenMembersOnMfaEnrollResult</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaEnrollResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult)*/} -Defined in: [src/screens/mfa-enroll-result/index.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-enroll-result/index.ts#L46) +Defined in: [src/screens/mfa-enroll-result/index.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-enroll-result/index.ts#L46) #### Implementation of @@ -181,7 +135,7 @@ Defined in: [src/screens/mfa-enroll-result/index.ts:46](https://github.com/auth0 <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -196,7 +150,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -211,7 +165,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -226,7 +180,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -241,7 +195,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_ENROLL_RESULT`*/} -Defined in: [src/screens/mfa-enroll-result/index.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-enroll-result/index.ts#L39) +Defined in: [src/screens/mfa-enroll-result/index.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-enroll-result/index.ts#L39) static @@ -255,7 +209,7 @@ static <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaLoginOptions.mdx index df1d7c802..01b5449f0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaLoginOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaLoginOptions.mdx @@ -2,7 +2,7 @@ title: "MfaLoginOptions" --- -Defined in: [src/screens/mfa-login-options/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L16) +Defined in: [src/screens/mfa-login-options/index.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L16) Class implementing the mfa-login-options screen functionality This screen allows users to select which MFA factor they want to use for login @@ -10,56 +10,10 @@ This screen allows users to select which MFA factor they want to use for login <RequestExample> ```ts -export default class MfaLoginOptions extends BaseContext implements MfaLoginOptionsMembers { - static screenIdentifier: string = ScreenIds.MFA_LOGIN_OPTIONS; - - /** - * The screen object for the mfa-login-options screen - */ - public screen: ScreenMembersOnMfaLoginOptions; - /** - * Creates an instance of MfaLoginOptions screen manager - */ - constructor() { - super(); // Calls BaseContext constructor for global context initialization and validation. - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Continues the login process with the selected MFA factor - * @param payload The options containing the selected factor - * @example - * ```typescript - * const mfaLoginOptions = new MfaLoginOptions(); - * await mfaLoginOptions.enroll({ - * action: 'push-notification' - * }); - * ``` - */ - async enroll(payload: LoginEnrollOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaLoginOptions.screenIdentifier, 'enroll'], - }; - await new FormHandler(options).submitData<LoginEnrollOptions>(payload); - } - - /** - * @example - * import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options'; - * - * const mfaLoginOptions = new MfaLoginOptions(); - * mfaLoginOptions.returnToPrevious(); - */ - async returnToPrevious(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaLoginOptions.screenIdentifier, 'returnToPrevious'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.BACK }); - } -} +const mfaLoginOptions = new MfaLoginOptions(); +await mfaLoginOptions.enroll({ + action: 'push-notification' +}); ``` </RequestExample> @@ -76,7 +30,7 @@ export default class MfaLoginOptions extends BaseContext implements MfaLoginOpti <ParamField body="MfaLoginOptions" type="Constructor"> {/*> **new MfaLoginOptions**(): `MfaLoginOptions`*/} -Defined in: [src/screens/mfa-login-options/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L26) +Defined in: [src/screens/mfa-login-options/index.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L26) Creates an instance of MfaLoginOptions screen manager @@ -94,7 +48,7 @@ Creates an instance of MfaLoginOptions screen manager <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -109,7 +63,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -124,7 +78,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -139,7 +93,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -154,7 +108,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions">ScreenMembersOnMfaLoginOptions</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions)*/} -Defined in: [src/screens/mfa-login-options/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L22) +Defined in: [src/screens/mfa-login-options/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L22) The screen object for the mfa-login-options screen @@ -171,7 +125,7 @@ The screen object for the mfa-login-options screen <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -186,7 +140,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -201,7 +155,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -216,7 +170,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -231,7 +185,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_LOGIN_OPTIONS`*/} -Defined in: [src/screens/mfa-login-options/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L17) +Defined in: [src/screens/mfa-login-options/index.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L17) #### Overrides @@ -243,7 +197,7 @@ Defined in: [src/screens/mfa-login-options/index.ts:17](https://github.com/auth0 <ParamField body='enroll' type='Promise<void>'> {/*> **enroll**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-login-options/index.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L43) +Defined in: [src/screens/mfa-login-options/index.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L43) Continues the login process with the selected MFA factor @@ -277,7 +231,7 @@ await mfaLoginOptions.enroll({ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -296,7 +250,7 @@ An array of error objects from the transaction context. <ParamField body='returnToPrevious' type='Promise<void>'> {/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-login-options/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L58) +Defined in: [src/screens/mfa-login-options/index.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-login-options/index.ts#L58) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpChallenge.mdx index ba7e36590..fb09fcbac 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpChallenge.mdx @@ -2,7 +2,7 @@ title: "MfaOtpChallenge" --- -Defined in: [src/screens/mfa-otp-challenge/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L24) +Defined in: [src/screens/mfa-otp-challenge/index.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L24) Class implementing the mfa-otp-challenge screen functionality This screen is shown when a user needs to enter an OTP code during MFA @@ -10,72 +10,13 @@ This screen is shown when a user needs to enter an OTP code during MFA <RequestExample> ```ts -export default class MfaOtpChallenge extends BaseContext implements MfaOtpChallengeMembers { - static screenIdentifier: string = ScreenIds.MFA_OTP_CHALLENGE; - screen: ScreenOptions; - untrustedData: UntrustedDataOptions; - - /** - * Creates an instance of MfaOtpChallenge screen manager - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - const untrustedDataContext = this.getContext('untrusted_data') as UntrustedDataContext; - this.screen = new ScreenOverride(screenContext); - this.untrustedData = new UntrustedDataOverride(untrustedDataContext); - } - - /** - * Continues with the OTP challenge using the provided code - * @param payload The options containing the code and rememberDevice flag - * @example - * ```typescript - * import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge'; - * - * const mfaOtpChallenge = new MfaOtpChallenge(); - * await mfaOtpChallenge.continue({ - * code: '123456', - * rememberDevice: true - * }); - * ``` - */ - async continue(payload: ContinueOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaOtpChallenge.screenIdentifier, 'continue'], - }; - - const { rememberDevice, ...restPayload } = payload || {}; - const submitPayload: Record<string, string | number | boolean> = { ...restPayload, action: FormActions.DEFAULT }; - - if (rememberDevice) { - submitPayload.rememberBrowser = true; - } - - await new FormHandler(options).submitData(submitPayload); - } - - /** - * Allows the user to try another MFA method - * @param payload Optional custom options to include with the request - * @example - * ```typescript - * import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge'; - * - * const mfaOtpChallenge = new MfaOtpChallenge(); - * await mfaOtpChallenge.tryAnotherMethod(); - * ``` - */ - async tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaOtpChallenge.screenIdentifier, 'tryAnotherMethod'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.PICK_AUTHENTICATOR }); - } -} +import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge'; + +const mfaOtpChallenge = new MfaOtpChallenge(); +await mfaOtpChallenge.continue({ + code: '123456', + rememberDevice: true +}); ``` </RequestExample> @@ -92,7 +33,7 @@ export default class MfaOtpChallenge extends BaseContext implements MfaOtpChalle <ParamField body="MfaOtpChallenge" type="Constructor"> {/*> **new MfaOtpChallenge**(): `MfaOtpChallenge`*/} -Defined in: [src/screens/mfa-otp-challenge/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L32) +Defined in: [src/screens/mfa-otp-challenge/index.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L32) Creates an instance of MfaOtpChallenge screen manager @@ -110,7 +51,7 @@ Creates an instance of MfaOtpChallenge screen manager <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -125,7 +66,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -140,7 +81,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -155,7 +96,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -170,7 +111,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge">ScreenMembersOnMfaOtpChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge)*/} -Defined in: [src/screens/mfa-otp-challenge/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L26) +Defined in: [src/screens/mfa-otp-challenge/index.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L26) #### Implementation of @@ -185,7 +126,7 @@ Defined in: [src/screens/mfa-otp-challenge/index.ts:26](https://github.com/auth0 <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -200,7 +141,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -215,7 +156,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge">UntrustedDataMembersOnMfaOtpChallenge</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge)*/} -Defined in: [src/screens/mfa-otp-challenge/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L27) +Defined in: [src/screens/mfa-otp-challenge/index.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L27) #### Implementation of @@ -230,7 +171,7 @@ Defined in: [src/screens/mfa-otp-challenge/index.ts:27](https://github.com/auth0 <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -245,7 +186,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_OTP_CHALLENGE`*/} -Defined in: [src/screens/mfa-otp-challenge/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L25) +Defined in: [src/screens/mfa-otp-challenge/index.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L25) #### Overrides @@ -257,7 +198,7 @@ Defined in: [src/screens/mfa-otp-challenge/index.ts:25](https://github.com/auth0 <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-otp-challenge/index.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L54) +Defined in: [src/screens/mfa-otp-challenge/index.ts:54](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L54) Continues with the OTP challenge using the provided code @@ -294,7 +235,7 @@ await mfaOtpChallenge.continue({ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -313,7 +254,7 @@ An array of error objects from the transaction context. <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-otp-challenge/index.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L81) +Defined in: [src/screens/mfa-otp-challenge/index.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-challenge/index.ts#L81) Allows the user to try another MFA method diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentCode.mdx index 8cf991fc2..be2fbb6b2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentCode.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentCode.mdx @@ -2,7 +2,7 @@ title: "MfaOtpEnrollmentCode" --- -Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L21) +Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L21) Class implementing the mfa-otp-enrollment-code screen functionality. This screen is displayed when the user needs to enter the OTP code received during MFA enrollment. @@ -10,75 +10,12 @@ This screen is displayed when the user needs to enter the OTP code received duri <RequestExample> ```ts -export default class MfaOtpEnrollmentCode extends BaseContext implements MfaOtpEnrollmentCodeMembers { - /** - * Screen identifier for validation and telemetry - */ - static screenIdentifier: string = ScreenIds.MFA_OTP_ENROLLMENT_CODE; - /** - * The screen properties for the mfa-otp-enrollment-code screen. - */ - screen: ScreenOptions; - - /** - * Creates an instance of MfaOtpEnrollmentCode. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Continues the MFA OTP enrollment process by submitting the OTP code. - * - * @param {ContinueOptions} payload - The options containing the OTP code. - * @returns {Promise<void>} - * @example - * ```typescript - * import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; - * - * const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); - * await mfaOtpEnrollmentCode.continue({ - * code: '123456', - * }); - * ``` - */ - async continue(payload: ContinueOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaOtpEnrollmentCode.screenIdentifier, 'continue'], - }; - await new FormHandler(options).submitData<ContinueOptions>({ - ...payload, - action: FormActions.DEFAULT, - }); - } - - /** - * Allows the user to try another MFA method. - * - * @param {TryAnotherMethodOptions} [payload] - Optional payload. - * @returns {Promise<void>} - * @example - * ```typescript - * import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; - * - * const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); - * await mfaOtpEnrollmentCode.tryAnotherMethod(); - * ``` - */ - async tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaOtpEnrollmentCode.screenIdentifier, 'tryAnotherMethod'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } -} +import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; + +const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); +await mfaOtpEnrollmentCode.continue({ + code: '123456', +}); ``` </RequestExample> @@ -95,7 +32,7 @@ export default class MfaOtpEnrollmentCode extends BaseContext implements MfaOtpE <ParamField body="MfaOtpEnrollmentCode" type="Constructor"> {/*> **new MfaOtpEnrollmentCode**(): `MfaOtpEnrollmentCode`*/} -Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L34) +Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L34) Creates an instance of MfaOtpEnrollmentCode. @@ -113,7 +50,7 @@ Creates an instance of MfaOtpEnrollmentCode. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -128,7 +65,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -143,7 +80,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -158,7 +95,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -173,7 +110,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode">ScreenMembersOnMfaOtpEnrollmentCode</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaOtpEnrollmentCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode)*/} -Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L29) +Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L29) The screen properties for the mfa-otp-enrollment-code screen. @@ -190,7 +127,7 @@ The screen properties for the mfa-otp-enrollment-code screen. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -205,7 +142,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -220,7 +157,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -235,7 +172,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -250,7 +187,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_OTP_ENROLLMENT_CODE`*/} -Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L25) +Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L25) Screen identifier for validation and telemetry @@ -264,7 +201,7 @@ Screen identifier for validation and telemetry <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L55) +Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:55](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L55) Continues the MFA OTP enrollment process by submitting the OTP code. @@ -300,7 +237,7 @@ await mfaOtpEnrollmentCode.continue({ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -319,7 +256,7 @@ An array of error objects from the transaction context. <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:79](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L79) +Defined in: [src/screens/mfa-otp-enrollment-code/index.ts:79](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L79) Allows the user to try another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentQr.mdx index dad4a4695..3250e8936 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentQr.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentQr.mdx @@ -2,100 +2,17 @@ title: "MfaOtpEnrollmentQr" --- -Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L19) +Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L19) Class implementing the mfa-otp-enrollment-qr screen functionality <RequestExample> ```ts -export default class MfaOtpEnrollmentQr extends BaseContext implements MfaOtpEnrollmentQrMembers { - /** - * Screen identifier for validation and telemetry - */ - static screenIdentifier: string = ScreenIds.MFA_OTP_ENROLLMENT_QR; - screen: ScreenOptions; - - /** - * Creates an instance of MfaOtpEnrollmentQr screen manager - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Navigates to the authenticator selection screen. - * @param {object} payload - An object containing any custom options. - * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. - * - * - * @example - * ```typescript - * import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; - * - * const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); - * await mfaOtpEnrollmentQr.toggleView(); - * ``` - */ - async toggleView(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaOtpEnrollmentQr.screenIdentifier, 'toggleView'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.TOGGLE_VIEW, - }); - } - - /** - * Continues with the default action. - * - * @param {ContinueOptions} payload - Payload including the OTP code and optional custom options. - * @returns {Promise<void>} - * @example - * ```typescript - * import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; - * - * const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); - * await mfaOtpEnrollmentQr.continue({ code: '123456' }); - * ``` - */ - async continue(payload: ContinueOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaOtpEnrollmentQr.screenIdentifier, 'continue'], - }; - await new FormHandler(options).submitData({ - ...payload, - action: FormActions.DEFAULT, - }); - } - - /** - * Navigates to the authenticator selection screen. - * @param payload Optional custom options to include with the request - * @example - * ```typescript - * import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; - * - * const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); - * await mfaOtpEnrollmentQr.tryAnotherMethod(); - * ``` - */ - async tryAnotherMethod(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaOtpEnrollmentQr.screenIdentifier, 'tryAnotherMethod'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } -} +import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; + +const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); +await mfaOtpEnrollmentQr.toggleView(); ``` </RequestExample> @@ -112,7 +29,7 @@ export default class MfaOtpEnrollmentQr extends BaseContext implements MfaOtpEnr <ParamField body="MfaOtpEnrollmentQr" type="Constructor"> {/*> **new MfaOtpEnrollmentQr**(): `MfaOtpEnrollmentQr`*/} -Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L29) +Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L29) Creates an instance of MfaOtpEnrollmentQr screen manager @@ -130,7 +47,7 @@ Creates an instance of MfaOtpEnrollmentQr screen manager <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -145,7 +62,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -160,7 +77,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -175,7 +92,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -190,7 +107,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr">ScreenMembersOnMfaOtpEnrollmentQr</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaOtpEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr)*/} -Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L24) +Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L24) #### Implementation of @@ -205,7 +122,7 @@ Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:24](https://github.com/a <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -220,7 +137,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -235,7 +152,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -250,7 +167,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -265,7 +182,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_OTP_ENROLLMENT_QR`*/} -Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L23) +Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L23) Screen identifier for validation and telemetry @@ -279,7 +196,7 @@ Screen identifier for validation and telemetry <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:73](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L73) +Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:73](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L73) Continues with the default action. @@ -313,7 +230,7 @@ await mfaOtpEnrollmentQr.continue({ code: '123456' }); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -332,7 +249,7 @@ An array of error objects from the transaction context. <ParamField body='toggleView' type='Promise<void>'> {/*> **toggleView**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L49) +Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L49) Navigates to the authenticator selection screen. @@ -368,7 +285,7 @@ await mfaOtpEnrollmentQr.toggleView(); <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:95](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L95) +Defined in: [src/screens/mfa-otp-enrollment-qr/index.ts:95](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L95) Navigates to the authenticator selection screen. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneChallenge.mdx index d67b07615..51c5bdabe 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneChallenge.mdx @@ -2,112 +2,18 @@ title: "MfaPhoneChallenge" --- -Defined in: [src/screens/mfa-phone-challenge/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L28) +Defined in: [src/screens/mfa-phone-challenge/index.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L28) MfaPhoneChallenge <RequestExample> ```ts -export default class MfaPhoneChallenge extends BaseContext implements MfaPhoneChallengeMembers { - /** - * The unique identifier for this screen. - */ - static screenIdentifier: string = ScreenIds.MFA_PHONE_CHALLENGE; // Use the exact screen name from context - - /** - * Holds the specific screen data for the MFA Phone Challenge. - */ - screen: ScreenOptions; - - /** - * Initializes a new instance of the `MfaPhoneChallenge` class. - * It sets up the screen-specific data by creating an instance of `ScreenOverride`. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Submits the user's choice of receiving the MFA code via SMS or voice call. - * It uses the phone number provided in the screen context. - * - * @param {ContinueOptions} payload - Options containing the delivery type ('sms' or 'voice'). - * @returns {Promise<void>} A promise that resolves upon successful submission. - * @throws {Error} Throws an error if the phone number is not available in the screen context or if the submission fails. - * @example - * ```typescript - * const mfaPhoneChallenge = new MfaPhoneChallenge(); - * // Request code via SMS - * await mfaPhoneChallenge.continue({ type: 'sms' }); - * // Request code via Voice Call - * await mfaPhoneChallenge.continue({ type: 'voice' }); - * ``` - */ - async continue(payload: ContinueOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaPhoneChallenge.screenIdentifier, 'continue'], - }; - - await new FormHandler(options).submitData<ContinueOptions & { action: string }>({ - ...payload, // Includes type: 'sms' | 'voice' - action: FormActions.DEFAULT, // Use the default action for submission - }); - } - - /** - * Initiates the process for the user to select a different phone number (if applicable). - * This typically triggers a navigation to a phone selection screen. - * - * @param {PickPhoneOptions} [payload] - Optional custom options for the request. - * @returns {Promise<void>} A promise that resolves upon successful submission. - * @throws {Error} Throws an error if the submission fails. - * @example - * ```typescript - * const mfaPhoneChallenge = new MfaPhoneChallenge(); - * await mfaPhoneChallenge.pickPhone(); - * ``` - */ - async pickPhone(payload?: PickPhoneOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaPhoneChallenge.screenIdentifier, 'pickPhone'], - }; - - await new FormHandler(options).submitData<PickPhoneOptions & { action: string }>({ - ...payload, - action: 'pick-phone', // Specific action for picking phone - }); - } - - /** - * Allows the user to choose a different MFA method (e.g., OTP, Recovery Code). - * This typically triggers navigation to the authenticator selection screen. - * - * @param {PickAuthenticatorOptions} [payload] - Optional custom options for the request. - * @returns {Promise<void>} A promise that resolves upon successful submission. - * @throws {Error} Throws an error if the submission fails. - * @example - * ```typescript - * const mfaPhoneChallenge = new MfaPhoneChallenge(); - * await mfaPhoneChallenge.tryAnotherMethod(); - * ``` - */ - async tryAnotherMethod(payload?: PickAuthenticatorOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaPhoneChallenge.screenIdentifier, 'tryAnotherMethod'], - }; - - await new FormHandler(options).submitData<PickAuthenticatorOptions & { action: string }>({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, // Standard action for picking authenticator - }); - } -} +const mfaPhoneChallenge = new MfaPhoneChallenge(); +// Request code via SMS +await mfaPhoneChallenge.continue({ type: 'sms' }); +// Request code via Voice Call +await mfaPhoneChallenge.continue({ type: 'voice' }); ``` </RequestExample> @@ -124,7 +30,7 @@ export default class MfaPhoneChallenge extends BaseContext implements MfaPhoneCh <ParamField body="MfaPhoneChallenge" type="Constructor"> {/*> **new MfaPhoneChallenge**(): `MfaPhoneChallenge`*/} -Defined in: [src/screens/mfa-phone-challenge/index.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L43) +Defined in: [src/screens/mfa-phone-challenge/index.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L43) Initializes a new instance of the `MfaPhoneChallenge` class. It sets up the screen-specific data by creating an instance of `ScreenOverride`. @@ -143,7 +49,7 @@ It sets up the screen-specific data by creating an instance of `ScreenOverride`. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -158,7 +64,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -173,7 +79,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -188,7 +94,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -203,7 +109,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge">ScreenMembersOnMfaPhoneChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge)*/} -Defined in: [src/screens/mfa-phone-challenge/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L37) +Defined in: [src/screens/mfa-phone-challenge/index.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L37) Holds the specific screen data for the MFA Phone Challenge. @@ -220,7 +126,7 @@ Holds the specific screen data for the MFA Phone Challenge. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -235,7 +141,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -250,7 +156,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -265,7 +171,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -280,7 +186,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PHONE_CHALLENGE`*/} -Defined in: [src/screens/mfa-phone-challenge/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L32) +Defined in: [src/screens/mfa-phone-challenge/index.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L32) The unique identifier for this screen. @@ -294,7 +200,7 @@ The unique identifier for this screen. <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-phone-challenge/index.ts:65](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L65) +Defined in: [src/screens/mfa-phone-challenge/index.ts:65](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L65) Submits the user's choice of receiving the MFA code via SMS or voice call. It uses the phone number provided in the screen context. @@ -336,7 +242,7 @@ await mfaPhoneChallenge.continue({ type: 'voice' }); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -355,7 +261,7 @@ An array of error objects from the transaction context. <ParamField body='pickPhone' type='Promise<void>'> {/*> **pickPhone**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-phone-challenge/index.ts:90](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L90) +Defined in: [src/screens/mfa-phone-challenge/index.ts:90](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L90) Initiates the process for the user to select a different phone number (if applicable). This typically triggers a navigation to a phone selection screen. @@ -394,7 +300,7 @@ await mfaPhoneChallenge.pickPhone(); <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-phone-challenge/index.ts:115](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L115) +Defined in: [src/screens/mfa-phone-challenge/index.ts:115](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-phone-challenge/index.ts#L115) Allows the user to choose a different MFA method (e.g., OTP, Recovery Code). This typically triggers navigation to the authenticator selection screen. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneEnrollment.mdx index cfa94dd4a..49896184a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneEnrollment.mdx @@ -2,7 +2,7 @@ title: "MfaPhoneEnrollment" --- -Defined in: [src/screens/mfa-phone-enrollment/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L12) +Defined in: [src/screens/mfa-phone-enrollment/index.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L12) Class implementing the mfa-phone-enrollment screen functionality. This screen allows users to enroll using a phone number for MFA. @@ -10,32 +10,17 @@ This screen allows users to enroll using a phone number for MFA. <RequestExample> ```ts -export default class MfaPhoneEnrollment extends BaseContext implements MfaPhoneEnrollmentMembers { - static screenIdentifier: string = ScreenIds.MFA_PHONE_ENROLLMENT; - - /** - * Creates an instance of the MfaPhoneEnrollment screen. - */ - constructor() { - super(); - } - - /** - * Navigates to the country code selection screen. - * @param payload Optional custom options to include with the request. - * @example - * ```typescript - * import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; - * const mfaPhoneEnrollmentManager = new MfaPhoneEnrollment(); - * async function handlePickCountryCode() { - * try { - * await mfaPhoneEnrollmentManager.pickCountryCode(); - * console.log('Country code selection successful.'); - * } catch (error) { - * console.error('Error selecting country code:', error); - * } - * } - */ +import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; +const mfaPhoneEnrollmentManager = new MfaPhoneEnrollment(); +async function handlePickCountryCode() { + try { + await mfaPhoneEnrollmentManager.pickCountryCode(); + console.log('Country code selection successful.'); + } catch (error) { + console.error('Error selecting country code:', error); + } +} +/ async pickCountryCode(payload?: CustomOptions): Promise<void> { const options = { state: this.transaction.state, @@ -48,64 +33,9 @@ export default class MfaPhoneEnrollment extends BaseContext implements MfaPhoneE } /** - * Continues the enrollment process with the provided phone number and type (SMS or voice). - * @param payload The phone number and type (SMS or voice). - * @example - * ```typescript - * import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; - * const mfaPhoneEnrollmentManager = new MfaPhoneEnrollment(); - * async function handleContinueEnrollment() { - * try { - * await mfaPhoneEnrollmentManager.continueEnrollment({ - * phone: '+1234567890', - * type: 'sms', // or 'voice' - * }); - * console.log('Phone enrollment continued successfully.'); - * } catch (error) { - * console.error('Error continuing phone enrollment:', error); - * } - * } - * ``` - */ - async continueEnrollment(payload: ContinueOptions): Promise<void> { - const options = { - state: this.transaction.state, - telemetry: [MfaPhoneEnrollment.screenIdentifier, 'continueEnrollment'], - }; - await new FormHandler(options).submitData({ - ...payload, - action: 'default', - }); - } - - /** - * Allows the user to try another MFA method. - * @param payload Optional custom options to include with the request. - * @example - * ```typescript - * import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment'; - * const mfaPhoneEnrollmentManager = new MfaPhoneEnrollment(); - * async function handleTryAnotherMethod() { - * try { - * await mfaPhoneEnrollmentManager.tryAnotherMethod(); - * console.log('Switched to another authentication method.'); - * } catch (error) { - * console.error('Error switching authenticator method:', error); - * } - * } - * ``` - */ - async tryAnotherMethod(payload?: CustomOptions): Promise<void> { - const options = { - state: this.transaction.state, - telemetry: [MfaPhoneEnrollment.screenIdentifier, 'tryAnotherMethod'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: 'pick-authenticator', - }); - } -} +Continues the enrollment process with the provided phone number and type (SMS or voice). +@param payload The phone number and type (SMS or voice). +@example ``` </RequestExample> @@ -122,7 +52,7 @@ export default class MfaPhoneEnrollment extends BaseContext implements MfaPhoneE <ParamField body="MfaPhoneEnrollment" type="Constructor"> {/*> **new MfaPhoneEnrollment**(): `MfaPhoneEnrollment`*/} -Defined in: [src/screens/mfa-phone-enrollment/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L18) +Defined in: [src/screens/mfa-phone-enrollment/index.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L18) Creates an instance of the MfaPhoneEnrollment screen. @@ -140,7 +70,7 @@ Creates an instance of the MfaPhoneEnrollment screen. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -155,7 +85,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -170,7 +100,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -185,7 +115,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -200,7 +130,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -215,7 +145,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -230,7 +160,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -245,7 +175,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -260,7 +190,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -275,7 +205,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PHONE_ENROLLMENT`*/} -Defined in: [src/screens/mfa-phone-enrollment/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L13) +Defined in: [src/screens/mfa-phone-enrollment/index.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L13) #### Overrides @@ -287,7 +217,7 @@ Defined in: [src/screens/mfa-phone-enrollment/index.ts:13](https://github.com/au <ParamField body='continueEnrollment' type='Promise<void>'> {/*> **continueEnrollment**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-phone-enrollment/index.ts:69](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L69) +Defined in: [src/screens/mfa-phone-enrollment/index.ts:69](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L69) Continues the enrollment process with the provided phone number and type (SMS or voice). @@ -330,7 +260,7 @@ async function handleContinueEnrollment() { <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -349,7 +279,7 @@ An array of error objects from the transaction context. <ParamField body='pickCountryCode' type='Promise<void>'> {/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-phone-enrollment/index.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L38) +Defined in: [src/screens/mfa-phone-enrollment/index.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L38) Navigates to the country code selection screen. @@ -389,7 +319,7 @@ async function handlePickCountryCode() { <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-phone-enrollment/index.ts:97](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L97) +Defined in: [src/screens/mfa-phone-enrollment/index.ts:97](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-phone-enrollment/index.ts#L97) Allows the user to try another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushChallengePush.mdx index 60e8ad913..342e24cf5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushChallengePush.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushChallengePush.mdx @@ -2,7 +2,7 @@ title: "MfaPushChallengePush" --- -Defined in: [src/screens/mfa-push-challenge-push/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L28) +Defined in: [src/screens/mfa-push-challenge-push/index.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L28) Class implementing the mfa-push-challenge-push screen functionality This screen is shown when a user needs to confirm a push notification during MFA @@ -10,7 +10,8 @@ This screen is shown when a user needs to confirm a push notification during MFA <RequestExample> ```ts -export default class MfaPushChallengePush +const mfaPushChallengePush = new MfaPushChallengePush(); +await mfaPushChallengePush.continue(); ``` </RequestExample> @@ -27,7 +28,7 @@ export default class MfaPushChallengePush <ParamField body="MfaPushChallengePush" type="Constructor"> {/*> **new MfaPushChallengePush**(): `MfaPushChallengePush`*/} -Defined in: [src/screens/mfa-push-challenge-push/index.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L39) +Defined in: [src/screens/mfa-push-challenge-push/index.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L39) Creates an instance of MfaPushChallengePush screen manager @@ -45,7 +46,7 @@ Creates an instance of MfaPushChallengePush screen manager <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -60,7 +61,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -75,7 +76,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -90,7 +91,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -105,7 +106,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush">ScreenMembersOnMfaPushChallengePush</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush)*/} -Defined in: [src/screens/mfa-push-challenge-push/index.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L33) +Defined in: [src/screens/mfa-push-challenge-push/index.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L33) #### Implementation of @@ -120,7 +121,7 @@ Defined in: [src/screens/mfa-push-challenge-push/index.ts:33](https://github.com <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -135,7 +136,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -150,7 +151,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush">UntrustedDataMembersOnMfaPushChallengePush</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush)*/} -Defined in: [src/screens/mfa-push-challenge-push/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L34) +Defined in: [src/screens/mfa-push-challenge-push/index.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L34) #### Implementation of @@ -165,7 +166,7 @@ Defined in: [src/screens/mfa-push-challenge-push/index.ts:34](https://github.com <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -180,7 +181,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PUSH_CHALLENGE_PUSH`*/} -Defined in: [src/screens/mfa-push-challenge-push/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L32) +Defined in: [src/screens/mfa-push-challenge-push/index.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L32) #### Overrides @@ -192,7 +193,7 @@ Defined in: [src/screens/mfa-push-challenge-push/index.ts:32](https://github.com <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-push-challenge-push/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L58) +Defined in: [src/screens/mfa-push-challenge-push/index.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L58) Continues with the push notification challenge @@ -224,7 +225,7 @@ await mfaPushChallengePush.continue(); <ParamField body='enterCodeManually' type='Promise<void>'> {/*> **enterCodeManually**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-push-challenge-push/index.ts:110](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L110) +Defined in: [src/screens/mfa-push-challenge-push/index.ts:110](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L110) Switches to entering the verification code manually @@ -256,7 +257,7 @@ await mfaPushChallengePush.enterCodeManually(); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -275,7 +276,7 @@ An array of error objects from the transaction context. <ParamField body='pollingManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> {/*> **pollingManager**(`options`): [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl)*/} -Defined in: [src/screens/mfa-push-challenge-push/index.ts:183](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L183) +Defined in: [src/screens/mfa-push-challenge-push/index.ts:183](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L183) **`Utility Feature`** @@ -339,7 +340,7 @@ control.stopPolling(); <ParamField body='resendPushNotification' type='Promise<void>'> {/*> **resendPushNotification**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-push-challenge-push/index.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L85) +Defined in: [src/screens/mfa-push-challenge-push/index.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L85) Resends the push notification @@ -371,7 +372,7 @@ await mfaPushChallengePush.resendPushNotification(); <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-push-challenge-push/index.ts:130](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L130) +Defined in: [src/screens/mfa-push-challenge-push/index.ts:130](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L130) Allows trying another authentication method diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushEnrollmentQr.mdx index a4e040a01..32f2d8670 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushEnrollmentQr.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushEnrollmentQr.mdx @@ -2,91 +2,17 @@ title: "MfaPushEnrollmentQr" --- -Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L20) +Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L20) Class implementing the mfa-push-enrollment-qr screen functionality <RequestExample> ```ts -export default class MfaPushEnrollmentQr extends BaseContext implements MfaPushEnrollmentQrMembers { - static screenIdentifier: string = ScreenIds.MFA_PUSH_ENROLLMENT_QR; - screen: ScreenOptions; - - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Navigates to the authenticator selection screen. - * @param payload Optional custom options to include with the request - * @example - * ```typescript - * import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr'; - * - * const mfaPushEnrollmentQr = new MfaPushEnrollmentQr(); - * await mfaPushEnrollmentQr.pickAuthenticator(); - * ``` - */ - async pickAuthenticator(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaPushEnrollmentQr.screenIdentifier, 'pickAuthenticator'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } - -/** - * Starts and manages polling for an MFA push challenge. - * - * Creates a polling session that repeatedly checks the MFA push challenge endpoint - * at the specified interval until the challenge is approved or an error occurs. - * When the approval condition is met, the provided - * {@link MfaPollingOptions.onCompleted | onCompleted} callback is invoked and - * polling stops automatically. - * - * Use the returned {@link MfaPushPollingControl} to start, stop, or check the - * status of the polling process at any time. - * - * @param options - {@link MfaPollingOptions | Configuration options} for the polling process: - * - `intervalMs` — Optional polling interval in milliseconds (defaults to SDK’s internal value, typically 5000 ms). - * - `onCompleted` — Optional callback fired when the MFA push is successfully approved. - * - `onError` — Optional callback fired when a polling error occurs, receiving an {@link ULError}. - * - * @returns A {@link MfaPushPollingControl} instance exposing: - * - `startPolling()` — Starts or resumes polling. - * - `stopPolling()` — Cancels polling immediately. - * - `isRunning()` — Indicates whether polling is currently active. - * - * @utilityFeature - * - * @example - * ```ts - * // Start polling every 5 seconds until the push challenge is approved - * const control = mfaPushChallengePush.pollingManager({ - * intervalMs: 5000, - * onCompleted: () => mfaPushChallengePush.continue(), - * onError: (error) => console.error('Polling error:', error), - * }); - * - * // Later, cancel polling if needed - * control.stopPolling(); - * ``` - * - * @remarks - * - HTTP 429 (rate limit) responses are handled internally: polling automatically - * waits until the rate limit resets before retrying. - * - Safe to call `startPolling()` multiple times; it has no effect if already running. - */ - pollingManager(options: MfaPollingOptions): MfaPushPollingControl { - return createPollingControl(options); - } -} +import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr'; + +const mfaPushEnrollmentQr = new MfaPushEnrollmentQr(); +await mfaPushEnrollmentQr.pickAuthenticator(); ``` </RequestExample> @@ -103,7 +29,7 @@ export default class MfaPushEnrollmentQr extends BaseContext implements MfaPushE <ParamField body="MfaPushEnrollmentQr" type="Constructor"> {/*> **new MfaPushEnrollmentQr**(): `MfaPushEnrollmentQr`*/} -Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L24) +Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L24) #### Returns @@ -119,7 +45,7 @@ Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:24](https://github.com/ <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -134,7 +60,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -149,7 +75,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -164,7 +90,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -179,7 +105,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr">ScreenMembersOnMfaPushEnrollmentQr</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaPushEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr)*/} -Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L22) +Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L22) #### Implementation of @@ -194,7 +120,7 @@ Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:22](https://github.com/ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -209,7 +135,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -224,7 +150,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -239,7 +165,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -254,7 +180,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PUSH_ENROLLMENT_QR`*/} -Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L21) +Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L21) #### Overrides @@ -266,7 +192,7 @@ Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:21](https://github.com/ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -285,7 +211,7 @@ An array of error objects from the transaction context. <ParamField body='pickAuthenticator' type='Promise<void>'> {/*> **pickAuthenticator**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L41) +Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L41) Navigates to the authenticator selection screen. @@ -319,7 +245,7 @@ await mfaPushEnrollmentQr.pickAuthenticator(); <ParamField body='pollingManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> {/*> **pollingManager**(`options`): [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl)*/} -Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:94](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L94) +Defined in: [src/screens/mfa-push-enrollment-qr/index.ts:94](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L94) **`Utility Feature`** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushList.mdx index eeaf7a2e0..475650b4c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushList.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushList.mdx @@ -2,69 +2,17 @@ title: "MfaPushList" --- -Defined in: [src/screens/mfa-push-list/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts#L12) +Defined in: [src/screens/mfa-push-list/index.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts#L12) Class implementing the mfa-push-list screen functionality <RequestExample> ```ts -export default class MfaPushList extends BaseContext implements MfaPushListMembers { - static screenIdentifier: string = ScreenIds.MFA_PUSH_LIST; - - constructor() { - super(); - } - - /** - * Selects a registered device from the list to initiate MFA push. - * - * @param payload The options containing the device index. - * @example - * ```typescript - * import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; - * - * const mfaPushList = new MfaPushList(); - * await mfaPushList.selectMfaPushDevice({ deviceIndex: 0 }); - * ``` - */ - async selectMfaPushDevice(payload: SelectMfaPushDeviceOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaPushList.screenIdentifier, 'selectMfaPushDevice'], - }; - - const { deviceIndex, ...restPayload } = payload; - - await new FormHandler(options).submitData<Omit<SelectMfaPushDeviceOptions, 'deviceIndex'>>({ - ...restPayload, - action: `selection-action::${deviceIndex}`, - }); - } - - /** - * Navigates back to the previous screen. - * @param payload Optional custom options to include with the request. - * @example - * ```typescript - * import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; - * - * const mfaPushList = new MfaPushList(); - * await mfaPushList.goBack(); - * ``` - */ - async goBack(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaPushList.screenIdentifier, 'goBack'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.BACK, - }); - } -} +import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; + +const mfaPushList = new MfaPushList(); +await mfaPushList.selectMfaPushDevice({ deviceIndex: 0 }); ``` </RequestExample> @@ -81,7 +29,7 @@ export default class MfaPushList extends BaseContext implements MfaPushListMembe <ParamField body="MfaPushList" type="Constructor"> {/*> **new MfaPushList**(): `MfaPushList`*/} -Defined in: [src/screens/mfa-push-list/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts#L15) +Defined in: [src/screens/mfa-push-list/index.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts#L15) #### Returns @@ -97,7 +45,7 @@ Defined in: [src/screens/mfa-push-list/index.ts:15](https://github.com/auth0/uni <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -112,7 +60,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -127,7 +75,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -142,7 +90,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -157,7 +105,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -172,7 +120,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -187,7 +135,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -202,7 +150,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -217,7 +165,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -232,7 +180,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PUSH_LIST`*/} -Defined in: [src/screens/mfa-push-list/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts#L13) +Defined in: [src/screens/mfa-push-list/index.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts#L13) #### Overrides @@ -244,7 +192,7 @@ Defined in: [src/screens/mfa-push-list/index.ts:13](https://github.com/auth0/uni <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -263,7 +211,7 @@ An array of error objects from the transaction context. <ParamField body='goBack' type='Promise<void>'> {/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-push-list/index.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts#L56) +Defined in: [src/screens/mfa-push-list/index.ts:56](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts#L56) Navigates back to the previous screen. @@ -297,7 +245,7 @@ await mfaPushList.goBack(); <ParamField body='selectMfaPushDevice' type='Promise<void>'> {/*> **selectMfaPushDevice**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-push-list/index.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts#L31) +Defined in: [src/screens/mfa-push-list/index.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-list/index.ts#L31) Selects a registered device from the list to initiate MFA push. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushWelcome.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushWelcome.mdx index ee162ef27..fbe8964db 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushWelcome.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushWelcome.mdx @@ -2,68 +2,15 @@ title: "MfaPushWelcome" --- -Defined in: [src/screens/mfa-push-welcome/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L14) +Defined in: [src/screens/mfa-push-welcome/index.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L14) <RequestExample> ```ts -export default class MfaPushWelcome extends BaseContext implements MfaPushWelcomeMembers { - static screenIdentifier: string = ScreenIds.MFA_PUSH_WELCOME; - screen: ScreenOptions; - - /** - * Initializes the MfaPushWelcome screen with data from the Universal Login Context. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = screenContext as ScreenOptions; - } - - /** - * Navigates to the enrollment screen. - * @param {CustomOptions} [payload] - Optional custom options to include with the request. - * @example - * ```typescript - * import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome'; - * - * const mfaPushWelcome = new MfaPushWelcome(); - * await mfaPushWelcome.enroll(); - * ``` - */ - async enroll(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaPushWelcome.screenIdentifier, 'enroll'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.ENROLL, - }); - } - - /** - * Navigates to the authenticator selection screen. - * @param {CustomOptions} [payload] - Optional custom options to include with the request. - * @example - * ```typescript - * import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome'; - * - * const mfaPushWelcome = new MfaPushWelcome(); - * await mfaPushWelcome.pickAuthenticator(); - * ``` - */ - async pickAuthenticator(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaPushWelcome.screenIdentifier, 'pickAuthenticator'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } -} +import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome'; + +const mfaPushWelcome = new MfaPushWelcome(); +await mfaPushWelcome.enroll(); ``` </RequestExample> @@ -80,7 +27,7 @@ export default class MfaPushWelcome extends BaseContext implements MfaPushWelcom <ParamField body="MfaPushWelcome" type="Constructor"> {/*> **new MfaPushWelcome**(): `MfaPushWelcome`*/} -Defined in: [src/screens/mfa-push-welcome/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L21) +Defined in: [src/screens/mfa-push-welcome/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L21) Initializes the MfaPushWelcome screen with data from the Universal Login Context. @@ -98,7 +45,7 @@ Initializes the MfaPushWelcome screen with data from the Universal Login Context <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -113,7 +60,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -128,7 +75,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -143,7 +90,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -158,7 +105,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome">ScreenMembersOnMfaPushWelcome</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaPushWelcome`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome)*/} -Defined in: [src/screens/mfa-push-welcome/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L16) +Defined in: [src/screens/mfa-push-welcome/index.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L16) #### Implementation of @@ -173,7 +120,7 @@ Defined in: [src/screens/mfa-push-welcome/index.ts:16](https://github.com/auth0/ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -188,7 +135,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -203,7 +150,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -218,7 +165,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -233,7 +180,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PUSH_WELCOME`*/} -Defined in: [src/screens/mfa-push-welcome/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L15) +Defined in: [src/screens/mfa-push-welcome/index.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L15) #### Overrides @@ -245,7 +192,7 @@ Defined in: [src/screens/mfa-push-welcome/index.ts:15](https://github.com/auth0/ <ParamField body='enroll' type='Promise<void>'> {/*> **enroll**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-push-welcome/index.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L38) +Defined in: [src/screens/mfa-push-welcome/index.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L38) Navigates to the enrollment screen. @@ -279,7 +226,7 @@ await mfaPushWelcome.enroll(); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -298,7 +245,7 @@ An array of error objects from the transaction context. <ParamField body='pickAuthenticator' type='Promise<void>'> {/*> **pickAuthenticator**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-push-welcome/index.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L60) +Defined in: [src/screens/mfa-push-welcome/index.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-welcome/index.ts#L60) Navigates to the authenticator selection screen. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallenge.mdx index ca3cd4b74..67e25ee08 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallenge.mdx @@ -2,85 +2,21 @@ title: "MfaRecoveryCodeChallenge" --- -Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L14) +Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L14) Class implementing the MFA Recovery Code Challenge screen functionality. <RequestExample> ```ts -export default class MfaRecoveryCodeChallenge extends BaseContext implements MfaRecoveryCodeChallengeMembers { - static screenIdentifier: string = ScreenIds.MFA_RECOVERY_CODE_CHALLENGE; - - /** - * Creates an instance of the MfaRecoveryCodeChallenge screen. - */ - constructor() { - super(); - } - - /** - * Continues with the provided recovery code. - * @param payload - The payload containing the recovery code and optional custom options. - * @returns {Promise<void>} - * @example - * ```typescript - * import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge'; - * const mfaRecoveryCodeChallengeManager = new MfaRecoveryCodeChallenge(); - * const handleContinueEnrollment = async () => { - * try { - * await mfaRecoveryCodeChallengeManager.continue('YOUR_RECOVERY_CODE'); - * } catch (error) { - * console.error('Error continuing with recovery code:', error); - * } - * } - * ``` - */ - async continue(payload: ContinueOptions): Promise<void> { - if (!payload || !payload?.code) { - return Promise.reject(new Error('The recovery code is required.')); - } - - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaRecoveryCodeChallenge.screenIdentifier, 'continue'], - }; - - await new FormHandler(options).submitData<ContinueOptions>({ - ...payload, - action: FormActions.DEFAULT, - }); - } - - /** - * Navigates to the screen where the user can pick another MFA method. - * @param payload Optional payload. - * @returns {Promise<void>} - * @example - * ```typescript - * import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge'; - * const mfaRecoveryCodeChallengeManager = new MfaRecoveryCodeChallenge(); - * const switchAuthenticator = async () => { - * try { - * await mfaRecoveryCodeChallengeManager.tryAnotherMethod(); - * console.log('Switched to another authentication method.'); - * } catch (error) { - * console.error('Error switching authenticator:', error); - * } - * }; - * ``` - */ - async tryAnotherMethod(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaRecoveryCodeChallenge.screenIdentifier, 'tryAnotherMethod'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } +import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge'; +const mfaRecoveryCodeChallengeManager = new MfaRecoveryCodeChallenge(); +const handleContinueEnrollment = async () => { + try { + await mfaRecoveryCodeChallengeManager.continue('YOUR_RECOVERY_CODE'); + } catch (error) { + console.error('Error continuing with recovery code:', error); + } } ``` </RequestExample> @@ -98,7 +34,7 @@ export default class MfaRecoveryCodeChallenge extends BaseContext implements Mfa <ParamField body="MfaRecoveryCodeChallenge" type="Constructor"> {/*> **new MfaRecoveryCodeChallenge**(): `MfaRecoveryCodeChallenge`*/} -Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L20) +Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L20) Creates an instance of the MfaRecoveryCodeChallenge screen. @@ -116,7 +52,7 @@ Creates an instance of the MfaRecoveryCodeChallenge screen. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -131,7 +67,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -146,7 +82,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -161,7 +97,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -176,7 +112,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -191,7 +127,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -206,7 +142,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -221,7 +157,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -236,7 +172,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -251,7 +187,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_RECOVERY_CODE_CHALLENGE`*/} -Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L15) +Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L15) #### Overrides @@ -263,7 +199,7 @@ Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:15](https://github <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L41) +Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L41) Continues with the provided recovery code. @@ -302,7 +238,7 @@ const handleContinueEnrollment = async () => { <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -321,7 +257,7 @@ An array of error objects from the transaction context. <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:75](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L75) +Defined in: [src/screens/mfa-recovery-code-challenge/index.ts:75](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L75) Navigates to the screen where the user can pick another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode.mdx index 334a910b9..9c2979ffe 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode.mdx @@ -2,82 +2,24 @@ title: "MfaRecoveryCodeChallengeNewCode" --- -Defined in: [src/screens/mfa-recovery-code-challenge-new-code/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts#L22) +Defined in: [src/screens/mfa-recovery-code-challenge-new-code/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts#L22) MfaRecoveryCodeChallengeNewCode <RequestExample> ```ts -export default class MfaRecoveryCodeChallengeNewCode extends BaseContext implements MfaRecoveryCodeChallengeNewCodeMembers { - /** - * The unique identifier for this screen, used internally and for telemetry. - * @type {string} - */ - static screenIdentifier: string = ScreenIds.MFA_RECOVERY_CODE_CHALLENGE_NEW_CODE - - /** - * Holds the specific screen data and properties, processed by ScreenOverride. - * @type {ScreenMembersOnMfaRecoveryCodeChallengeNewCode} - */ - screen: ScreenMembersOnMfaRecoveryCodeChallengeNewCode; - - /** - * Initializes a new instance of the `MfaRecoveryCodeChallengeNewCode` class. - * It retrieves the necessary context (screen, transaction, etc.) and sets up screen-specific properties. - * @throws {Error} If the Universal Login Context is not available or if the screen name doesn't match. - */ - constructor() { - super(); // Calls BaseContext constructor - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Confirms that the user has saved the new recovery code and continues the authentication flow. - * This method sends a POST request to the `/u/mfa-recovery-code-challenge-new-code` endpoint - * with the required `state`, `action`, and `saved` parameters. - * - * @param {ContinueOptions} [payload] - Optional custom data to include with the request form body. - * @returns {Promise<void>} A promise that resolves when the confirmation is successfully submitted. - * On success, the browser will typically be redirected to the next step. - * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state, - * or if the server responds with a 400 error like 'no-confirmation'). - * @example - * ```typescript - * const screenManager = new MfaRecoveryCodeChallengeNewCode(); - * // Assuming a checkbox 'confirmSaved' is checked by the user - * if (confirmSaved) { - * try { - * await screenManager.continue({ customData: 'optionalValue' }); - * } catch (err) { - * // Handle errors, potentially check screenManager.transaction.errors - * console.error("Confirmation failed:", err); - * } - * } else { - * // Prompt user to confirm saving the code - * } - * ``` - */ - async continue(payload?: ContinueOptions): Promise<void> { - // Prepare options for the FormHandler, including state and telemetry - const formHandlerOptions: FormOptions = { - state: this.transaction.state, - telemetry: [MfaRecoveryCodeChallengeNewCode.screenIdentifier, 'continue'] - }; - - // Construct the data payload for the form submission - // 'saved' is set to 'on' as calling this method implies user confirmation. - // Include any custom payload properties. - const submitPayload = { - ...payload, // Spread custom options first - action: FormActions.DEFAULT, - saved: 'on', // Indicate confirmation - }; - - // Use FormHandler to submit the data via a POST request - await new FormHandler(formHandlerOptions).submitData<typeof submitPayload>(submitPayload); +const screenManager = new MfaRecoveryCodeChallengeNewCode(); +// Assuming a checkbox 'confirmSaved' is checked by the user +if (confirmSaved) { + try { + await screenManager.continue({ customData: 'optionalValue' }); + } catch (err) { + // Handle errors, potentially check screenManager.transaction.errors + console.error("Confirmation failed:", err); } +} else { + // Prompt user to confirm saving the code } ``` </RequestExample> @@ -95,7 +37,7 @@ export default class MfaRecoveryCodeChallengeNewCode extends BaseContext impleme <ParamField body="MfaRecoveryCodeChallengeNewCode" type="Constructor"> {/*> **new MfaRecoveryCodeChallengeNewCode**(): `MfaRecoveryCodeChallengeNewCode`*/} -Defined in: [src/screens/mfa-recovery-code-challenge-new-code/index.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts#L40) +Defined in: [src/screens/mfa-recovery-code-challenge-new-code/index.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts#L40) Initializes a new instance of the `MfaRecoveryCodeChallengeNewCode` class. It retrieves the necessary context (screen, transaction, etc.) and sets up screen-specific properties. @@ -118,7 +60,7 @@ If the Universal Login Context is not available or if the screen name doesn't ma <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -133,7 +75,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -148,7 +90,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -163,7 +105,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -178,7 +120,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode">ScreenMembersOnMfaRecoveryCodeChallengeNewCode</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode)*/} -Defined in: [src/screens/mfa-recovery-code-challenge-new-code/index.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts#L33) +Defined in: [src/screens/mfa-recovery-code-challenge-new-code/index.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts#L33) Holds the specific screen data and properties, processed by ScreenOverride. @@ -195,7 +137,7 @@ Holds the specific screen data and properties, processed by ScreenOverride. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -210,7 +152,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -225,7 +167,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -240,7 +182,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -255,7 +197,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_RECOVERY_CODE_CHALLENGE_NEW_CODE`*/} -Defined in: [src/screens/mfa-recovery-code-challenge-new-code/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts#L27) +Defined in: [src/screens/mfa-recovery-code-challenge-new-code/index.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts#L27) The unique identifier for this screen, used internally and for telemetry. @@ -269,7 +211,7 @@ The unique identifier for this screen, used internally and for telemetry. <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-recovery-code-challenge-new-code/index.ts:72](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts#L72) +Defined in: [src/screens/mfa-recovery-code-challenge-new-code/index.ts:72](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge-new-code/index.ts#L72) Confirms that the user has saved the new recovery code and continues the authentication flow. This method sends a POST request to the `/u/mfa-recovery-code-challenge-new-code` endpoint @@ -321,7 +263,7 @@ if (confirmSaved) { <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment.mdx index b69b44bb2..b7823e33b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment.mdx @@ -2,7 +2,7 @@ title: "MfaRecoveryCodeEnrollment" --- -Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L18) +Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L18) Class implementing the Mfa Recovery Code Enrollment screen functionality. This screen is displayed when the user needs to enroll with a recovery code for MFA. @@ -10,58 +10,16 @@ This screen is displayed when the user needs to enroll with a recovery code for <RequestExample> ```ts -export default class MfaRecoveryCodeEnrollment extends BaseContext implements MfaRecoveryCodeEnrollmentMembers { - static screenIdentifier: string = ScreenIds.MFA_RECOVERY_CODE_ENROLLMENT; - screen: ScreenMembersOnMfaRecoveryCodeEnrollment; - - /** - * Creates an instance of the MfaRecoveryCodeEnrollment screen. - */ - constructor() { - super(); - const screenContext: ScreenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Declares that the user saved the recovery code. - * This action is triggered when the user declares that they have saved the recovery code. - * It redirects to the next screen in the authentication flow. - * - * @param {object} payload - An object containing any custom options. - * - * @returns {Promise<void>} A promise that resolves when the action is successfully submitted. - * @example - * ```typescript - * import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment'; - * const mfaRecoveryCodeEnrollmentManager = new MfaRecoveryCodeEnrollment(); - * const continueEnrollment = async (payload) => { - * try { - * await mfaRecoveryCodeEnrollmentManager.continue(payload); - * console.log('Enrollment continued successfully.'); - * } catch (error) { - * console.error('Error continuing enrollment:', error); - * } - * }; - * ``` - * Rejects with an error if the submission fails. - */ - async continue(payload: MfaRecoveryCodeEnrollmentContinueOptions): Promise<void> { - const formOptions = { - state: this.transaction.state, - telemetry: [MfaRecoveryCodeEnrollment.screenIdentifier, FormActions.CONTINUE], - }; - - const { isCodeCopied, ...rest } = payload; - - const options: Omit<MfaRecoveryCodeEnrollmentContinueOptions, 'isCodeCopied'> = { - ...rest, - ...(isCodeCopied === true ? { saved: 'on' as unknown as boolean } : {}), - }; - - await new FormHandler(formOptions).submitData<Omit<MfaRecoveryCodeEnrollmentContinueOptions, 'isCodeCopied'> & { saved?: 'string' }>(options); - } -} +import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment'; +const mfaRecoveryCodeEnrollmentManager = new MfaRecoveryCodeEnrollment(); +const continueEnrollment = async (payload) => { + try { + await mfaRecoveryCodeEnrollmentManager.continue(payload); + console.log('Enrollment continued successfully.'); + } catch (error) { + console.error('Error continuing enrollment:', error); + } +}; ``` </RequestExample> @@ -78,7 +36,7 @@ export default class MfaRecoveryCodeEnrollment extends BaseContext implements Mf <ParamField body="MfaRecoveryCodeEnrollment" type="Constructor"> {/*> **new MfaRecoveryCodeEnrollment**(): `MfaRecoveryCodeEnrollment`*/} -Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L25) +Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L25) Creates an instance of the MfaRecoveryCodeEnrollment screen. @@ -96,7 +54,7 @@ Creates an instance of the MfaRecoveryCodeEnrollment screen. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -111,7 +69,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -126,7 +84,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -141,7 +99,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -156,7 +114,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment">ScreenMembersOnMfaRecoveryCodeEnrollment</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaRecoveryCodeEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment)*/} -Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L20) +Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L20) #### Implementation of @@ -171,7 +129,7 @@ Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:20](https://githu <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -186,7 +144,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -201,7 +159,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -216,7 +174,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -231,7 +189,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_RECOVERY_CODE_ENROLLMENT`*/} -Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L19) +Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L19) #### Overrides @@ -243,7 +201,7 @@ Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:19](https://githu <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L54) +Defined in: [src/screens/mfa-recovery-code-enrollment/index.ts:54](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L54) Declares that the user saved the recovery code. This action is triggered when the user declares that they have saved the recovery code. @@ -288,7 +246,7 @@ Rejects with an error if the submission fails. <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsChallenge.mdx index baa8057f9..56624d811 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsChallenge.mdx @@ -2,176 +2,20 @@ title: "MfaSmsChallenge" --- -Defined in: [src/screens/mfa-sms-challenge/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L25) +Defined in: [src/screens/mfa-sms-challenge/index.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L25) This class provides methods to handle the mfa-sms-challenge screen. <RequestExample> ```ts -export default class MfaSmsChallenge extends BaseContext implements MfaSmsChallengeMembers { - static screenIdentifier: string = ScreenIds.MFA_SMS_CHALLENGE; - screen: ScreenOptions; - untrustedData: UntrustedDataOptions; - - /** - * Creates an instance of MfaSmsChallenge screen manager - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - const untrustedDataContext = this.getContext('untrusted_data') as UntrustedDataContext; - this.screen = new ScreenOverride(screenContext); - this.untrustedData = new UntrustedDataOverride(untrustedDataContext); - } - - /** - * Submits the MFA SMS challenge with the provided code and rememberDevice option. - * @param {MfaSmsChallengeOptions} payload - The payload containing the code and rememberDevice option. - * @returns {Promise<void>} - * @example - * ```typescript - * import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; - * - * const mfaSmsChallenge = new MfaSmsChallenge(); - * await mfaSmsChallenge.continueMfaSmsChallenge({ - * code: '123456', - * rememberDevice: true, - * }); - * ``` - */ - async continueMfaSmsChallenge(payload: MfaSmsChallengeOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaSmsChallenge.screenIdentifier, 'continueMfaSmsChallenge'], - }; - - const { rememberDevice, ...restPayload } = payload; - const submitPayload: Record<string, string | number | boolean> = { ...restPayload, action: FormActions.DEFAULT }; - - if (rememberDevice) { - submitPayload.rememberBrowser = true; - } - - await new FormHandler(options).submitData(submitPayload); - } - - /** - * Submits the action to pick a different SMS configuration, if available. - * @param {CustomOptions} [payload] - Optional payload. - * @returns {Promise<void>} - * @example - * ```typescript - * import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; - * - * const mfaSmsChallenge = new MfaSmsChallenge(); - * await mfaSmsChallenge.pickSms(); - * ``` - */ - async pickSms(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaSmsChallenge.screenIdentifier, 'pickSms'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.PICK_SMS }); - } - - /** - * Submits the action to resend the SMS code. - * @param {CustomOptions} [payload] - Optional payload. - * @returns {Promise<void>} - * @example - * ```typescript - * import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; - * - * const mfaSmsChallenge = new MfaSmsChallenge(); - * await mfaSmsChallenge.resendCode(); - * ``` - */ - async resendCode(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaSmsChallenge.screenIdentifier, 'resendCode'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND_CODE }); - } - - /** - * Submits the action to try another MFA method. - * @param {CustomOptions} [payload] - Optional payload. - * @returns {Promise<void>} - * @example - * ```typescript - * import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; - * - * const mfaSmsChallenge = new MfaSmsChallenge(); - * await mfaSmsChallenge.tryAnotherMethod(); - * ``` - */ - async tryAnotherMethod(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaSmsChallenge.screenIdentifier, 'tryAnotherMethod'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.PICK_AUTHENTICATOR }); - } - - /** - * Submits the action to switch to voice call verification. - * @param {CustomOptions} [payload] - Optional payload. - * @returns {Promise<void>} - * @example - * ```typescript - * import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; - * - * const mfaSmsChallenge = new MfaSmsChallenge(); - * await mfaSmsChallenge.getACall(); - * ``` - */ - async getACall(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaSmsChallenge.screenIdentifier, 'getACall'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.SWITCH_TO_VOICE }); - } +import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; - /** - * Gets resend functionality with timeout management for this screen - * @param options - Configuration options for resend functionality - * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) - * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) - * @param options.onTimeout - Callback to execute when timeout countdown reaches zero - * @returns ResendControl object with startResend method - * @utilityFeature - * - * @example - * ```typescript - * import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; - * - * const mfaSmsChallenge = new MfaSmsChallenge(); - * const { startResend } = mfaSmsChallenge.resendManager({ - * timeoutSeconds: 15, - * onStatusChange: (remainingSeconds, isDisabled) => { - * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); - * }, - * onTimeout: () => { - * console.log('Resend is now available'); - * } - * }); - * - * // Call startResend when user clicks resend button - * startResend(); - * ``` - */ - resendManager(options?: StartResendOptions): ResendControl { - return createResendControl( - MfaSmsChallenge.screenIdentifier, - () => this.resendCode(), - options - ); - } -} +const mfaSmsChallenge = new MfaSmsChallenge(); +await mfaSmsChallenge.continueMfaSmsChallenge({ + code: '123456', + rememberDevice: true, +}); ``` </RequestExample> @@ -188,7 +32,7 @@ export default class MfaSmsChallenge extends BaseContext implements MfaSmsChalle <ParamField body="MfaSmsChallenge" type="Constructor"> {/*> **new MfaSmsChallenge**(): `MfaSmsChallenge`*/} -Defined in: [src/screens/mfa-sms-challenge/index.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L33) +Defined in: [src/screens/mfa-sms-challenge/index.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L33) Creates an instance of MfaSmsChallenge screen manager @@ -206,7 +50,7 @@ Creates an instance of MfaSmsChallenge screen manager <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -221,7 +65,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -236,7 +80,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -251,7 +95,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -266,7 +110,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge">ScreenMembersOnMfaSmsChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge)*/} -Defined in: [src/screens/mfa-sms-challenge/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L27) +Defined in: [src/screens/mfa-sms-challenge/index.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L27) #### Implementation of @@ -281,7 +125,7 @@ Defined in: [src/screens/mfa-sms-challenge/index.ts:27](https://github.com/auth0 <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -296,7 +140,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -311,7 +155,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge">UntrustedDataMembersOnMfaSmsChallenge</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge)*/} -Defined in: [src/screens/mfa-sms-challenge/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L28) +Defined in: [src/screens/mfa-sms-challenge/index.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L28) #### Implementation of @@ -326,7 +170,7 @@ Defined in: [src/screens/mfa-sms-challenge/index.ts:28](https://github.com/auth0 <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -341,7 +185,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_SMS_CHALLENGE`*/} -Defined in: [src/screens/mfa-sms-challenge/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L26) +Defined in: [src/screens/mfa-sms-challenge/index.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L26) #### Overrides @@ -353,7 +197,7 @@ Defined in: [src/screens/mfa-sms-challenge/index.ts:26](https://github.com/auth0 <ParamField body='continueMfaSmsChallenge' type='Promise<void>'> {/*> **continueMfaSmsChallenge**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-sms-challenge/index.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L56) +Defined in: [src/screens/mfa-sms-challenge/index.ts:56](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L56) Submits the MFA SMS challenge with the provided code and rememberDevice option. @@ -390,7 +234,7 @@ await mfaSmsChallenge.continueMfaSmsChallenge({ <ParamField body='getACall' type='Promise<void>'> {/*> **getACall**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-sms-challenge/index.ts:144](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L144) +Defined in: [src/screens/mfa-sms-challenge/index.ts:144](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L144) Submits the action to switch to voice call verification. @@ -424,7 +268,7 @@ await mfaSmsChallenge.getACall(); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -443,7 +287,7 @@ An array of error objects from the transaction context. <ParamField body='pickSms' type='Promise<void>'> {/*> **pickSms**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-sms-challenge/index.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L84) +Defined in: [src/screens/mfa-sms-challenge/index.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L84) Submits the action to pick a different SMS configuration, if available. @@ -477,7 +321,7 @@ await mfaSmsChallenge.pickSms(); <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-sms-challenge/index.ts:104](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L104) +Defined in: [src/screens/mfa-sms-challenge/index.ts:104](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L104) Submits the action to resend the SMS code. @@ -511,7 +355,7 @@ await mfaSmsChallenge.resendCode(); <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [src/screens/mfa-sms-challenge/index.ts:180](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L180) +Defined in: [src/screens/mfa-sms-challenge/index.ts:180](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L180) **`Utility Feature`** @@ -560,7 +404,7 @@ startResend(); <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-sms-challenge/index.ts:124](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L124) +Defined in: [src/screens/mfa-sms-challenge/index.ts:124](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L124) Submits the action to try another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsEnrollment.mdx index 25d70d30a..197472e68 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsEnrollment.mdx @@ -2,99 +2,17 @@ title: "MfaSmsEnrollment" --- -Defined in: [src/screens/mfa-sms-enrollment/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L16) +Defined in: [src/screens/mfa-sms-enrollment/index.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L16) Represents the MFA SMS Enrollment screen. <RequestExample> ```ts -export default class MfaSmsEnrollment extends BaseContext implements MfaSmsEnrollmentMembers { - static screenIdentifier: string = ScreenIds.MFA_SMS_ENROLLMENT; - screen: ScreenMembersOnMfaSmsEnrollment; - - /** - * Initializes a new instance of the MfaSmsEnrollment class. - */ - constructor() { - super(); - this.screen = this.getContext('screen') as ScreenMembersOnMfaSmsEnrollment; - } - - /** - * Handles the action to pick a country code for SMS enrollment. - * @param payload Optional custom options to include in the request. - * @returns A promise that resolves when the action is complete. - * @example - * ```typescript - * import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; - * - * const mfaSmsEnrollment = new MfaSmsEnrollment(); - * await mfaSmsEnrollment.pickCountryCode(); - * ``` - */ - async pickCountryCode(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaSmsEnrollment.screenIdentifier, 'pickCountryCode'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_COUNTRY_CODE, - }); - } - - /** - * Continues the SMS enrollment process with the provided phone number. - * @param payload The phone number to use for enrollment. - * @returns A promise that resolves when the enrollment process is complete. - * @throws {Error} If the phone number is missing. - * @example - * ```typescript - * import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; - * - * const mfaSmsEnrollment = new MfaSmsEnrollment(); - * await mfaSmsEnrollment.continueEnrollment({ phone: '1234567890' }); - * ``` - */ - async continueEnrollment(payload: MfaSmsEnrollmentOptions): Promise<void> { - if (!payload.phone) { - throw new Error('Phone number is required to continue enrollment.'); - } - - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaSmsEnrollment.screenIdentifier, 'continueEnrollment'], - }; - await new FormHandler(options).submitData<MfaSmsEnrollmentOptions>({ - ...payload, - action: FormActions.DEFAULT, - }); - } - - /** - * Handles the action to try another method for MFA. - * @param payload Optional custom options to include in the request. - * @returns A promise that resolves when the action is complete. - * @example - * ```typescript - * import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; - * - * const mfaSmsEnrollment = new MfaSmsEnrollment(); - * await mfaSmsEnrollment.tryAnotherMethod(); - * ``` - */ - async tryAnotherMethod(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaSmsEnrollment.screenIdentifier, 'tryAnotherMethod'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } -} +import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; + +const mfaSmsEnrollment = new MfaSmsEnrollment(); +await mfaSmsEnrollment.pickCountryCode(); ``` </RequestExample> @@ -111,7 +29,7 @@ export default class MfaSmsEnrollment extends BaseContext implements MfaSmsEnrol <ParamField body="MfaSmsEnrollment" type="Constructor"> {/*> **new MfaSmsEnrollment**(): `MfaSmsEnrollment`*/} -Defined in: [src/screens/mfa-sms-enrollment/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L23) +Defined in: [src/screens/mfa-sms-enrollment/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L23) Initializes a new instance of the MfaSmsEnrollment class. @@ -129,7 +47,7 @@ Initializes a new instance of the MfaSmsEnrollment class. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -144,7 +62,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -159,7 +77,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -174,7 +92,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -189,7 +107,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment">ScreenMembersOnMfaSmsEnrollment</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaSmsEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment)*/} -Defined in: [src/screens/mfa-sms-enrollment/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L18) +Defined in: [src/screens/mfa-sms-enrollment/index.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L18) #### Implementation of @@ -204,7 +122,7 @@ Defined in: [src/screens/mfa-sms-enrollment/index.ts:18](https://github.com/auth <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -219,7 +137,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -234,7 +152,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -249,7 +167,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -264,7 +182,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_SMS_ENROLLMENT`*/} -Defined in: [src/screens/mfa-sms-enrollment/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L17) +Defined in: [src/screens/mfa-sms-enrollment/index.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L17) #### Overrides @@ -276,7 +194,7 @@ Defined in: [src/screens/mfa-sms-enrollment/index.ts:17](https://github.com/auth <ParamField body='continueEnrollment' type='Promise<void>'> {/*> **continueEnrollment**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-sms-enrollment/index.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L64) +Defined in: [src/screens/mfa-sms-enrollment/index.ts:64](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L64) Continues the SMS enrollment process with the provided phone number. @@ -316,7 +234,7 @@ await mfaSmsEnrollment.continueEnrollment({ phone: '1234567890' }); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -335,7 +253,7 @@ An array of error objects from the transaction context. <ParamField body='pickCountryCode' type='Promise<void>'> {/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-sms-enrollment/index.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L40) +Defined in: [src/screens/mfa-sms-enrollment/index.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L40) Handles the action to pick a country code for SMS enrollment. @@ -371,7 +289,7 @@ await mfaSmsEnrollment.pickCountryCode(); <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-sms-enrollment/index.ts:91](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L91) +Defined in: [src/screens/mfa-sms-enrollment/index.ts:91](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-enrollment/index.ts#L91) Handles the action to try another method for MFA. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsList.mdx index 20773d283..4f055ab4a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsList.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsList.mdx @@ -2,7 +2,7 @@ title: "MfaSmsList" --- -Defined in: [src/screens/mfa-sms-list/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts#L14) +Defined in: [src/screens/mfa-sms-list/index.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts#L14) MfaSmsList Class for handling the mfa-sms-list screen. @@ -10,73 +10,12 @@ Class for handling the mfa-sms-list screen. <RequestExample> ```ts -export default class MfaSmsList extends BaseContext implements MfaSmsListMembers { - static screenIdentifier: string = ScreenIds.MFA_SMS_LIST; - constructor() { - super(); - } - - /** - * Selects a phone number from the list of enrolled phone numbers. - * @param {MfaSmsListOptions} [payload] - Optional payload for the action. - * @returns {Promise<void>} - * @throws {Error} If the index is out of bounds. - * @example - * ```typescript - * import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list'; - * const mfaSmsList = new MfaSmsList(); - * const selectPhoneNumber = async () => { - * const getEnrolledPhoneNumbers = mfaSmsList.user.enrolledPhoneNumbers; - * const selectedNumber = getEnrolledPhoneNumbers[0]; - * await mfaSmsList.selectPhoneNumber({index: selectedNumber}); - * } - * ``` - */ - public async selectPhoneNumber(payload?: MfaSmsListOptions): Promise<void> { - const index = payload?.index; - if (index === undefined || index < 0 || index >= (this.user?.enrolledPhoneNumbers?.length ?? 0)) { - throw new Error('Index out of bounds.'); - } - - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaSmsList.screenIdentifier, 'selectPhoneNumber'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: `selection-action::${index}`, - }); - } - - /** - * Navigates back to the previous screen. - * @param {MfaSmsListOptions} [payload] - Optional payload for the action. - * @returns {Promise<void>} - * @example - * ```typescript - * import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list'; - * const mfaSmsList = new MfaSmsList(); - * const handleBackAction = async () => { - * try { - * await mfaSmsList.backAction(); - * } catch (error) { - * console.error('Failed to go back:', error); - * } - * }; - * ``` - */ - public async backAction(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaSmsList.screenIdentifier, 'backAction'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.BACK, - }); - } +import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list'; +const mfaSmsList = new MfaSmsList(); +const selectPhoneNumber = async () => { + const getEnrolledPhoneNumbers = mfaSmsList.user.enrolledPhoneNumbers; + const selectedNumber = getEnrolledPhoneNumbers[0]; + await mfaSmsList.selectPhoneNumber({index: selectedNumber}); } ``` </RequestExample> @@ -94,7 +33,7 @@ export default class MfaSmsList extends BaseContext implements MfaSmsListMembers <ParamField body="MfaSmsList" type="Constructor"> {/*> **new MfaSmsList**(): `MfaSmsList`*/} -Defined in: [src/screens/mfa-sms-list/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts#L16) +Defined in: [src/screens/mfa-sms-list/index.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts#L16) #### Returns @@ -110,7 +49,7 @@ Defined in: [src/screens/mfa-sms-list/index.ts:16](https://github.com/auth0/univ <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -125,7 +64,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -140,7 +79,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -155,7 +94,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -170,7 +109,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -185,7 +124,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -200,7 +139,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -215,7 +154,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -230,7 +169,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -245,7 +184,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_SMS_LIST`*/} -Defined in: [src/screens/mfa-sms-list/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts#L15) +Defined in: [src/screens/mfa-sms-list/index.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts#L15) #### Overrides @@ -257,7 +196,7 @@ Defined in: [src/screens/mfa-sms-list/index.ts:15](https://github.com/auth0/univ <ParamField body='backAction' type='Promise<void>'> {/*> **backAction**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-sms-list/index.ts:70](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts#L70) +Defined in: [src/screens/mfa-sms-list/index.ts:70](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts#L70) Navigates back to the previous screen. @@ -296,7 +235,7 @@ const handleBackAction = async () => { <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -315,7 +254,7 @@ An array of error objects from the transaction context. <ParamField body='selectPhoneNumber' type='Promise<void>'> {/*> **selectPhoneNumber**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-sms-list/index.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts#L36) +Defined in: [src/screens/mfa-sms-list/index.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-list/index.ts#L36) Selects a phone number from the list of enrolled phone numbers. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceChallenge.mdx index fa28b0bde..44ad5c477 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceChallenge.mdx @@ -2,7 +2,7 @@ title: "MfaVoiceChallenge" --- -Defined in: [src/screens/mfa-voice-challenge/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L27) +Defined in: [src/screens/mfa-voice-challenge/index.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L27) MFA Voice Challenge screen implementation. @@ -12,190 +12,11 @@ as part of a multi-factor authentication flow. <RequestExample> ```ts -export default class MfaVoiceChallenge extends BaseContext implements MfaVoiceChallengeMembers { - /** - * Screen identifier for validation and telemetry - */ - static screenIdentifier: string = ScreenIds.MFA_VOICE_CHALLENGE; - - /** - * Screen-specific properties and data. - */ - screen: ScreenOptions; - untrustedData: UntrustedDataOptions; - /** - * Creates an instance of MfaVoiceChallenge. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - const untrustedDataContext = this.getContext('untrusted_data') as UntrustedDataContext; - this.screen = new ScreenOverride(screenContext); - this.untrustedData = new UntrustedDataOverride(untrustedDataContext); - } - - /** - * Submits the voice verification code to validate the MFA challenge. - * - * @param payload - Object containing the verification code and optional parameters - * @returns Promise that resolves when the code is successfully validated - * - * @example - * ```typescript - * const mfaVoiceChallenge = new MfaVoiceChallenge(); - * mfaVoiceChallenge.continue({ - * code: '123456', - * rememberDevice: true - * }); - * ``` - */ - async continue(payload: MfaVoiceChallengeContinueOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaVoiceChallenge.screenIdentifier, 'default'], - }; - - const { rememberDevice, ...restPayload } = payload || {}; - const submitPayload: Record<string, string | number | boolean> = { ...restPayload, action: FormActions.DEFAULT }; - - if (rememberDevice) { - submitPayload.rememberBrowser = true; - } - await new FormHandler(options).submitData(submitPayload); - } - - /** - * Navigates to the screen for selecting a different phone number. - * - * @param payload - Optional custom parameters - * @returns Promise that resolves when navigation is complete - * - * @example - * ```typescript - * const mfaVoiceChallenge = new MfaVoiceChallenge(); - * mfaVoiceChallenge.pickPhone(); - * ``` - */ - async pickPhone(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaVoiceChallenge.screenIdentifier, 'pickPhone'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_PHONE, - }); - } - - /** - * Switches to SMS verification method instead of voice call. - * - * @param payload - Optional custom parameters - * @returns Promise that resolves when switching is complete - * - * @example - * ```typescript - * const mfaVoiceChallenge = new MfaVoiceChallenge(); - * mfaVoiceChallenge.switchToSms(); - * ``` - */ - async switchToSms(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaVoiceChallenge.screenIdentifier, 'switchToSms'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.SWITCH_TO_SMS, - }); - } - - /** - * Requests a new voice call with a verification code. - * - * @param payload - Optional custom parameters - * @returns Promise that resolves when the new code is sent - * - * @example - * ```typescript - * const mfaVoiceChallenge = new MfaVoiceChallenge(); - * mfaVoiceChallenge.resendCode(); - * ``` - */ - async resendCode(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaVoiceChallenge.screenIdentifier, 'resendCode'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.RESEND_CODE, - }); - } - - /** - * Navigates to the screen for selecting an alternative MFA method. - * - * @param payload - Optional custom parameters - * @returns Promise that resolves when navigation is complete - * - * @example - * ```typescript - * const mfaVoiceChallenge = new MfaVoiceChallenge(); - * mfaVoiceChallenge.tryAnotherMethod(); - * ``` - */ - async tryAnotherMethod(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaVoiceChallenge.screenIdentifier, 'pickAuthenticator'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } - - /** - * Gets resend functionality with timeout management for this screen - * @param options - Configuration options for resend functionality - * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) - * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) - * @param options.onTimeout - Callback to execute when timeout countdown reaches zero - * @returns ResendControl object with startResend method - * @utilityFeature - * - * @example - * ```typescript - * import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge'; - * - * const mfaVoiceChallenge = new MfaVoiceChallenge(); - * const { startResend } = mfaVoiceChallenge.resendManager({ - * timeoutSeconds: 15, - * onStatusChange: (remainingSeconds, isDisabled) => { - * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); - * }, - * onTimeout: () => { - * console.log('Resend is now available'); - * } - * }); - * - * // Call startResend when user clicks resend button - * startResend(); - * ``` - */ - resendManager(options?: StartResendOptions): ResendControl { - return createResendControl( - MfaVoiceChallenge.screenIdentifier, - () => this.resendCode(), - options - ); - } -} +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.continue({ + code: '123456', + rememberDevice: true +}); ``` </RequestExample> @@ -212,7 +33,7 @@ export default class MfaVoiceChallenge extends BaseContext implements MfaVoiceCh <ParamField body="MfaVoiceChallenge" type="Constructor"> {/*> **new MfaVoiceChallenge**(): `MfaVoiceChallenge`*/} -Defined in: [src/screens/mfa-voice-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L41) +Defined in: [src/screens/mfa-voice-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L41) Creates an instance of MfaVoiceChallenge. @@ -230,7 +51,7 @@ Creates an instance of MfaVoiceChallenge. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -245,7 +66,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -260,7 +81,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -275,7 +96,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -290,7 +111,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge">ScreenMembersOnMfaVoiceChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge)*/} -Defined in: [src/screens/mfa-voice-challenge/index.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L36) +Defined in: [src/screens/mfa-voice-challenge/index.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L36) Screen-specific properties and data. @@ -307,7 +128,7 @@ Screen-specific properties and data. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -322,7 +143,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -337,7 +158,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge">UntrustedDataMembersOnMfaVoiceChallenge</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge)*/} -Defined in: [src/screens/mfa-voice-challenge/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L37) +Defined in: [src/screens/mfa-voice-challenge/index.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L37) #### Implementation of @@ -352,7 +173,7 @@ Defined in: [src/screens/mfa-voice-challenge/index.ts:37](https://github.com/aut <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -367,7 +188,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_VOICE_CHALLENGE`*/} -Defined in: [src/screens/mfa-voice-challenge/index.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L31) +Defined in: [src/screens/mfa-voice-challenge/index.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L31) Screen identifier for validation and telemetry @@ -381,7 +202,7 @@ Screen identifier for validation and telemetry <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-voice-challenge/index.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L64) +Defined in: [src/screens/mfa-voice-challenge/index.ts:64](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L64) Submits the voice verification code to validate the MFA challenge. @@ -418,7 +239,7 @@ mfaVoiceChallenge.continue({ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -437,7 +258,7 @@ An array of error objects from the transaction context. <ParamField body='pickPhone' type='Promise<void>'> {/*> **pickPhone**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-voice-challenge/index.ts:91](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L91) +Defined in: [src/screens/mfa-voice-challenge/index.ts:91](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L91) Navigates to the screen for selecting a different phone number. @@ -471,7 +292,7 @@ mfaVoiceChallenge.pickPhone(); <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-voice-challenge/index.ts:139](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L139) +Defined in: [src/screens/mfa-voice-challenge/index.ts:139](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L139) Requests a new voice call with a verification code. @@ -505,7 +326,7 @@ mfaVoiceChallenge.resendCode(); <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [src/screens/mfa-voice-challenge/index.ts:203](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L203) +Defined in: [src/screens/mfa-voice-challenge/index.ts:203](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L203) **`Utility Feature`** @@ -554,7 +375,7 @@ startResend(); <ParamField body='switchToSms' type='Promise<void>'> {/*> **switchToSms**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-voice-challenge/index.ts:115](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L115) +Defined in: [src/screens/mfa-voice-challenge/index.ts:115](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L115) Switches to SMS verification method instead of voice call. @@ -588,7 +409,7 @@ mfaVoiceChallenge.switchToSms(); <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-voice-challenge/index.ts:163](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L163) +Defined in: [src/screens/mfa-voice-challenge/index.ts:163](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L163) Navigates to the screen for selecting an alternative MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceEnrollment.mdx index 00f6360ae..16b1e4aeb 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceEnrollment.mdx @@ -2,104 +2,26 @@ title: "MfaVoiceEnrollment" --- -Defined in: [src/screens/mfa-voice-enrollment/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L12) +Defined in: [src/screens/mfa-voice-enrollment/index.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L12) Class implementing the mfa-voice-enrollment screen functionality. <RequestExample> ```ts -export default class MfaVoiceEnrollment extends BaseContext implements MfaVoiceEnrollmentMembers { - static screenIdentifier: string = ScreenIds.MFA_VOICE_ENROLLMENT; - - /** - * Creates an instance of MfaVoiceEnrollment screen manager. - */ - constructor() { - super(); - } - - /** - * Continues with the default action. - * @param payload - Optional payload. - * @returns {Promise<void>} - * @example - * ```typescript - * import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; - * const mfaVoiceEnrollmentManager = new MfaVoiceEnrollment(); - * const handleContinueEnrollment = async () => { - * try { - * await mfaVoiceEnrollmentManager.continue({ - * phone: '+1234567890', - * // Add any optional CustomOptions here if needed - * }); - * console.log('Voice enrollment continued successfully.'); - * } catch (error) { - * console.error('Error continuing voice enrollment:', error); - * } - * }; - * ``` - */ - async continue(payload: ContinueOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaVoiceEnrollment.screenIdentifier, 'continue'], - }; - - await new FormHandler(options).submitData({ - ...payload, - action: FormActions.DEFAULT, - }); - } - - /** - * Allows trying another authentication method - * @param {CustomOptions} [payload] - Optional payload. - * @example - * ```typescript - * import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; - * const mfaVoiceEnrollment = new MfaVoiceEnrollment(); - * const handleTryAnotherMethod = async () => { - * await mfaVoiceEnrollment.tryAnotherMethod(); - * }; - * ``` - */ - async tryAnotherMethod(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaVoiceEnrollment.screenIdentifier, 'tryAnotherMethod'], - }; - - await new FormHandler(options).submitData({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } - - /** - * Allows picking a country code for the phone number - * @param {CustomOptions} [payload] - Optional payload. - * @example - * ```typescript - * import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; - * const mfaVoiceEnrollment = new MfaVoiceEnrollment(); - * const handlePickCountryCode = async () => { - * await mfaVoiceEnrollment.selectPhoneCountryCode(); - * }; - * ``` - */ - async selectPhoneCountryCode(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaVoiceEnrollment.screenIdentifier, 'selectPhoneCountryCode'], - }; - - await new FormHandler(options).submitData({ - ...payload, - action: FormActions.PICK_COUNTRY_CODE, - }); - } -} +import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment'; +const mfaVoiceEnrollmentManager = new MfaVoiceEnrollment(); +const handleContinueEnrollment = async () => { + try { + await mfaVoiceEnrollmentManager.continue({ + phone: '+1234567890', + // Add any optional CustomOptions here if needed + }); + console.log('Voice enrollment continued successfully.'); + } catch (error) { + console.error('Error continuing voice enrollment:', error); + } +}; ``` </RequestExample> @@ -116,7 +38,7 @@ export default class MfaVoiceEnrollment extends BaseContext implements MfaVoiceE <ParamField body="MfaVoiceEnrollment" type="Constructor"> {/*> **new MfaVoiceEnrollment**(): `MfaVoiceEnrollment`*/} -Defined in: [src/screens/mfa-voice-enrollment/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L18) +Defined in: [src/screens/mfa-voice-enrollment/index.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L18) Creates an instance of MfaVoiceEnrollment screen manager. @@ -134,7 +56,7 @@ Creates an instance of MfaVoiceEnrollment screen manager. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -149,7 +71,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -164,7 +86,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -179,7 +101,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -194,7 +116,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -209,7 +131,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -224,7 +146,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -239,7 +161,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -254,7 +176,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -269,7 +191,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_VOICE_ENROLLMENT`*/} -Defined in: [src/screens/mfa-voice-enrollment/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L13) +Defined in: [src/screens/mfa-voice-enrollment/index.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L13) #### Overrides @@ -281,7 +203,7 @@ Defined in: [src/screens/mfa-voice-enrollment/index.ts:13](https://github.com/au <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-voice-enrollment/index.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L43) +Defined in: [src/screens/mfa-voice-enrollment/index.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L43) Continues with the default action. @@ -324,7 +246,7 @@ const handleContinueEnrollment = async () => { <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -343,7 +265,7 @@ An array of error objects from the transaction context. <ParamField body='selectPhoneCountryCode' type='Promise<void>'> {/*> **selectPhoneCountryCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-voice-enrollment/index.ts:91](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L91) +Defined in: [src/screens/mfa-voice-enrollment/index.ts:91](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L91) Allows picking a country code for the phone number @@ -378,7 +300,7 @@ const handlePickCountryCode = async () => { <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-voice-enrollment/index.ts:67](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L67) +Defined in: [src/screens/mfa-voice-enrollment/index.ts:67](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-enrollment/index.ts#L67) Allows trying another authentication method diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname.mdx index d9497aed7..4d6222d9c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname.mdx @@ -2,80 +2,11 @@ title: "MfaWebAuthnChangeKeyNickname" --- -Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L15) +Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L15) MfaWebAuthnChangeKeyNicknameMembers -<RequestExample> -```ts -export default class MfaWebAuthnChangeKeyNickname extends BaseContext implements MfaWebAuthnChangeKeyNicknameMembers { - - static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_CHANGE_KEY_NICKNAME; - - /** - * Holds the specific screen data and properties for this screen, - * processed by `ScreenOverride`. This includes the current `nickname` of the key. - * @type {ScreenOptions} - * @public - */ - public screen: ScreenOptions; - - /** - * Initializes a new instance of the `MfaWebAuthnChangeKeyNickname` class. - * It retrieves the necessary context (screen, transaction, etc.) from the global - * `universal_login_context` and sets up screen-specific properties via `ScreenOverride`. - * @throws {Error} If the Universal Login Context is not available or if the screen name - * in the context does not match `MfaWebAuthnChangeKeyNickname.screenIdentifier`. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Submits the new nickname provided by the user for their WebAuthn security key. - * This method prepares and posts the form data, including the new `nickname` and the - * required `action: "default"`, to the `/u/mfa-webauthn-change-key-nickname` endpoint. - * - * @param {ContinueOptions} payload - An object containing the `nickname` (string) - * entered by the user. May also contain other custom - * parameters if needed for extensibility. - * @returns {Promise<void>} A promise that resolves once the form submission is initiated. - * Typically, a successful submission leads to a server-side redirect. - * If the nickname is invalid or another error occurs, the page will - * re-render, and `this.transaction.errors` will be populated with details. - * @throws {Error} If `payload.nickname` is missing or not a string. It can also - * throw if `FormHandler` encounters an unrecoverable issue during submission - * (e.g., network error). Auth0 validation errors (e.g., "nickname-too-long") - * are not thrown as JS errors but are made available in `this.transaction.errors` - * post-operation. - */ - async continueWithNewNickname(payload: ContinueOptions): Promise<void> { - if (!payload || typeof payload.nickname !== 'string') { - throw new Error('The `nickname` property in the payload is required and must be a string.'); - } - - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnChangeKeyNickname.screenIdentifier, 'continueWithNewNickname'] - }; - - // Prepare the data to be submitted. - // The `action: "default"` signals the server to process the nickname change. - const submitPayload = { - ...payload, // Includes the 'nickname' and any other custom options passed in. - action: FormActions.DEFAULT, - }; - - // Use FormHandler to submit the data. - await new FormHandler(formOptions).submitData<typeof submitPayload>(submitPayload); - } -} -``` -</RequestExample> - ## Extends - `BaseContext` @@ -89,7 +20,7 @@ export default class MfaWebAuthnChangeKeyNickname extends BaseContext implements <ParamField body="MfaWebAuthnChangeKeyNickname" type="Constructor"> {/*> **new MfaWebAuthnChangeKeyNickname**(): `MfaWebAuthnChangeKeyNickname`*/} -Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L34) +Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L34) Initializes a new instance of the `MfaWebAuthnChangeKeyNickname` class. It retrieves the necessary context (screen, transaction, etc.) from the global @@ -114,7 +45,7 @@ in the context does not match `MfaWebAuthnChangeKeyNickname.screenIdentifier`. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -129,7 +60,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -144,7 +75,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -159,7 +90,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -174,7 +105,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname">ScreenMembersOnMfaWebAuthnChangeKeyNickname</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname)*/} -Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L25) +Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L25) Holds the specific screen data and properties for this screen, processed by `ScreenOverride`. This includes the current `nickname` of the key. @@ -192,7 +123,7 @@ processed by `ScreenOverride`. This includes the current `nickname` of the key. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -207,7 +138,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -222,7 +153,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -237,7 +168,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -252,7 +183,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_CHANGE_KEY_NICKNAME`*/} -Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L17) +Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L17) #### Overrides @@ -264,7 +195,7 @@ Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:17](https://g <ParamField body='continueWithNewNickname' type='Promise<void>'> {/*> **continueWithNewNickname**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L58) +Defined in: [src/screens/mfa-webauthn-change-key-nickname/index.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L58) Submits the new nickname provided by the user for their WebAuthn security key. This method prepares and posts the form data, including the new `nickname` and the @@ -306,7 +237,7 @@ If `payload.nickname` is missing or not a string. It can also <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess.mdx index 8201f3aca..f662fc267 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess.mdx @@ -2,85 +2,21 @@ title: "MfaWebAuthnEnrollmentSuccess" --- -Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L24) +Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L24) MfaWebAuthnEnrollmentSuccess <RequestExample> ```ts -export default class MfaWebAuthnEnrollmentSuccess extends BaseContext implements MfaWebAuthnEnrollmentSuccessMembers { - /** - * static - * @property {string} screenIdentifier - The unique identifier for the 'mfa-webauthn-enrollment-success' screen. - * This is used by the `BaseContext` to ensure the correct screen class is instantiated based on the - * `window.universal_login_context.screen.name`. - */ - static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_ENROLLMENT_SUCCESS; - - /** - * @property {ScreenOptions} screen - Holds the specific screen data and properties for this screen, - * processed by `ScreenOverride`. This includes the enrolled authenticator's `nickname` and `webauthnType`. - */ - public screen: ScreenOptions; - - /** - * Initializes a new instance of the `MfaWebAuthnEnrollmentSuccess` class. - * It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context` - * and sets up screen-specific properties via `ScreenOverride`. - * @throws {Error} If the Universal Login Context is not available or if the screen name - * in the context does not match `MfaWebAuthnEnrollmentSuccess.screenIdentifier`. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Allows the user to continue the authentication flow after a successful WebAuthn enrollment. - * This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` endpoint - * with the action set to "default", indicating the user is proceeding from this success screen. - * - * @param {ContinueOptions} [payload] - Optional. An object for `CustomOptions` if any - * additional parameters need to be sent with the request. - * These custom parameters will be included in the form data. - * @returns {Promise<void>} A promise that resolves when the continue action is successfully submitted. - * On successful submission, the Auth0 server will typically redirect the user - * to the next appropriate step in the authentication flow. - * @throws {Error} Throws an error if the form submission fails (e.g., due to network issues, - * an invalid transaction state, or other server-side validation errors). - * If an error occurs, details might be available in `this.transaction.errors` - * if the page re-renders. - * - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnEnrollmentSuccess - * async function handleContinueClick() { - * try { - * await sdk.continue(); - * // User will be redirected by Auth0. - * } catch (error) { - * console.error("Error continuing after WebAuthn enrollment success:", error); - * // Display error message to the user, potentially from sdk.transaction.errors - * } - * } - * ``` - */ - async continue(payload?: ContinueOptions): Promise<void> { - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnEnrollmentSuccess.screenIdentifier, 'continue'] - }; - - // The payload for this action is simple, primarily just the action itself. - // Any custom options from the 'payload' argument are also included. - const submitPayload: CustomOptions & { action: string } = { - ...(payload || {}), // Spread custom options if any - action: FormActions.DEFAULT, - }; - - await new FormHandler(formOptions).submitData(submitPayload); +// Assuming 'sdk' is an instance of MfaWebAuthnEnrollmentSuccess +async function handleContinueClick() { + try { + await sdk.continue(); + // User will be redirected by Auth0. + } catch (error) { + console.error("Error continuing after WebAuthn enrollment success:", error); + // Display error message to the user, potentially from sdk.transaction.errors } } ``` @@ -99,7 +35,7 @@ export default class MfaWebAuthnEnrollmentSuccess extends BaseContext implements <ParamField body="MfaWebAuthnEnrollmentSuccess" type="Constructor"> {/*> **new MfaWebAuthnEnrollmentSuccess**(): `MfaWebAuthnEnrollmentSuccess`*/} -Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L46) +Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L46) Initializes a new instance of the `MfaWebAuthnEnrollmentSuccess` class. It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context` @@ -124,7 +60,7 @@ in the context does not match `MfaWebAuthnEnrollmentSuccess.screenIdentifier`. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -139,7 +75,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -154,7 +90,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -169,7 +105,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -184,7 +120,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess">ScreenMembersOnMfaWebAuthnEnrollmentSuccess</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess)*/} -Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L37) +Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L37) #### Implementation of @@ -199,7 +135,7 @@ Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:37](https://gi <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -214,7 +150,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -229,7 +165,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -244,7 +180,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -259,7 +195,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_ENROLLMENT_SUCCESS`*/} -Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L31) +Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L31) static @@ -273,7 +209,7 @@ static <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L82) +Defined in: [src/screens/mfa-webauthn-enrollment-success/index.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L82) Allows the user to continue the authentication flow after a successful WebAuthn enrollment. This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` endpoint @@ -328,7 +264,7 @@ async function handleContinueClick() { <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnError.mdx index bccea0808..6cae3ebfc 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnError.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnError.mdx @@ -2,136 +2,15 @@ title: "MfaWebAuthnError" --- -Defined in: [src/screens/mfa-webauthn-error/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L23) +Defined in: [src/screens/mfa-webauthn-error/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L23) MfaWebAuthnError <RequestExample> ```ts -export default class MfaWebAuthnError extends BaseContext implements MfaWebAuthnErrorMembers { - /** - * static - * @property {string} screenIdentifier - The unique identifier for the 'mfa-webauthn-error' screen. - */ - static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_ERROR; - - /** - * @property {ScreenOptions} screen - Holds the specific screen data and properties, - * processed by `ScreenOverride` for the MFA WebAuthn Error screen. This includes details - * like `errorType` and `webauthnType`. - */ - public screen: ScreenOptions; - - /** - * Initializes a new instance of the `MfaWebAuthnError` class. - * It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context`. - * @throws {Error} If the Universal Login Context is not available or if the screen name in the context - * does not match `MfaWebAuthnError.screenIdentifier`. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Allows the user to retry the previous WebAuthn operation. - * This action typically redirects the user to the screen where the WebAuthn process was - * initially attempted (e.g., back to the MFA challenge or enrollment screen for WebAuthn). - * - * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. - * @returns {Promise<void>} A promise that resolves upon successful submission of the 'tryagain' action. - * @throws {Error} Throws an error if the form submission fails. - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnError - * await sdk.tryAgain(); - * ``` - */ - async tryAgain(payload?: CustomOptions): Promise<void> { - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnError.screenIdentifier, 'tryAgain'], - }; - await new FormHandler(formOptions).submitData<CustomOptions>({ - ...payload, - action: FormActions.TRY_AGAIN, - }); - } - - /** - * Allows the user to attempt authentication using their password, if this alternative is configured - * and appropriate for the current flow (e.g., if password was a prior authentication step or is a valid MFA bypass). - * - * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. - * @returns {Promise<void>} A promise that resolves upon successful submission of the 'use-password' action. - * @throws {Error} Throws an error if the form submission fails. - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnError - * await sdk.usePassword(); - * ``` - */ - async usePassword(payload?: CustomOptions): Promise<void> { - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnError.screenIdentifier, 'usePassword'], - }; - await new FormHandler(formOptions).submitData<CustomOptions>({ - ...payload, - action: FormActions.USE_PASSWORD, - }); - } - - /** - * Allows the user to choose a different Multi-Factor Authentication method. - * This action navigates the user to a screen where they can select from other available/enrolled MFA factors. - * - * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. - * @returns {Promise<void>} A promise that resolves upon successful submission of the 'pick-authenticator' action. - * @throws {Error} Throws an error if the form submission fails. - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnError - * await sdk.tryAnotherMethod(); - * ``` - */ - async tryAnotherMethod(payload?: CustomOptions): Promise<void> { - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnError.screenIdentifier, 'tryAnotherMethod'], - }; - await new FormHandler(formOptions).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } - - /** - * Allows the user to decline the current WebAuthn operation (e.g., refuse to add a device during enrollment). - * This action signifies the user's choice not to proceed with the WebAuthn step at this time. - * - * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. - * @returns {Promise<void>} A promise that resolves upon successful submission of the 'refuse-add-device' action. - * @throws {Error} Throws an error if the form submission fails. - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnError - * await sdk.noThanks(); - * ``` - */ - async noThanks(payload?: CustomOptions): Promise<void> { - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnError.screenIdentifier, 'noThanks'], - }; - await new FormHandler(formOptions).submitData<CustomOptions>({ - ...payload, - action: FormActions.REFUSE_ADD_DEVICE, - }); - } -} +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.tryAgain(); ``` </RequestExample> @@ -148,7 +27,7 @@ export default class MfaWebAuthnError extends BaseContext implements MfaWebAuthn <ParamField body="MfaWebAuthnError" type="Constructor"> {/*> **new MfaWebAuthnError**(): `MfaWebAuthnError`*/} -Defined in: [src/screens/mfa-webauthn-error/index.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L43) +Defined in: [src/screens/mfa-webauthn-error/index.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L43) Initializes a new instance of the `MfaWebAuthnError` class. It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context`. @@ -172,7 +51,7 @@ does not match `MfaWebAuthnError.screenIdentifier`. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -187,7 +66,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -202,7 +81,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -217,7 +96,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -232,7 +111,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError">ScreenMembersOnMfaWebAuthnError</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaWebAuthnError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError)*/} -Defined in: [src/screens/mfa-webauthn-error/index.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L35) +Defined in: [src/screens/mfa-webauthn-error/index.ts:35](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L35) #### Implementation of @@ -247,7 +126,7 @@ Defined in: [src/screens/mfa-webauthn-error/index.ts:35](https://github.com/auth <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -262,7 +141,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -277,7 +156,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -292,7 +171,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -307,7 +186,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_ERROR`*/} -Defined in: [src/screens/mfa-webauthn-error/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L28) +Defined in: [src/screens/mfa-webauthn-error/index.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L28) static @@ -321,7 +200,7 @@ static <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -340,7 +219,7 @@ An array of error objects from the transaction context. <ParamField body='noThanks' type='Promise<void>'> {/*> **noThanks**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-error/index.ts:135](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L135) +Defined in: [src/screens/mfa-webauthn-error/index.ts:135](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L135) Allows the user to decline the current WebAuthn operation (e.g., refuse to add a device during enrollment). This action signifies the user's choice not to proceed with the WebAuthn step at this time. @@ -379,7 +258,7 @@ await sdk.noThanks(); <ParamField body='tryAgain' type='Promise<void>'> {/*> **tryAgain**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-error/index.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L63) +Defined in: [src/screens/mfa-webauthn-error/index.ts:63](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L63) Allows the user to retry the previous WebAuthn operation. This action typically redirects the user to the screen where the WebAuthn process was @@ -419,7 +298,7 @@ await sdk.tryAgain(); <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-error/index.ts:111](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L111) +Defined in: [src/screens/mfa-webauthn-error/index.ts:111](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L111) Allows the user to choose a different Multi-Factor Authentication method. This action navigates the user to a screen where they can select from other available/enrolled MFA factors. @@ -458,7 +337,7 @@ await sdk.tryAnotherMethod(); <ParamField body='usePassword' type='Promise<void>'> {/*> **usePassword**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-error/index.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L87) +Defined in: [src/screens/mfa-webauthn-error/index.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-error/index.ts#L87) Allows the user to attempt authentication using their password, if this alternative is configured and appropriate for the current flow (e.g., if password was a prior authentication step or is a valid MFA bypass). diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError.mdx index e87518eab..9efa7aad8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError.mdx @@ -2,63 +2,20 @@ title: "MfaWebAuthnNotAvailableError" --- -Defined in: [src/screens/mfa-webauthn-not-available-error/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-not-available-error/index.ts#L19) +Defined in: [src/screens/mfa-webauthn-not-available-error/index.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-not-available-error/index.ts#L19) MfaWebAuthnNotAvailableError <RequestExample> ```ts -export default class MfaWebAuthnNotAvailableError extends BaseContext implements MfaWebAuthnNotAvailableErrorMembers { - /** - * static - * @property {string} screenIdentifier - The unique identifier for the 'mfa-webauthn-not-available-error' screen. - */ - static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_NOT_AVAILABLE_ERROR; - - /** - * Initializes a new instance of the `MfaWebAuthnNotAvailableError` class. - * It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context`. - * @throws {Error} If the Universal Login Context is not available or if the screen name in the context - * does not match `MfaWebAuthnNotAvailableError.screenIdentifier`. - */ - constructor() { - super(); - // The base BaseContext constructor handles screen property initialization using the base Screen model, - // as MfaWebAuthnNotAvailableErrorMembers.screen is of type ScreenMembers (not a specialized one). - } - - /** - * Allows the user to select a different Multi-Factor Authentication method because WebAuthn - * is not available or supported on their current device/browser. - * This action navigates the user to a screen where they can choose from other available/enrolled MFA factors. - * - * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. - * @returns {Promise<void>} A promise that resolves upon successful submission of the 'pick-authenticator' action. - * @throws {Error} Throws an error if the form submission fails (e.g., network issues, server-side validation errors). - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnNotAvailableError - * try { - * await sdk.tryAnotherMethod(); - * // On success, Auth0 typically handles redirection to the MFA factor selection screen. - * } catch (error) { - * console.error('Failed to initiate "try another method":', error); - * // Update UI to inform the user about the failure to switch methods. - * } - * ``` - */ - async tryAnotherMethod(payload?: CustomOptions): Promise<void> { - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnNotAvailableError.screenIdentifier, 'tryAnotherMethod'], - route: '/u/mfa-webauthn-enrollment', // As per provided OpenAPI spec - }; - await new FormHandler(formOptions).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } +// Assuming 'sdk' is an instance of MfaWebAuthnNotAvailableError +try { + await sdk.tryAnotherMethod(); + // On success, Auth0 typically handles redirection to the MFA factor selection screen. +} catch (error) { + console.error('Failed to initiate "try another method":', error); + // Update UI to inform the user about the failure to switch methods. } ``` </RequestExample> @@ -76,7 +33,7 @@ export default class MfaWebAuthnNotAvailableError extends BaseContext implements <ParamField body="MfaWebAuthnNotAvailableError" type="Constructor"> {/*> **new MfaWebAuthnNotAvailableError**(): `MfaWebAuthnNotAvailableError`*/} -Defined in: [src/screens/mfa-webauthn-not-available-error/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-not-available-error/index.ts#L32) +Defined in: [src/screens/mfa-webauthn-not-available-error/index.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-not-available-error/index.ts#L32) Initializes a new instance of the `MfaWebAuthnNotAvailableError` class. It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context`. @@ -100,7 +57,7 @@ does not match `MfaWebAuthnNotAvailableError.screenIdentifier`. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -115,7 +72,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -130,7 +87,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -145,7 +102,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -160,7 +117,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -175,7 +132,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -190,7 +147,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -205,7 +162,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -220,7 +177,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -235,7 +192,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_NOT_AVAILABLE_ERROR`*/} -Defined in: [src/screens/mfa-webauthn-not-available-error/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-not-available-error/index.ts#L24) +Defined in: [src/screens/mfa-webauthn-not-available-error/index.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-not-available-error/index.ts#L24) static @@ -249,7 +206,7 @@ static <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -268,7 +225,7 @@ An array of error objects from the transaction context. <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-not-available-error/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-not-available-error/index.ts#L58) +Defined in: [src/screens/mfa-webauthn-not-available-error/index.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-not-available-error/index.ts#L58) Allows the user to select a different Multi-Factor Authentication method because WebAuthn is not available or supported on their current device/browser. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge.mdx index be38d20bc..d5789e56d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge.mdx @@ -2,146 +2,11 @@ title: "MfaWebAuthnPlatformChallenge" --- -Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L30) +Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L30) MfaWebAuthnPlatformChallenge -<RequestExample> -```ts -export default class MfaWebAuthnPlatformChallenge extends BaseContext implements MfaWebAuthnPlatformChallengeMembers { - /** - * static - * @property {string} screenIdentifier - The unique identifier for the 'mfa-webauthn-platform-challenge' screen. - * Used by `BaseContext` to ensure the correct screen class is instantiated. - */ - static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_PLATFORM_CHALLENGE; - - /** - * @property {ScreenOptions} screen - Holds the specific screen data and properties for this screen, - * processed by `ScreenOverride`. This includes `publicKey` for the WebAuthn API call - * and `showRememberDevice`. - */ - public screen: ScreenOptions; - - /** - * Initializes a new instance of the `MfaWebAuthnPlatformChallenge` class. - * It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context`. - * @throws {Error} If the Universal Login Context is not available or if the screen name - * in the context does not match `MfaWebAuthnPlatformChallenge.screenIdentifier`. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Initiates the WebAuthn platform authenticator challenge. - * Internally, this method retrieves the challenge options from `this.screen.publicKey`, - * calls `navigator.credentials.get()` (via the `getPasskeyCredentials` utility), - * and then submits the resulting credential assertion to the Auth0 server. - * - * @param {VerifyPlatformAuthenticatorOptions} [options] - Optional parameters for the verification. - * This can include `rememberDevice` if `this.screen.showRememberDevice` is true, - * and any other custom key-value pairs to be sent in the form submission. - * @returns {Promise<void>} A promise that resolves when the credential submission is initiated. - * A successful operation typically results in a server-side redirect. - * @throws {Error} Throws an error if `this.screen.publicKey` is not available (indicating missing challenge options), - * if `getPasskeyCredentials` (and thus `navigator.credentials.get()`) fails (e.g., user cancellation, - * no authenticator found, hardware error), or if the final form submission to Auth0 fails. - * It's crucial to catch errors from this method. WebAuthn API errors (like `NotAllowedError`) - * should ideally be reported using `this.reportBrowserError()`. - */ - async verify(options?: VerifyPlatformAuthenticatorOptions): Promise<void> { - const publicKeyOpts = this.screen.publicKey; - if (!publicKeyOpts) { - throw new Error(Errors.PASSKEY_PUBLIC_KEY_UNAVAILABLE); - } - - // `getPasskeyCredentials` calls `navigator.credentials.get()` and processes the response. - // It will throw if `navigator.credentials.get()` fails or returns null. - const credential = await getPasskeyCredentials(publicKeyOpts); - - // If credential is null (though getPasskeyCredentials should throw if it fails to get one), - // this is an unexpected state. - if (!credential) { - throw new Error(Errors.PASSKEY_CREDENTIALS_UNAVAILABLE); // Or a more specific error - } - - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnPlatformChallenge.screenIdentifier, 'verify'] - }; - - const { rememberDevice, ...customSubmissionOptions } = options || {}; - const payloadToSubmit: CustomOptions & { action: string; response: string; rememberBrowser?: boolean } = { - ...customSubmissionOptions, - action: FormActions.DEFAULT, - response: JSON.stringify(credential), // The PublicKeyCredential response as a JSON string - }; - - if (this.screen.showRememberDevice && rememberDevice) { - payloadToSubmit.rememberBrowser = true; - } - - await new FormHandler(formOptions).submitData(payloadToSubmit); - } - - /** - * Reports a browser-side error encountered during the WebAuthn `navigator.credentials.get()` operation. - * This method should be called when `verify()` fails due to a WebAuthn API error (e.g., user cancellation). - * It sends the error details to the server with a specific action format. - * - * @param {ReportBrowserErrorOptions} options - Contains the `error` object (with `name` and `message` - * properties from the browser's WebAuthn API DOMException) and any other custom options. - * The `error` object will be JSON stringified and embedded in the `action` parameter. - * @returns {Promise<void>} A promise that resolves when the error report is successfully submitted. - * @throws {Error} Throws an error if the form submission fails (e.g., network issue, invalid state). - */ - async reportBrowserError(options: ReportBrowserErrorOptions): Promise<void> { - const { error: errorDetails, ...customPayload } = options; - - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnPlatformChallenge.screenIdentifier, 'reportBrowserError'] - }; - - // Sanitize errorDetails to include only known and safe properties if necessary, - // though WebAuthnErrorDetails interface already limits it to name, message, and custom string/number/boolean. - const errorDetailsString = JSON.stringify(errorDetails); - - await new FormHandler(formOptions).submitData({ - ...customPayload, // Spread any other custom key-value pairs from the 'options' object - action: `${FormActions.SHOW_ERROR_ACTION_PREFIX}${errorDetailsString}`, - response: '', // As per OpenAPI examples for showError actions - }); - } - - /** - * Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. - * This action submits `action: "pick-authenticator"` to Auth0, which should navigate - * the user to an MFA factor selection screen. - * - * @param {TryAnotherMethodOptions} [options] - Optional. Any custom parameters to be sent with the request. - * @returns {Promise<void>} A promise that resolves when the 'pick-authenticator' action is submitted. - * @throws {Error} Throws an error if the form submission fails (e.g., network error, invalid state). - */ - async tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void> { - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnPlatformChallenge.screenIdentifier, 'tryAnotherMethod'] - }; - - await new FormHandler(formOptions).submitData({ - ...(options || {}), // Spread all properties from the options object - action: FormActions.PICK_AUTHENTICATOR, - }); - } -} -``` -</RequestExample> - ## Extends - `BaseContext` @@ -155,7 +20,7 @@ export default class MfaWebAuthnPlatformChallenge extends BaseContext implements <ParamField body="MfaWebAuthnPlatformChallenge" type="Constructor"> {/*> **new MfaWebAuthnPlatformChallenge**(): `MfaWebAuthnPlatformChallenge`*/} -Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L51) +Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:51](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L51) Initializes a new instance of the `MfaWebAuthnPlatformChallenge` class. It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context`. @@ -179,7 +44,7 @@ in the context does not match `MfaWebAuthnPlatformChallenge.screenIdentifier`. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -194,7 +59,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -209,7 +74,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -224,7 +89,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -239,7 +104,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge">ScreenMembersOnMfaWebAuthnPlatformChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge)*/} -Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L43) +Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L43) #### Implementation of @@ -254,7 +119,7 @@ Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:43](https://gi <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -269,7 +134,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -284,7 +149,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -299,7 +164,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -314,7 +179,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_PLATFORM_CHALLENGE`*/} -Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L36) +Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L36) static @@ -328,7 +193,7 @@ static <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -347,7 +212,7 @@ An array of error objects from the transaction context. <ParamField body='reportBrowserError' type='Promise<void>'> {/*> **reportBrowserError**(`options`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:120](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L120) +Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:120](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L120) Reports a browser-side error encountered during the WebAuthn `navigator.credentials.get()` operation. This method should be called when `verify()` fails due to a WebAuthn API error (e.g., user cancellation). @@ -382,7 +247,7 @@ Throws an error if the form submission fails (e.g., network issue, invalid state <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:148](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L148) +Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:148](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L148) Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate @@ -415,7 +280,7 @@ Throws an error if the form submission fails (e.g., network error, invalid state <ParamField body='verify' type='Promise<void>'> {/*> **verify**(`options?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:74](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L74) +Defined in: [src/screens/mfa-webauthn-platform-challenge/index.ts:74](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L74) Initiates the WebAuthn platform authenticator challenge. Internally, this method retrieves the challenge options from `this.screen.publicKey`, diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment.mdx index cf4baefc3..cf6e55775 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment.mdx @@ -2,135 +2,21 @@ title: "MfaWebAuthnPlatformEnrollment" --- -Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L27) +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L27) MfaWebAuthnPlatformEnrollment <RequestExample> ```ts -export default class MfaWebAuthnPlatformEnrollment extends BaseContext implements MfaWebAuthnPlatformEnrollmentMembers { - /** - * static - * @property {string} screenIdentifier - The unique identifier for the 'mfa-webauthn-platform-enrollment' screen. - */ - static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_PLATFORM_ENROLLMENT; - - /** - * @property {ScreenOptions} screen - Holds the specific screen data and properties, - * processed by `ScreenOverride` for the MFA WebAuthn Platform Enrollment screen. - * This includes convenient access to `screen.publicKey`. - */ - public screen: ScreenOptions; - - /** - * Initializes a new instance of the `MfaWebAuthnPlatformEnrollment` class. - * @throws {Error} If the Universal Login Context is not available or if the screen name - * in the context does not match `MfaWebAuthnPlatformEnrollment.screenIdentifier`. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Initiates the WebAuthn platform credential creation process using the public key options - * available on `this.screen.publicKey` and submits the resulting credential to the server. - * This method internally calls `createPasskeyCredentials` (which wraps `navigator.credentials.create()`). - * - * @param {SubmitPasskeyCredentialOptions} [payload] - Optional custom parameters to be sent to the server - * along with the created credential. - * @returns {Promise<void>} A promise that resolves when the credential is successfully created and submitted. - * @throws {Error} Throws an error if `this.screen.publicKey` is not available, if `createPasskeyCredentials` fails - * (e.g., user cancellation, hardware issues), or if the submission to the server fails. - * @example - * ```typescript - * // Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment - * try { - * await sdk.submitPasskeyCredential(); // No need to pass publicKey explicitly - * // On success, Auth0 handles redirection. - * } catch (error) { - * console.error('Passkey enrollment failed:', error); - * if (error.name && error.message) { // Check if it looks like a WebAuthn error - * await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); - * } - * } - * ``` - */ - async submitPasskeyCredential(payload?: SubmitPasskeyCredentialOptions): Promise<void> { - const publicKeyOptions = this.screen.publicKey; - - if (!publicKeyOptions) { - throw new Error(Errors.PASSKEY_PUBLIC_KEY_UNAVAILABLE); - } - - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnPlatformEnrollment.screenIdentifier, 'submitPasskeyCredential'], - }; - - const credentialResponse = await createPasskeyCredentials(publicKeyOptions); - await new FormHandler(formOptions).submitData({ - ...(payload || {}), // Spread custom options if any - action: FormActions.DEFAULT, - response: JSON.stringify(credentialResponse), - }); - } - - /** - * Reports a browser-side error encountered during the WebAuthn `navigator.credentials.create()` operation. - * - * @param {ReportBrowserErrorOptions} payload - An object containing the `error` (with `name` and `message` properties - * from the browser's WebAuthn API error) and any other custom options. - * @returns {Promise<void>} A promise that resolves upon successful submission of the error report. - * @throws {Error} Throws an error if the form submission fails. - */ - async reportBrowserError(payload: ReportBrowserErrorOptions): Promise<void> { - const { error, ...customPayload } = payload; - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnPlatformEnrollment.screenIdentifier, 'reportBrowserError'], - }; - await new FormHandler(formOptions).submitData({ - ...customPayload, - action: `${FormActions.SHOW_ERROR_ACTION_PREFIX}${JSON.stringify(error)}`, - response: '', - }); - } - - /** - * Allows the user to choose to snooze the WebAuthn platform enrollment. - * - * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. - * @returns {Promise<void>} A promise that resolves upon successful submission of the snooze action. - */ - async snoozeEnrollment(payload?: CustomOptions): Promise<void> { - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnPlatformEnrollment.screenIdentifier, 'snoozeEnrollment'], - }; - await new FormHandler(formOptions).submitData<CustomOptions>({ - ...payload, - action: FormActions.SNOOZE_ENROLLMENT, - }); - } - - /** - * Allows the user to refuse WebAuthn platform enrollment on the current device. - * - * @param {CustomOptions} [payload] - Optional custom parameters to be sent with the request. - * @returns {Promise<void>} A promise that resolves upon successful submission of the refusal action. - */ - async refuseEnrollmentOnThisDevice(payload?: CustomOptions): Promise<void> { - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnPlatformEnrollment.screenIdentifier, 'refuseEnrollmentOnThisDevice'], - }; - await new FormHandler(formOptions).submitData<CustomOptions>({ - ...payload, - action: FormActions.REFUSE_ADD_DEVICE, - }); +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment +try { + await sdk.submitPasskeyCredential(); // No need to pass publicKey explicitly + // On success, Auth0 handles redirection. +} catch (error) { + console.error('Passkey enrollment failed:', error); + if (error.name && error.message) { // Check if it looks like a WebAuthn error + await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); } } ``` @@ -149,7 +35,7 @@ export default class MfaWebAuthnPlatformEnrollment extends BaseContext implement <ParamField body="MfaWebAuthnPlatformEnrollment" type="Constructor"> {/*> **new MfaWebAuthnPlatformEnrollment**(): `MfaWebAuthnPlatformEnrollment`*/} -Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L46) +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L46) Initializes a new instance of the `MfaWebAuthnPlatformEnrollment` class. @@ -172,7 +58,7 @@ in the context does not match `MfaWebAuthnPlatformEnrollment.screenIdentifier`. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -187,7 +73,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -202,7 +88,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -217,7 +103,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -232,7 +118,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment">ScreenMembersOnMfaWebAuthnPlatformEnrollment</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment)*/} -Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L39) +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L39) #### Implementation of @@ -247,7 +133,7 @@ Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:39](https://g <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -262,7 +148,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -277,7 +163,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -292,7 +178,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -307,7 +193,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_PLATFORM_ENROLLMENT`*/} -Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L32) +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L32) static @@ -321,7 +207,7 @@ static <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -340,7 +226,7 @@ An array of error objects from the transaction context. <ParamField body='refuseEnrollmentOnThisDevice' type='Promise<void>'> {/*> **refuseEnrollmentOnThisDevice**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:140](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L140) +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:140](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L140) Allows the user to refuse WebAuthn platform enrollment on the current device. @@ -367,7 +253,7 @@ A promise that resolves upon successful submission of the refusal action. <ParamField body='reportBrowserError' type='Promise<void>'> {/*> **reportBrowserError**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:104](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L104) +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:104](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L104) Reports a browser-side error encountered during the WebAuthn `navigator.credentials.create()` operation. @@ -399,7 +285,7 @@ Throws an error if the form submission fails. <ParamField body='snoozeEnrollment' type='Promise<void>'> {/*> **snoozeEnrollment**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:123](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L123) +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:123](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L123) Allows the user to choose to snooze the WebAuthn platform enrollment. @@ -426,7 +312,7 @@ A promise that resolves upon successful submission of the snooze action. <ParamField body='submitPasskeyCredential' type='Promise<void>'> {/*> **submitPasskeyCredential**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:76](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L76) +Defined in: [src/screens/mfa-webauthn-platform-enrollment/index.ts:76](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L76) Initiates the WebAuthn platform credential creation process using the public key options available on `this.screen.publicKey` and submits the resulting credential to the server. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge.mdx index 04353e78b..3db9451ff 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge.mdx @@ -2,110 +2,11 @@ title: "MfaWebAuthnRoamingChallenge" --- -Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L29) +Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L29) MfaWebAuthnRoamingChallenge -<RequestExample> -```ts -export default class MfaWebAuthnRoamingChallenge extends BaseContext implements MfaWebAuthnRoamingChallengeMembers { - /** - * static - * @property {string} screenIdentifier - The unique identifier for the 'mfa-webauthn-roaming-challenge' screen. - */ - static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_ROAMING_CHALLENGE; - - /** - * @property {ScreenOptions} screen - Holds the specific screen data and properties, - * processed by `ScreenOverride`. This includes `publicKeyChallengeOptions` for the WebAuthn API call. - */ - public screen: ScreenOptions; - - /** - * Initializes a new instance of the `MfaWebAuthnRoamingChallenge` class. - * @throws {Error} If the Universal Login Context is not available or if the screen name - * in the context does not match `MfaWebAuthnRoamingChallenge.screenIdentifier`. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - async verify(options?: VerifySecurityKeyOptions): Promise<void> { - const publicKeyOpts = this.screen.publicKey; - if (!publicKeyOpts) { - throw new Error(Errors.PASSKEY_PUBLIC_KEY_UNAVAILABLE); - } - - // getPasskeyCredentials will call navigator.credentials.get() and re-throw if it fails. - const credential = await getPasskeyCredentials(publicKeyOpts); - - // If credential is null (though getPasskeyCredentials should throw if it fails to get one) - if (!credential) { - throw new Error(Errors.PASSKEY_CREDENTIALS_UNAVAILABLE); - } - - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnRoamingChallenge.screenIdentifier, 'verify'], - route: '/u/mfa-webauthn-challenge', - }; - - const { rememberDevice, ...customSubmissionOptions } = options || {}; - - const payloadToSubmit: CustomOptions = { - ...customSubmissionOptions, // Spread any other custom options from the VerifySecurityKeyOptions - action: FormActions.DEFAULT, - response: JSON.stringify(credential), - }; - - if (rememberDevice && this.screen.data?.showRememberDevice) { - payloadToSubmit.rememberBrowser = true; - } - - await new FormHandler(formOptions).submitData(payloadToSubmit); - } - - async reportWebAuthnError(options: ReportWebAuthnErrorOptions): Promise<void> { - const { error, ...customPayload } = options; // Separate the 'error' object from other custom options - - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnRoamingChallenge.screenIdentifier, 'reportWebAuthnError'], - route: '/u/mfa-webauthn-challenge', - }; - - // Construct the error details object carefully, only including defined properties from the input 'error' - const errorDetailsForPayload: Partial<WebAuthnErrorDetails> = { name: error.name, message: error.message }; - if (error.code !== undefined) errorDetailsForPayload.code = error.code; - if (error.type !== undefined) errorDetailsForPayload.type = error.type; - const errorDetailsString = JSON.stringify(errorDetailsForPayload); - - await new FormHandler(formOptions).submitData({ - ...customPayload, // Spread any other custom key-value pairs from the 'options' object - action: `${FormActions.SHOW_ERROR_ACTION_PREFIX}${errorDetailsString}`, - response: '', // Response is typically empty when the action is showError, as per OpenAPI examples - }); - } - - async tryAnotherMethod(options?: TryAnotherMethodOptions): Promise<void> { - const formOptions: SDKFormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnRoamingChallenge.screenIdentifier, 'tryAnotherMethod'], - route: '/u/mfa-webauthn-challenge', - }; - - await new FormHandler(formOptions).submitData({ - ...(options || {}), // Spread all properties from the options object as custom parameters - action: FormActions.PICK_AUTHENTICATOR, - }); - } -} -``` -</RequestExample> - ## Extends - `BaseContext` @@ -119,7 +20,7 @@ export default class MfaWebAuthnRoamingChallenge extends BaseContext implements <ParamField body="MfaWebAuthnRoamingChallenge" type="Constructor"> {/*> **new MfaWebAuthnRoamingChallenge**(): `MfaWebAuthnRoamingChallenge`*/} -Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L47) +Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:47](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L47) Initializes a new instance of the `MfaWebAuthnRoamingChallenge` class. @@ -142,7 +43,7 @@ in the context does not match `MfaWebAuthnRoamingChallenge.screenIdentifier`. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -157,7 +58,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -172,7 +73,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -187,7 +88,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -202,7 +103,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge">ScreenMembersOnMfaWebAuthnRoamingChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge)*/} -Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L40) +Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L40) #### Implementation of @@ -217,7 +118,7 @@ Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:40](https://git <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -232,7 +133,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -247,7 +148,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -262,7 +163,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -277,7 +178,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_ROAMING_CHALLENGE`*/} -Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L34) +Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L34) static @@ -291,7 +192,7 @@ static <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -310,7 +211,7 @@ An array of error objects from the transaction context. <ParamField body='reportWebAuthnError' type='Promise<void>'> {/*> **reportWebAuthnError**(`options`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L88) +Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L88) Reports a specific WebAuthn API error to Auth0. This method should be used if `navigator.credentials.get()` fails in a way that @@ -360,7 +261,7 @@ try { <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:110](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L110) +Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:110](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L110) Allows the user to opt-out of the WebAuthn challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate @@ -405,7 +306,7 @@ try { <ParamField body='verify' type='Promise<void>'> {/*> **verify**(`options?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L53) +Defined in: [src/screens/mfa-webauthn-roaming-challenge/index.ts:53](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L53) Initiates the WebAuthn challenge by calling `navigator.credentials.get()` with the options provided in `screen.data.publicKeyChallengeOptions`. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment.mdx index 30a96c93a..da5a55928 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment.mdx @@ -2,7 +2,7 @@ title: "MfaWebAuthnRoamingEnrollment" --- -Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L22) +Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L22) Class implementing the mfa-webauthn-roaming-enrollment screen functionality. This screen is displayed when a user needs to enroll a WebAuthn roaming authenticator (like a security key). @@ -10,96 +10,12 @@ This screen is displayed when a user needs to enroll a WebAuthn roaming authenti <RequestExample> ```ts -export default class MfaWebAuthnRoamingEnrollment extends BaseContext implements MfaWebAuthnRoamingEnrollmentMembers { - static screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_ROAMING_ENROLLMENT; - screen: ScreenOptions; - /** - * Creates an instance of MfaWebAuthnRoamingEnrollment screen manager. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - /** - * Initiates the WebAuthn credential creation and submits the result to the server. - * This corresponds to the user interacting with the FIDO Security Keys prompt. - * @param payload Optional custom options to include with the request. - * @example - * ```typescript - * import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; - * - * const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); - * // Assuming you have obtained the WebAuthn credential response (e.g., from navigator.credentials.create) - * const credentialResponse = { /* ... serialized credential ... */ }; - * await webauthnEnrollment.enroll({ response: JSON.stringify(credentialResponse) }); - * ``` - */ - async enroll(payload: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnRoamingEnrollment.screenIdentifier, 'enroll'], - }; - const publicKey = this.screen.publicKey; - const encoded = publicKey && (await createPasskeyCredentials(publicKey)); - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - response: JSON.stringify(encoded), - action: FormActions.DEFAULT, - }); - } - /** - * Submits details about a WebAuthn browser error to the server. - * This is used when the browser's WebAuthn API encounters an error. - * @param payload The options containing the error details. - * @example - * ```typescript - * import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; - * - * const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); - * await webauthnEnrollment.showError({ - * error: { - * name: 'NotAllowedError', - * message: 'The operation either timed out or was not allowed.', - * }, - * }); - * ``` - */ - async showError(payload: ShowErrorOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnRoamingEnrollment.screenIdentifier, 'showError'], - }; - const actionValue = `showError::${JSON.stringify(payload.error)}`; - await new FormHandler(options).submitData<Omit<ShowErrorOptions, 'error'>>({ - ...payload, - action: actionValue, - response: '', // As per OpenAPI example - }); - } - /** - * Allows the user to try another MFA method. - * This corresponds to the "Try Another Method" button. - * @param payload Optional custom options to include with the request. - * @example - * ```typescript - * import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; - * - * const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); - * await webauthnEnrollment.tryAnotherMethod(); - * ``` - */ - async tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [MfaWebAuthnRoamingEnrollment.screenIdentifier, 'tryAnotherMethod'], - }; - await new FormHandler(options).submitData<TryAnotherMethodOptions>({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } -} +import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + +const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); +// Assuming you have obtained the WebAuthn credential response (e.g., from navigator.credentials.create) +const credentialResponse = { /* ... serialized credential ... */ }; +await webauthnEnrollment.enroll({ response: JSON.stringify(credentialResponse) }); ``` </RequestExample> @@ -116,7 +32,7 @@ export default class MfaWebAuthnRoamingEnrollment extends BaseContext implements <ParamField body="MfaWebAuthnRoamingEnrollment" type="Constructor"> {/*> **new MfaWebAuthnRoamingEnrollment**(): `MfaWebAuthnRoamingEnrollment`*/} -Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L28) +Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L28) Creates an instance of MfaWebAuthnRoamingEnrollment screen manager. @@ -134,7 +50,7 @@ Creates an instance of MfaWebAuthnRoamingEnrollment screen manager. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -149,7 +65,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -164,7 +80,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -179,7 +95,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -194,7 +110,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment">ScreenMembersOnMfaWebAuthnRoamingEnrollment</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment)*/} -Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L24) +Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L24) #### Implementation of @@ -209,7 +125,7 @@ Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:24](https://gi <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -224,7 +140,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -239,7 +155,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -254,7 +170,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -269,7 +185,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_ROAMING_ENROLLMENT`*/} -Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L23) +Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L23) #### Overrides @@ -281,7 +197,7 @@ Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:23](https://gi <ParamField body='enroll' type='Promise<void>'> {/*> **enroll**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L47) +Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:47](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L47) Initiates the WebAuthn credential creation and submits the result to the server. This corresponds to the user interacting with the FIDO Security Keys prompt. @@ -318,7 +234,7 @@ await webauthnEnrollment.enroll({ response: JSON.stringify(credentialResponse) } <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -337,7 +253,7 @@ An array of error objects from the transaction context. <ParamField body='showError' type='Promise<void>'> {/*> **showError**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:77](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L77) +Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:77](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L77) Submits details about a WebAuthn browser error to the server. This is used when the browser's WebAuthn API encounters an error. @@ -377,7 +293,7 @@ await webauthnEnrollment.showError({ <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:101](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L101) +Defined in: [src/screens/mfa-webauthn-roaming-enrollment/index.ts:101](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L101) Allows the user to try another MFA method. This corresponds to the "Try Another Method" button. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationPicker.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationPicker.mdx index 80c6e1a8f..cdee954e3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationPicker.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationPicker.mdx @@ -2,7 +2,7 @@ title: "OrganizationPicker" --- -Defined in: [src/screens/organization-picker/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-picker/index.ts#L13) +Defined in: [src/screens/organization-picker/index.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/organization-picker/index.ts#L13) Class implementing the organization-picker screen functionality. This screen allows users to select an organization from a list of available organizations. @@ -10,62 +10,12 @@ This screen allows users to select an organization from a list of available orga <RequestExample> ```ts -export default class OrganizationPicker extends BaseContext implements OrganizationPickerMembers { - /** - * Screen identifier for validation and telemetry - */ - static screenIdentifier: string = ScreenIds.ORGANIZATION_PICKER; - /** - * Creates an instance of OrganizationPicker screen manager. - */ - constructor() { - super(); - } - - /** - * Submits the selected organization ID. - * @param payload The ID of the selected organization. `{ organization: string; }` - * @example - * ```typescript - * import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; - * - * const organizationPicker = new OrganizationPicker(); - * organizationPicker.selectOrganization({ - * organization: 'org_XXXXXXXXXXXXXXX' - * }); - * ``` - */ - async selectOrganization(payload: SelectOrganizationOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [OrganizationPicker.screenIdentifier, 'selectOrganization'], - }; - await new FormHandler(options).submitData(payload); - } - - /** - * Submits the action to skip the organization selection. - * @param payload Optional custom options to include with the request. - * @example - * ```typescript - * import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; - * - * const organizationPicker = new OrganizationPicker(); - * organizationPicker.skipOrganizationSelection(); - * ``` - */ - async skipOrganizationSelection(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [OrganizationPicker.screenIdentifier, 'skipOrganizationSelection'], - }; - await new FormHandler(options).submitData({ - ...payload, - organizationSkipped: true, - state: this.transaction.state, - }); - } -} +import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; + +const organizationPicker = new OrganizationPicker(); +organizationPicker.selectOrganization({ + organization: 'org_XXXXXXXXXXXXXXX' +}); ``` </RequestExample> @@ -82,7 +32,7 @@ export default class OrganizationPicker extends BaseContext implements Organizat <ParamField body="OrganizationPicker" type="Constructor"> {/*> **new OrganizationPicker**(): `OrganizationPicker`*/} -Defined in: [src/screens/organization-picker/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-picker/index.ts#L21) +Defined in: [src/screens/organization-picker/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/organization-picker/index.ts#L21) Creates an instance of OrganizationPicker screen manager. @@ -100,7 +50,7 @@ Creates an instance of OrganizationPicker screen manager. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -110,13 +60,12 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l `BaseContext.branding` ---- - </ParamField> + <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -126,13 +75,12 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l `BaseContext.client` ---- - </ParamField> + <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -142,13 +90,12 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l `BaseContext.organization` ---- - </ParamField> + <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -158,13 +105,12 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l `BaseContext.prompt` ---- - </ParamField> + <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -174,13 +120,12 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l `BaseContext.screen` ---- - </ParamField> + <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -190,13 +135,12 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l `BaseContext.tenant` ---- - </ParamField> + <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -206,13 +150,12 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l `BaseContext.transaction` ---- - </ParamField> + <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -222,13 +165,12 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l `BaseContext.untrustedData` ---- - </ParamField> + <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -238,13 +180,12 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l `BaseContext.user` ---- - </ParamField> + <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.ORGANIZATION_PICKER`*/} -Defined in: [src/screens/organization-picker/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-picker/index.ts#L17) +Defined in: [src/screens/organization-picker/index.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/organization-picker/index.ts#L17) Screen identifier for validation and telemetry @@ -258,7 +199,7 @@ Screen identifier for validation and telemetry <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -272,13 +213,12 @@ An array of error objects from the transaction context. `BaseContext.getErrors` ---- - </ParamField> + <ParamField body='selectOrganization' type='Promise<void>'> {/*> **selectOrganization**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/organization-picker/index.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-picker/index.ts#L38) +Defined in: [src/screens/organization-picker/index.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/organization-picker/index.ts#L38) Submits the selected organization ID. @@ -301,7 +241,7 @@ import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; const organizationPicker = new OrganizationPicker(); organizationPicker.selectOrganization({ - organization: 'org_XXXXXXXXXXXXXXX', + organization: 'org_XXXXXXXXXXXXXXX' }); ``` @@ -309,13 +249,12 @@ organizationPicker.selectOrganization({ [`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers).[`selectOrganization`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.md#selectorganization) ---- - </ParamField> + <ParamField body='skipOrganizationSelection' type='Promise<void>'> {/*> **skipOrganizationSelection**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/organization-picker/index.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-picker/index.ts#L57) +Defined in: [src/screens/organization-picker/index.ts:57](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/organization-picker/index.ts#L57) Submits the action to skip the organization selection. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationSelection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationSelection.mdx index ca8e7035a..727a5844f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationSelection.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationSelection.mdx @@ -2,7 +2,7 @@ title: "OrganizationSelection" --- -Defined in: [src/screens/organization-selection/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-selection/index.ts#L17) +Defined in: [src/screens/organization-selection/index.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/organization-selection/index.ts#L17) Class implementing the organization-selection screen functionality. This screen allows users to select an organization to continue with. @@ -10,46 +10,12 @@ This screen allows users to select an organization to continue with. <RequestExample> ```ts -export default class OrganizationSelection extends BaseContext implements OrganizationSelectionMembers { - /** - * Screen identifier for validation and telemetry - */ - static screenIdentifier: string = ScreenIds.ORGANIZATION_SELECTION; - screen: ScreenOptions; - - /** - * Creates an instance of OrganizationSelection screen manager. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = screenContext as ScreenOptions; - } - - /** - * Continues with the selected organization name. - * @param payload The options containing the organization name. - * @example - * ```typescript - * import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection'; - * - * const organizationSelection = new OrganizationSelection(); - * await organizationSelection.continueWithOrganizationName({ - * organizationName: 'testOrganizationName', - * }); - * ``` - */ - async continueWithOrganizationName(payload: ContinueWithOrganizationNameOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [OrganizationSelection.screenIdentifier, 'continueWithOrganizationName'], - }; - await new FormHandler(options).submitData<ContinueWithOrganizationNameOptions>({ - ...payload, - action: FormActions.DEFAULT, - }); - } -} +import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection'; + +const organizationSelection = new OrganizationSelection(); +await organizationSelection.continueWithOrganizationName({ + organizationName: 'testOrganizationName', +}); ``` </RequestExample> @@ -66,7 +32,7 @@ export default class OrganizationSelection extends BaseContext implements Organi <ParamField body="OrganizationSelection" type="Constructor"> {/*> **new OrganizationSelection**(): `OrganizationSelection`*/} -Defined in: [src/screens/organization-selection/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-selection/index.ts#L27) +Defined in: [src/screens/organization-selection/index.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/organization-selection/index.ts#L27) Creates an instance of OrganizationSelection screen manager. @@ -84,7 +50,7 @@ Creates an instance of OrganizationSelection screen manager. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -99,7 +65,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -114,7 +80,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -129,7 +95,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -144,7 +110,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection">ScreenMembersOnOrganizationSelection</a></span>}> {/*> **screen**: [`ScreenMembersOnOrganizationSelection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection)*/} -Defined in: [src/screens/organization-selection/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-selection/index.ts#L22) +Defined in: [src/screens/organization-selection/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/organization-selection/index.ts#L22) The screen properties. @@ -161,7 +127,7 @@ The screen properties. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -176,7 +142,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -191,7 +157,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -206,7 +172,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -221,7 +187,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.ORGANIZATION_SELECTION`*/} -Defined in: [src/screens/organization-selection/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-selection/index.ts#L21) +Defined in: [src/screens/organization-selection/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/organization-selection/index.ts#L21) Screen identifier for validation and telemetry @@ -235,7 +201,7 @@ Screen identifier for validation and telemetry <ParamField body='continueWithOrganizationName' type='Promise<void>'> {/*> **continueWithOrganizationName**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/organization-selection/index.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/organization-selection/index.ts#L46) +Defined in: [src/screens/organization-selection/index.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/organization-selection/index.ts#L46) Continues with the selected organization name. @@ -271,7 +237,7 @@ await organizationSelection.continueWithOrganizationName({ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollment.mdx index 3377fb2fd..dddd0b8b8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollment.mdx @@ -2,58 +2,14 @@ title: "PasskeyEnrollment" --- -Defined in: [src/screens/passkey-enrollment/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L13) +Defined in: [src/screens/passkey-enrollment/index.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L13) <RequestExample> ```ts -export default class PasskeyEnrollment extends BaseContext implements PasskeyEnrollmentMembers { - static screenIdentifier: string = ScreenIds.PASSKEY_ENROLLMENT; - screen: ScreenOptions; - - constructor() { - super(); - - const screenContext = this.getContext('screen') as ScreenContext; - - this.screen = new ScreenOverride(screenContext); - } - - /** - * @example - * import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; - * - * const passkeyEnrollment = new PasskeyEnrollment(); - * passkeyEnrollment.continuePasskeyEnrollment(); - */ - async continuePasskeyEnrollment(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [PasskeyEnrollment.screenIdentifier, 'continuePasskeyEnrollment'], - }; - - const publicKey = this.screen.publicKey; - const encoded = publicKey && (await createPasskeyCredentials(publicKey)); - - await new FormHandler(options).submitData<CustomOptions>({ ...payload, passkey: JSON.stringify(encoded) }); - } - - /** - * @example - * import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; - * - * const passkeyEnrollment = new PasskeyEnrollment(); - * passkeyEnrollment.abortPasskeyEnrollment(); - */ - async abortPasskeyEnrollment(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [PasskeyEnrollment.screenIdentifier, 'abortPasskeyEnrollment'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.ABORT_PASSKEY_ENROLLMENT }); - } -} +import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; +const passkeyEnrollment = new PasskeyEnrollment(); +passkeyEnrollment.continuePasskeyEnrollment(); ``` </RequestExample> @@ -70,7 +26,7 @@ export default class PasskeyEnrollment extends BaseContext implements PasskeyEnr <ParamField body="PasskeyEnrollment" type="Constructor"> {/*> **new PasskeyEnrollment**(): `PasskeyEnrollment`*/} -Defined in: [src/screens/passkey-enrollment/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L17) +Defined in: [src/screens/passkey-enrollment/index.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L17) #### Returns @@ -86,7 +42,7 @@ Defined in: [src/screens/passkey-enrollment/index.ts:17](https://github.com/auth <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -101,7 +57,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -116,7 +72,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -131,7 +87,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -146,7 +102,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment">ScreenMembersOnPasskeyEnrollment</a></span>}> {/*> **screen**: [`ScreenMembersOnPasskeyEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment)*/} -Defined in: [src/screens/passkey-enrollment/index.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L15) +Defined in: [src/screens/passkey-enrollment/index.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L15) #### Implementation of @@ -161,7 +117,7 @@ Defined in: [src/screens/passkey-enrollment/index.ts:15](https://github.com/auth <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -176,7 +132,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -191,7 +147,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -206,7 +162,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -221,7 +177,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.PASSKEY_ENROLLMENT`*/} -Defined in: [src/screens/passkey-enrollment/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L14) +Defined in: [src/screens/passkey-enrollment/index.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L14) #### Overrides @@ -233,7 +189,7 @@ Defined in: [src/screens/passkey-enrollment/index.ts:14](https://github.com/auth <ParamField body='abortPasskeyEnrollment' type='Promise<void>'> {/*> **abortPasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/passkey-enrollment/index.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L51) +Defined in: [src/screens/passkey-enrollment/index.ts:51](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L51) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -263,7 +219,7 @@ passkeyEnrollment.abortPasskeyEnrollment(); <ParamField body='continuePasskeyEnrollment' type='Promise<void>'> {/*> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/passkey-enrollment/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L32) +Defined in: [src/screens/passkey-enrollment/index.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/passkey-enrollment/index.ts#L32) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -293,7 +249,7 @@ passkeyEnrollment.continuePasskeyEnrollment(); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollmentLocal.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollmentLocal.mdx index 2248a72e3..04998069c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollmentLocal.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollmentLocal.mdx @@ -2,64 +2,14 @@ title: "PasskeyEnrollmentLocal" --- -Defined in: [src/screens/passkey-enrollment-local/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L17) +Defined in: [src/screens/passkey-enrollment-local/index.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L17) <RequestExample> ```ts -export default class PasskeyEnrollmentLocal extends BaseContext implements PasskeyEnrollmentLocalMembers { - static screenIdentifier: string = ScreenIds.PASSKEY_ENROLLMENT_LOCAL; - screen: ScreenOptions; - - constructor() { - super(); - - const screenContext = this.getContext('screen') as ScreenContext; - - this.screen = new ScreenOverride(screenContext); - } - - /** - * @example - * import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local'; - * - * const passkeyEnrollment = new PasskeyEnrollmentLocal(); - * passkeyEnrollment.continuePasskeyEnrollment(); - */ - async continuePasskeyEnrollment(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [PasskeyEnrollmentLocal.screenIdentifier, 'continuePasskeyEnrollment'], - }; - - const publicKey = this.screen.publicKey; - const encoded = publicKey && (await createPasskeyCredentials(publicKey)); - - await new FormHandler(options).submitData<CustomOptions>({ ...payload, passkey: JSON.stringify(encoded) }); - } - - /** - * @example - * import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local'; - * - * const passkeyEnrollment = new PasskeyEnrollmentLocal(); - * passkeyEnrollment.abortPasskeyEnrollment({ - * doNotShowAgain: <boolean> - * }); - */ - async abortPasskeyEnrollment(payload: AbortEnrollmentOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [PasskeyEnrollmentLocal.screenIdentifier, 'abortPasskeyEnrollment'], - }; - - const userActions: { [key: string]: string } = {}; - if (payload['doNotShowAgain'] === true) { - userActions['dontShowAgain'] = 'on'; - } - await new FormHandler(options).submitData<AbortEnrollmentOptions>({ ...payload, action: FormActions.ABORT_PASSKEY_ENROLLMENT, ...userActions }); - } -} +import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local'; +const passkeyEnrollment = new PasskeyEnrollmentLocal(); +passkeyEnrollment.continuePasskeyEnrollment(); ``` </RequestExample> @@ -76,7 +26,7 @@ export default class PasskeyEnrollmentLocal extends BaseContext implements Passk <ParamField body="PasskeyEnrollmentLocal" type="Constructor"> {/*> **new PasskeyEnrollmentLocal**(): `PasskeyEnrollmentLocal`*/} -Defined in: [src/screens/passkey-enrollment-local/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L21) +Defined in: [src/screens/passkey-enrollment-local/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L21) #### Returns @@ -92,7 +42,7 @@ Defined in: [src/screens/passkey-enrollment-local/index.ts:21](https://github.co <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -107,7 +57,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -122,7 +72,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -137,7 +87,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -152,7 +102,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal">ScreenMembersOnPasskeyEnrollmentLocal</a></span>}> {/*> **screen**: [`ScreenMembersOnPasskeyEnrollmentLocal`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal)*/} -Defined in: [src/screens/passkey-enrollment-local/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L19) +Defined in: [src/screens/passkey-enrollment-local/index.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L19) #### Implementation of @@ -167,7 +117,7 @@ Defined in: [src/screens/passkey-enrollment-local/index.ts:19](https://github.co <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -182,7 +132,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -197,7 +147,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -212,7 +162,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -227,7 +177,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.PASSKEY_ENROLLMENT_LOCAL`*/} -Defined in: [src/screens/passkey-enrollment-local/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L18) +Defined in: [src/screens/passkey-enrollment-local/index.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L18) #### Overrides @@ -239,7 +189,7 @@ Defined in: [src/screens/passkey-enrollment-local/index.ts:18](https://github.co <ParamField body='abortPasskeyEnrollment' type='Promise<void>'> {/*> **abortPasskeyEnrollment**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/passkey-enrollment-local/index.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L57) +Defined in: [src/screens/passkey-enrollment-local/index.ts:57](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L57) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions">AbortEnrollmentOptions</a></span>}> @@ -271,7 +221,7 @@ passkeyEnrollment.abortPasskeyEnrollment({ <ParamField body='continuePasskeyEnrollment' type='Promise<void>'> {/*> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/passkey-enrollment-local/index.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L36) +Defined in: [src/screens/passkey-enrollment-local/index.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/passkey-enrollment-local/index.ts#L36) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -301,7 +251,7 @@ passkeyEnrollment.continuePasskeyEnrollment(); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierChallenge.mdx index 160bcf58d..b33b63754 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierChallenge.mdx @@ -2,138 +2,16 @@ title: "PhoneIdentifierChallenge" --- -Defined in: [src/screens/phone-identifier-challenge/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L18) +Defined in: [src/screens/phone-identifier-challenge/index.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L18) <RequestExample> ```ts -export default class PhoneIdentifierChallenge extends BaseContext implements PhoneIdentifierChallengeMembers { - static screenIdentifier: string = ScreenIds.PHONE_IDENTIFIER_CHALLENGE; - screen: ScreenOptions; - - constructor() { - super(); - - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * @example - * import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; - * - * const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); - * phoneIdentifierChallenge.submitPhoneChallenge({ - * code: "<string>" - * }); - */ - async submitPhoneChallenge(payload: PhoneChallengeOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [PhoneIdentifierChallenge.screenIdentifier, 'submitPhoneChallenge'], - }; - await new FormHandler(options).submitData<PhoneChallengeOptions>(payload); - } - - /** - * @example - * import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; - * - * const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); - * phoneIdentifierChallenge.resendCode(); - */ - async resendCode(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [PhoneIdentifierChallenge.screenIdentifier, 'resendCode'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND_CODE }); - } - - /** - * @example - * import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; - * - * const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); - * phoneIdentifierChallenge.returnToPrevious(); - */ - async returnToPrevious(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [PhoneIdentifierChallenge.screenIdentifier, 'returnToPrevious'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.BACK}); - } - - /** - * @example - * import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; - * - * const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); - * phoneIdentifierChallenge.switchToVoice(); - */ - async switchToVoice(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [PhoneIdentifierChallenge.screenIdentifier, 'switchToVoice'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.SWITCH_TO_VOICE }); - } - - /** - * @example - * import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; - * - * const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); - * phoneIdentifierChallenge.switchToText(); - */ - async switchToText(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [PhoneIdentifierChallenge.screenIdentifier, 'switchToText'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.SWITCH_TO_TEXT }); - } - - /** - * Gets resend functionality with timeout management for this screen - * @param options - Configuration options for resend functionality - * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) - * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) - * @param options.onTimeout - Callback to execute when timeout countdown reaches zero - * @returns ResendControl object with startResend method - * @utilityFeature - * - * @example - * import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; - * const handleStatusChange = (remainingSeconds, isDisabled) => { - * setDisabled(isDisabled); - * setRemaining(remainingSeconds); - * }; - * - * const handleTimeout = () => { - * console.log('Timeout completed, resend is now available'); - * }; - * - * const { startResend } = phoneChallenge.resendManager({ - * timeoutSeconds: 30, - * onStatusChange: handleStatusChange, - * onTimeout: handleTimeout - * }); - * - * // Call startResend when user clicks resend button - * await startResend(); - * - */ - resendManager(options?: StartResendOptions): ResendControl { - return createResendControl( - PhoneIdentifierChallenge.screenIdentifier, - () => this.resendCode(), - options, - !!this.screen.data?.resendLimitReached - ); - } -} +import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; +const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); +phoneIdentifierChallenge.submitPhoneChallenge({ + code: "<string>" +}); ``` </RequestExample> @@ -150,7 +28,7 @@ export default class PhoneIdentifierChallenge extends BaseContext implements Pho <ParamField body="PhoneIdentifierChallenge" type="Constructor"> {/*> **new PhoneIdentifierChallenge**(): `PhoneIdentifierChallenge`*/} -Defined in: [src/screens/phone-identifier-challenge/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L22) +Defined in: [src/screens/phone-identifier-challenge/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L22) #### Returns @@ -166,7 +44,7 @@ Defined in: [src/screens/phone-identifier-challenge/index.ts:22](https://github. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -181,7 +59,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -196,7 +74,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -211,7 +89,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -226,7 +104,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge">ScreenMembersOnPhoneIdentifierChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnPhoneIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge)*/} -Defined in: [src/screens/phone-identifier-challenge/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L20) +Defined in: [src/screens/phone-identifier-challenge/index.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L20) #### Implementation of @@ -241,7 +119,7 @@ Defined in: [src/screens/phone-identifier-challenge/index.ts:20](https://github. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -256,7 +134,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -271,7 +149,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -286,7 +164,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -301,7 +179,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.PHONE_IDENTIFIER_CHALLENGE`*/} -Defined in: [src/screens/phone-identifier-challenge/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L19) +Defined in: [src/screens/phone-identifier-challenge/index.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L19) #### Overrides @@ -313,7 +191,7 @@ Defined in: [src/screens/phone-identifier-challenge/index.ts:19](https://github. <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -332,7 +210,7 @@ An array of error objects from the transaction context. <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/phone-identifier-challenge/index.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L53) +Defined in: [src/screens/phone-identifier-challenge/index.ts:53](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L53) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -362,7 +240,7 @@ phoneIdentifierChallenge.resendCode(); <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [src/screens/phone-identifier-challenge/index.ts:136](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L136) +Defined in: [src/screens/phone-identifier-challenge/index.ts:136](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L136) **`Utility Feature`** @@ -414,7 +292,7 @@ import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-chal <ParamField body='returnToPrevious' type='Promise<void>'> {/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/phone-identifier-challenge/index.ts:68](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L68) +Defined in: [src/screens/phone-identifier-challenge/index.ts:68](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L68) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -444,7 +322,7 @@ phoneIdentifierChallenge.returnToPrevious(); <ParamField body='submitPhoneChallenge' type='Promise<void>'> {/*> **submitPhoneChallenge**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/phone-identifier-challenge/index.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L38) +Defined in: [src/screens/phone-identifier-challenge/index.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L38) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions">PhoneChallengeOptions</a></span>}> @@ -476,7 +354,7 @@ phoneIdentifierChallenge.submitPhoneChallenge({ <ParamField body='switchToText' type='Promise<void>'> {/*> **switchToText**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/phone-identifier-challenge/index.ts:98](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L98) +Defined in: [src/screens/phone-identifier-challenge/index.ts:98](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L98) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -506,7 +384,7 @@ phoneIdentifierChallenge.switchToText(); <ParamField body='switchToVoice' type='Promise<void>'> {/*> **switchToVoice**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/phone-identifier-challenge/index.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L83) +Defined in: [src/screens/phone-identifier-challenge/index.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L83) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierEnrollment.mdx index b26e5f732..28432cb59 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierEnrollment.mdx @@ -2,55 +2,16 @@ title: "PhoneIdentifierEnrollment" --- -Defined in: [src/screens/phone-identifier-enrollment/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L16) +Defined in: [src/screens/phone-identifier-enrollment/index.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L16) <RequestExample> ```ts -export default class PhoneIdentifierEnrollment extends BaseContext implements PhoneIdentifierEnrollmentMembers { - static screenIdentifier: string = ScreenIds.PHONE_IDENTIFIER_ENROLLMENT; - screen: ScreenOptions; - - constructor() { - super(); - - const screenContext = super.getContext('screen') as ScreenContext; - - this.screen = new ScreenOverride(screenContext); - } - - /** - * @example - * import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment'; - * - * const phoneIdentifierEnrollment = new PhoneIdentifierEnrollment(); - * phoneIdentifierChallenge.continuePhoneEnrollment({ - * type: "<text' | 'voice>" - * }); - */ - async continuePhoneEnrollment(payload: PhoneEnrollmentOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [PhoneIdentifierEnrollment.screenIdentifier, 'continuePhoneEnrollment'], - }; - await new FormHandler(options).submitData<PhoneEnrollmentOptions>(payload); - } - - /** - * @example - * import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment'; - * - * const phoneIdentifierEnrollment = new PhoneIdentifierEnrollment(); - * phoneIdentifierChallenge.returnToPrevious(); - */ - async returnToPrevious(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [PhoneIdentifierEnrollment.screenIdentifier, 'returnToPrevious'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.BACK }); - } -} +import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment'; +const phoneIdentifierEnrollment = new PhoneIdentifierEnrollment(); +phoneIdentifierChallenge.continuePhoneEnrollment({ + type: "<text' | 'voice>" +}); ``` </RequestExample> @@ -67,7 +28,7 @@ export default class PhoneIdentifierEnrollment extends BaseContext implements Ph <ParamField body="PhoneIdentifierEnrollment" type="Constructor"> {/*> **new PhoneIdentifierEnrollment**(): `PhoneIdentifierEnrollment`*/} -Defined in: [src/screens/phone-identifier-enrollment/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L20) +Defined in: [src/screens/phone-identifier-enrollment/index.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L20) #### Returns @@ -83,7 +44,7 @@ Defined in: [src/screens/phone-identifier-enrollment/index.ts:20](https://github <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -98,7 +59,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -113,7 +74,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -128,7 +89,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -143,7 +104,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment">ScreenMembersOnPhoneIdentifierEnrollment</a></span>}> {/*> **screen**: [`ScreenMembersOnPhoneIdentifierEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment)*/} -Defined in: [src/screens/phone-identifier-enrollment/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L18) +Defined in: [src/screens/phone-identifier-enrollment/index.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L18) #### Implementation of @@ -158,7 +119,7 @@ Defined in: [src/screens/phone-identifier-enrollment/index.ts:18](https://github <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -173,7 +134,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -188,7 +149,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -203,7 +164,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -218,7 +179,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.PHONE_IDENTIFIER_ENROLLMENT`*/} -Defined in: [src/screens/phone-identifier-enrollment/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L17) +Defined in: [src/screens/phone-identifier-enrollment/index.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L17) #### Overrides @@ -230,7 +191,7 @@ Defined in: [src/screens/phone-identifier-enrollment/index.ts:17](https://github <ParamField body='continuePhoneEnrollment' type='Promise<void>'> {/*> **continuePhoneEnrollment**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/phone-identifier-enrollment/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L37) +Defined in: [src/screens/phone-identifier-enrollment/index.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L37) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions">PhoneEnrollmentOptions</a></span>}> @@ -262,7 +223,7 @@ phoneIdentifierChallenge.continuePhoneEnrollment({ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -281,7 +242,7 @@ An array of error objects from the transaction context. <ParamField body='returnToPrevious' type='Promise<void>'> {/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/phone-identifier-enrollment/index.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L52) +Defined in: [src/screens/phone-identifier-enrollment/index.ts:52](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-enrollment/index.ts#L52) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/RedeemTicket.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/RedeemTicket.mdx index 51e1af647..1cfbcc59d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/RedeemTicket.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/RedeemTicket.mdx @@ -2,50 +2,17 @@ title: "RedeemTicket" --- -Defined in: [src/screens/redeem-ticket/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/redeem-ticket/index.ts#L12) +Defined in: [src/screens/redeem-ticket/index.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/redeem-ticket/index.ts#L12) Implements the redeem-ticket screen functionality. <RequestExample> ```ts -export default class RedeemTicket extends BaseContext implements RedeemTicketMembers { - static screenIdentifier: string = ScreenIds.REDEEM_TICKET; - - /** - * Initializes a new instance of the RedeemTicket class. - */ - constructor() { - super(); - } - - /** - * Performs the default action on the redeem-ticket screen, usually continuing the flow. - * - * @param payload - Optional custom options to include with the request. - * @returns A promise that resolves when the action is complete. - * @throws {Error} If the operation fails. - * - * @example - * ```ts - * import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; - * - * const redeemTicket = new RedeemTicket(); - * await redeemTicket.continue(); - * ``` - */ - async continue(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [RedeemTicket.screenIdentifier, 'continue'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.DEFAULT, - }); - } -} +import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; + +const redeemTicket = new RedeemTicket(); +await redeemTicket.continue(); ``` </RequestExample> @@ -62,7 +29,7 @@ export default class RedeemTicket extends BaseContext implements RedeemTicketMem <ParamField body="RedeemTicket" type="Constructor"> {/*> **new RedeemTicket**(): `RedeemTicket`*/} -Defined in: [src/screens/redeem-ticket/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/redeem-ticket/index.ts#L18) +Defined in: [src/screens/redeem-ticket/index.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/redeem-ticket/index.ts#L18) Initializes a new instance of the RedeemTicket class. @@ -80,7 +47,7 @@ Initializes a new instance of the RedeemTicket class. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -95,7 +62,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -110,7 +77,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -125,7 +92,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -140,7 +107,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -155,7 +122,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -170,7 +137,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -185,7 +152,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -200,7 +167,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -215,7 +182,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.REDEEM_TICKET`*/} -Defined in: [src/screens/redeem-ticket/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/redeem-ticket/index.ts#L13) +Defined in: [src/screens/redeem-ticket/index.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/redeem-ticket/index.ts#L13) #### Overrides @@ -227,7 +194,7 @@ Defined in: [src/screens/redeem-ticket/index.ts:13](https://github.com/auth0/uni <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/redeem-ticket/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/redeem-ticket/index.ts#L37) +Defined in: [src/screens/redeem-ticket/index.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/redeem-ticket/index.ts#L37) Performs the default action on the redeem-ticket screen, usually continuing the flow. @@ -267,7 +234,7 @@ await redeemTicket.continue(); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPassword.mdx index b0eebdb47..7b87cefd2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPassword.mdx @@ -2,52 +2,17 @@ title: "ResetPassword" --- -Defined in: [src/screens/reset-password/index.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password/index.ts#L19) +Defined in: [src/screens/reset-password/index.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password/index.ts#L19) <RequestExample> ```ts -export default class ResetPassword extends BaseContext implements ResetPasswordMembers { - static screenIdentifier: string = ScreenIds.RESET_PASSWORD; - screen: ScreenOptions; - transaction: TransactionOptions; - - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - const transactionContext = this.getContext('transaction') as TransactionContext; - - this.transaction = new TransactionOverride(transactionContext); - } - /** - * @example - * import ResetPassword from '@auth0/auth0-acul-js/reset-password'; - * - * const resetPassword = new ResetPassword(); - * resetPassword.resetPassword({ - * 'password-reset': 'Test@123!', - * 're-enter-password': 'Test@123!', - * }); - */ - async resetPassword(payload: ResetPasswordOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPassword.screenIdentifier, 'resetPassword'], - }; - await new FormHandler(options).submitData(payload); - } - - /** - * @param password - * @returns An object of type {@link PasswordValidationResult} indicating whether the password is valid and why. - * @utilityFeature - */ - validatePassword(password: string): PasswordValidationResult { - const passwordPolicy = this.transaction?.passwordPolicy; - return _validatePassword(password, passwordPolicy); - } -} +import ResetPassword from '@auth0/auth0-acul-js/reset-password'; +const resetPassword = new ResetPassword(); +resetPassword.resetPassword({ + 'password-reset': 'Test@123!', + 're-enter-password': 'Test@123!', +}); ``` </RequestExample> @@ -64,7 +29,7 @@ export default class ResetPassword extends BaseContext implements ResetPasswordM <ParamField body="ResetPassword" type="Constructor"> {/*> **new ResetPassword**(): `ResetPassword`*/} -Defined in: [src/screens/reset-password/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password/index.ts#L24) +Defined in: [src/screens/reset-password/index.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password/index.ts#L24) #### Returns @@ -80,7 +45,7 @@ Defined in: [src/screens/reset-password/index.ts:24](https://github.com/auth0/un <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -95,7 +60,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -110,7 +75,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -125,7 +90,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -140,7 +105,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword">ScreenMembersOnResetPassword</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword)*/} -Defined in: [src/screens/reset-password/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password/index.ts#L21) +Defined in: [src/screens/reset-password/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password/index.ts#L21) #### Implementation of @@ -155,7 +120,7 @@ Defined in: [src/screens/reset-password/index.ts:21](https://github.com/auth0/un <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -170,7 +135,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword">TransactionMembersOnResetPassword</a></span>}> {/*> **transaction**: [`TransactionMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword)*/} -Defined in: [src/screens/reset-password/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password/index.ts#L22) +Defined in: [src/screens/reset-password/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password/index.ts#L22) #### Implementation of @@ -185,7 +150,7 @@ Defined in: [src/screens/reset-password/index.ts:22](https://github.com/auth0/un <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -200,7 +165,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -215,7 +180,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD`*/} -Defined in: [src/screens/reset-password/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password/index.ts#L20) +Defined in: [src/screens/reset-password/index.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password/index.ts#L20) #### Overrides @@ -227,7 +192,7 @@ Defined in: [src/screens/reset-password/index.ts:20](https://github.com/auth0/un <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -246,7 +211,7 @@ An array of error objects from the transaction context. <ParamField body='resetPassword' type='Promise<void>'> {/*> **resetPassword**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password/index.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password/index.ts#L42) +Defined in: [src/screens/reset-password/index.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password/index.ts#L42) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions">ResetPasswordOptions</a></span>}> @@ -279,7 +244,7 @@ resetPassword.resetPassword({ <ParamField body='validatePassword' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> {/*> **validatePassword**(`password`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult)*/} -Defined in: [src/screens/reset-password/index.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password/index.ts#L55) +Defined in: [src/screens/reset-password/index.ts:55](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password/index.ts#L55) **`Utility Feature`** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordEmail.mdx index 2254f4801..c607797df 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordEmail.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordEmail.mdx @@ -2,35 +2,14 @@ title: "ResetPasswordEmail" --- -Defined in: [src/screens/reset-password-email/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-email/index.ts#L16) +Defined in: [src/screens/reset-password-email/index.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-email/index.ts#L16) <RequestExample> ```ts -export default class ResetPasswordEmail extends BaseContext implements ResetPasswordEmailMembers { - static screenIdentifier: string = ScreenIds.RESET_PASSWORD_EMAIL; - screen: ScreenOptions; - - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - /** - * @example - * import ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email'; - * - * const resetPasswordEmail = new ResetPasswordEmail(); - * resetPasswordEmail.resendEmail(); - */ - async resendEmail(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordEmail.screenIdentifier, 'resendEmail'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND_EMAIL }); - } -} +import ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email'; +const resetPasswordEmail = new ResetPasswordEmail(); +resetPasswordEmail.resendEmail(); ``` </RequestExample> @@ -47,7 +26,7 @@ export default class ResetPasswordEmail extends BaseContext implements ResetPass <ParamField body="ResetPasswordEmail" type="Constructor"> {/*> **new ResetPasswordEmail**(): `ResetPasswordEmail`*/} -Defined in: [src/screens/reset-password-email/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-email/index.ts#L20) +Defined in: [src/screens/reset-password-email/index.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-email/index.ts#L20) #### Returns @@ -63,7 +42,7 @@ Defined in: [src/screens/reset-password-email/index.ts:20](https://github.com/au <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -78,7 +57,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -93,7 +72,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -108,7 +87,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -123,7 +102,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail">ScreenMembersOnResetPasswordEmail</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordEmail`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail)*/} -Defined in: [src/screens/reset-password-email/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-email/index.ts#L18) +Defined in: [src/screens/reset-password-email/index.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-email/index.ts#L18) #### Implementation of @@ -138,7 +117,7 @@ Defined in: [src/screens/reset-password-email/index.ts:18](https://github.com/au <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -153,7 +132,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -168,7 +147,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -183,7 +162,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -198,7 +177,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_EMAIL`*/} -Defined in: [src/screens/reset-password-email/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-email/index.ts#L17) +Defined in: [src/screens/reset-password-email/index.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-email/index.ts#L17) #### Overrides @@ -210,7 +189,7 @@ Defined in: [src/screens/reset-password-email/index.ts:17](https://github.com/au <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -229,7 +208,7 @@ An array of error objects from the transaction context. <ParamField body='resendEmail' type='Promise<void>'> {/*> **resendEmail**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-email/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-email/index.ts#L32) +Defined in: [src/screens/reset-password-email/index.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-email/index.ts#L32) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordError.mdx index e6148d7cc..44cf8d011 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordError.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordError.mdx @@ -2,24 +2,9 @@ title: "ResetPasswordError" --- -Defined in: [src/screens/reset-password-error/index.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-error/index.ts#L8) +Defined in: [src/screens/reset-password-error/index.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-error/index.ts#L8) -<RequestExample> -```ts -export default class ResetPasswordError extends BaseContext implements ResetPasswordErrorMembers { - static screenIdentifier: string = ScreenIds.RESET_PASSWORD_ERROR; - screen: ScreenOptions; - - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } -} -``` -</RequestExample> - ## Extends - `BaseContext` @@ -33,7 +18,7 @@ export default class ResetPasswordError extends BaseContext implements ResetPass <ParamField body="ResetPasswordError" type="Constructor"> {/*> **new ResetPasswordError**(): `ResetPasswordError`*/} -Defined in: [src/screens/reset-password-error/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-error/index.ts#L12) +Defined in: [src/screens/reset-password-error/index.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-error/index.ts#L12) #### Returns @@ -49,7 +34,7 @@ Defined in: [src/screens/reset-password-error/index.ts:12](https://github.com/au <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -64,7 +49,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -79,7 +64,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -94,7 +79,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -109,7 +94,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError">ScreenMembersOnResetPasswordError</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError)*/} -Defined in: [src/screens/reset-password-error/index.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-error/index.ts#L10) +Defined in: [src/screens/reset-password-error/index.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-error/index.ts#L10) #### Implementation of @@ -124,7 +109,7 @@ Defined in: [src/screens/reset-password-error/index.ts:10](https://github.com/au <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -139,7 +124,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -154,7 +139,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -169,7 +154,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -184,7 +169,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_ERROR`*/} -Defined in: [src/screens/reset-password-error/index.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-error/index.ts#L9) +Defined in: [src/screens/reset-password-error/index.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-error/index.ts#L9) #### Overrides @@ -196,7 +181,7 @@ Defined in: [src/screens/reset-password-error/index.ts:9](https://github.com/aut <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge.mdx index 2b9a355c3..dfe22f611 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge.mdx @@ -2,123 +2,19 @@ title: "ResetPasswordMfaEmailChallenge" --- -Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L23) +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L23) Class implementing the reset-password-mfa-email-challenge screen functionality <RequestExample> ```ts -export default class ResetPasswordMfaEmailChallenge extends BaseContext implements ResetPasswordMfaEmailChallengeMembers { - static screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_EMAIL_CHALLENGE; - screen: ScreenOptions; - - /** - * Creates an instance of ResetPasswordMfaEmailChallenge screen manager - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Continues with the email challenge using the provided code. - * @param payload The options containing the code and rememberDevice flag. - * @example - * ```typescript - * import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; - * - * const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); - * await resetPasswordMfaEmailChallenge.continue({ - * code: '123456', - * }); - * ``` - */ - async continue(payload: ContinueOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaEmailChallenge.screenIdentifier, 'continue'], - }; - const submitPayload: Record<string, string | number | boolean> = { ...payload, action: 'default' }; - - await new FormHandler(options).submitData(submitPayload); - } - - /** - * Resends the email code. - * @param payload Optional custom options to include with the request. - * @example - * ```typescript - * import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; - * - * const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); - * await resetPasswordMfaEmailChallenge.resendCode(); - * ``` - */ - async resendCode(payload?: ResendCodeOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaEmailChallenge.screenIdentifier, 'resendCode'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND_CODE }); - } - - /** - * Allows the user to try another MFA method. - * @param payload Optional custom options to include with the request. - * @example - * ```typescript - * import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; - * - * const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); - * await resetPasswordMfaEmailChallenge.tryAnotherMethod(); - * ``` - */ - async tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaEmailChallenge.screenIdentifier, 'tryAnotherMethod'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.PICK_AUTHENTICATOR }); - } +import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; - /** - * Gets resend functionality with timeout management for this screen - * @param options - Configuration options for resend functionality - * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) - * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) - * @param options.onTimeout - Callback to execute when timeout countdown reaches zero - * @returns ResendControl object with startResend method - * @utilityFeature - * - * @example - * ```typescript - * import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; - * - * const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); - * const { startResend } = resetPasswordMfaEmailChallenge.resendManager({ - * timeoutSeconds: 15, - * onStatusChange: (remainingSeconds, isDisabled) => { - * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); - * }, - * onTimeout: () => { - * console.log('Resend is now available'); - * } - * }); - * - * // Call startResend when user clicks resend button - * startResend(); - * ``` - */ - resendManager(options?: StartResendOptions): ResendControl { - return createResendControl( - ResetPasswordMfaEmailChallenge.screenIdentifier, - () => this.resendCode(), - options - ); - } -} +const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); +await resetPasswordMfaEmailChallenge.continue({ + code: '123456', +}); ``` </RequestExample> @@ -135,7 +31,7 @@ export default class ResetPasswordMfaEmailChallenge extends BaseContext implemen <ParamField body="ResetPasswordMfaEmailChallenge" type="Constructor"> {/*> **new ResetPasswordMfaEmailChallenge**(): `ResetPasswordMfaEmailChallenge`*/} -Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L30) +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L30) Creates an instance of ResetPasswordMfaEmailChallenge screen manager @@ -153,7 +49,7 @@ Creates an instance of ResetPasswordMfaEmailChallenge screen manager <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -168,7 +64,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -183,7 +79,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -198,7 +94,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -213,7 +109,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge">ScreenMembersOnResetPasswordMfaEmailChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge)*/} -Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L25) +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L25) #### Implementation of @@ -228,7 +124,7 @@ Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:25](https:/ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -243,7 +139,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -258,7 +154,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -273,7 +169,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -288,7 +184,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_EMAIL_CHALLENGE`*/} -Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L24) +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L24) #### Overrides @@ -300,7 +196,7 @@ Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:24](https:/ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L49) +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L49) Continues with the email challenge using the provided code. @@ -336,7 +232,7 @@ await resetPasswordMfaEmailChallenge.continue({ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -355,7 +251,7 @@ An array of error objects from the transaction context. <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:70](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L70) +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:70](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L70) Resends the email code. @@ -389,7 +285,7 @@ await resetPasswordMfaEmailChallenge.resendCode(); <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:125](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L125) +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:125](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L125) **`Utility Feature`** @@ -438,7 +334,7 @@ startResend(); <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L89) +Defined in: [src/screens/reset-password-mfa-email-challenge/index.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L89) Allows the user to try another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge.mdx index 777b796f6..76adad07a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge.mdx @@ -2,71 +2,19 @@ title: "ResetPasswordMfaOtpChallenge" --- -Defined in: [src/screens/reset-password-mfa-otp-challenge/index.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L16) +Defined in: [src/screens/reset-password-mfa-otp-challenge/index.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L16) Class implementing the reset-password-mfa-otp-challenge screen functionality <RequestExample> ```ts -export default class ResetPasswordMfaOtpChallenge extends BaseContext implements ResetPasswordMfaOtpChallengeMembers { - /** - * Screen identifier for validation and telemetry - */ - static screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_OTP_CHALLENGE; - /** - * Creates an instance of ResetPasswordMfaOtpChallenge screen manager - */ - constructor() { - super(); - } - - /** - * Continues with the OTP challenge using the provided code. - * @param payload The options containing the code. - * @example - * ```typescript - * import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge'; - * - * const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge(); - * await resetPasswordMfaOtpChallenge.continue({ - * code: '123456', - * }); - * ``` - */ - async continue(payload: ContinueOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaOtpChallenge.screenIdentifier, 'continue'], - }; - await new FormHandler(options).submitData<ContinueOptions>({ - ...payload, - action: FormActions.DEFAULT, - }); - } - - /** - * Allows the user to try another MFA method. - * @param payload Optional custom options to include with the request. - * @example - * ```typescript - * import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge'; - * - * const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge(); - * await resetPasswordMfaOtpChallenge.tryAnotherMethod(); - * ``` - */ - async tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaOtpChallenge.screenIdentifier, 'continue'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } -} +import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge'; + +const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge(); +await resetPasswordMfaOtpChallenge.continue({ + code: '123456', +}); ``` </RequestExample> @@ -83,7 +31,7 @@ export default class ResetPasswordMfaOtpChallenge extends BaseContext implements <ParamField body="ResetPasswordMfaOtpChallenge" type="Constructor"> {/*> **new ResetPasswordMfaOtpChallenge**(): `ResetPasswordMfaOtpChallenge`*/} -Defined in: [src/screens/reset-password-mfa-otp-challenge/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L24) +Defined in: [src/screens/reset-password-mfa-otp-challenge/index.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L24) Creates an instance of ResetPasswordMfaOtpChallenge screen manager @@ -101,7 +49,7 @@ Creates an instance of ResetPasswordMfaOtpChallenge screen manager <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -116,7 +64,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -131,7 +79,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -146,7 +94,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -161,7 +109,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -176,7 +124,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -191,7 +139,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -206,7 +154,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -221,7 +169,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -236,7 +184,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_OTP_CHALLENGE`*/} -Defined in: [src/screens/reset-password-mfa-otp-challenge/index.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L20) +Defined in: [src/screens/reset-password-mfa-otp-challenge/index.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L20) Screen identifier for validation and telemetry @@ -250,7 +198,7 @@ Screen identifier for validation and telemetry <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-otp-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L41) +Defined in: [src/screens/reset-password-mfa-otp-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L41) Continues with the OTP challenge using the provided code. @@ -286,7 +234,7 @@ await resetPasswordMfaOtpChallenge.continue({ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -305,7 +253,7 @@ An array of error objects from the transaction context. <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-otp-challenge/index.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L63) +Defined in: [src/screens/reset-password-mfa-otp-challenge/index.ts:63](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L63) Allows the user to try another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge.mdx index 9a809502d..37e5d0dbe 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge.mdx @@ -2,120 +2,19 @@ title: "ResetPasswordMfaPhoneChallenge" --- -Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L23) +Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L23) ResetPasswordMfaPhoneChallenge <RequestExample> ```ts -export default class ResetPasswordMfaPhoneChallenge extends BaseContext implements ResetPasswordMfaPhoneChallengeMembers { - /** - * The unique identifier for this screen, used internally and for telemetry. - * @type {string} - */ - static screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_PHONE_CHALLENGE; // Use the exact screen name from context definition - - /** - * Holds the specific screen data and properties, processed by ScreenOverride. - * @type {ScreenOptions} - */ - screen: ScreenOptions; - - /** - * Initializes a new instance of the `ResetPasswordMfaPhoneChallenge` class. - * It retrieves the screen context and sets up the screen-specific properties. - * @throws {Error} If the Universal Login Context is not available or if the screen name doesn't match. - */ - constructor() { - super(); // Calls BaseContext constructor which handles context retrieval and validation - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Sends the verification code to the user's phone via the selected method (SMS or Voice). - * Corresponds to the 'Continue' action in the OpenAPI definition (action: 'default'). - * - * @param {ContinueOptions} payload - Contains the delivery type (`sms` or `voice`) and any optional custom data. - * @returns {Promise<void>} A promise resolving upon successful submission to the server. - * @throws {Error} If the form submission fails. - * @example - * ```typescript - * const screen = new ResetPasswordMfaPhoneChallenge(); - * try { - * await screen.continue({ type: 'sms' }); - * // Redirects to code entry screen on success - * } catch (error) { - * console.error("Failed to send SMS code:", error); - * } - * ``` - */ - async continue(payload: ContinueOptions): Promise<void> { - // Prepare options for the FormHandler - const formHandlerOptions: FormOptions = { - // The state token identifying the current transaction - state: this.transaction.state, - // Telemetry data identifying the screen and method for monitoring - telemetry: [ResetPasswordMfaPhoneChallenge.screenIdentifier, 'continue'], - // The route endpoint for this action (typically inferred if not provided) - // As per OpenAPI, the endpoint is /u/mfa-phone-challenge - route: '/u/mfa-phone-challenge', - }; - - // Construct the data payload to be sent in the form submission - const submitPayload = { - // Include any other custom options passed in the payload - ...payload, - // Set the action to 'default' as specified by the OpenAPI definition for this operation - action: FormActions.DEFAULT, - }; - - // Use FormHandler to submit the data via a POST request - await new FormHandler(formHandlerOptions).submitData(submitPayload); - } - - /** - * Initiates the process for the user to select a different MFA authenticator. - * Corresponds to the 'Try Another Method' action in the OpenAPI definition (action: 'pick-authenticator'). - * - * @param {TryAnotherMethodOptions} payload - Contains the *current* challenge type (`sms` or `voice`) as required by the API, and any optional custom data. - * @returns {Promise<void>} A promise resolving upon successful submission to the server. - * @throws {Error} If the form submission fails. - * @example - * ```typescript - * const screen = new ResetPasswordMfaPhoneChallenge(); - * try { - * // Assuming the current screen was for SMS - * await screen.tryAnotherMethod({ type: 'sms' }); - * // Redirects to authenticator selection screen on success - * } catch (error) { - * console.error("Failed to switch MFA method:", error); - * } - * ``` - */ - async tryAnotherMethod(payload: TryAnotherMethodOptions): Promise<void> { - // Prepare options for the FormHandler - const formHandlerOptions: FormOptions = { - // The state token identifying the current transaction - state: this.transaction.state, - // Telemetry data identifying the screen and method - telemetry: [ResetPasswordMfaPhoneChallenge.screenIdentifier, 'tryAnotherMethod'], - // The route endpoint for this action - route: '/u/mfa-phone-challenge', - }; - - // Construct the data payload for the form submission - const submitPayload = { - // Include any other custom options passed in the payload - ...payload, - // Set the action to 'pick-authenticator' as specified by the OpenAPI definition - action: FormActions.PICK_AUTHENTICATOR, - }; - - // Use FormHandler to submit the data - await new FormHandler(formHandlerOptions).submitData(submitPayload); - } +const screen = new ResetPasswordMfaPhoneChallenge(); +try { + await screen.continue({ type: 'sms' }); + // Redirects to code entry screen on success +} catch (error) { + console.error("Failed to send SMS code:", error); } ``` </RequestExample> @@ -133,7 +32,7 @@ export default class ResetPasswordMfaPhoneChallenge extends BaseContext implemen <ParamField body="ResetPasswordMfaPhoneChallenge" type="Constructor"> {/*> **new ResetPasswordMfaPhoneChallenge**(): `ResetPasswordMfaPhoneChallenge`*/} -Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L41) +Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L41) Initializes a new instance of the `ResetPasswordMfaPhoneChallenge` class. It retrieves the screen context and sets up the screen-specific properties. @@ -156,7 +55,7 @@ If the Universal Login Context is not available or if the screen name doesn't ma <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -171,7 +70,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) Access to client-specific information (e.g., client ID, name). @@ -188,7 +87,7 @@ Access to client-specific information (e.g., client ID, name). <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) Access to organization-specific information, if applicable. @@ -205,7 +104,7 @@ Access to organization-specific information, if applicable. <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) Access to prompt details (e.g., prompt name). @@ -222,7 +121,7 @@ Access to prompt details (e.g., prompt name). <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge">ScreenMembersOnResetPasswordMfaPhoneChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge)*/} -Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L34) +Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L34) Holds the specific screen data and properties, processed by ScreenOverride. @@ -239,7 +138,7 @@ Holds the specific screen data and properties, processed by ScreenOverride. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -254,7 +153,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) Access to the current transaction details (e.g., state, errors). @@ -271,7 +170,7 @@ Access to the current transaction details (e.g., state, errors). <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -286,7 +185,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -301,7 +200,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_PHONE_CHALLENGE`*/} -Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L28) +Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L28) The unique identifier for this screen, used internally and for telemetry. @@ -315,7 +214,7 @@ The unique identifier for this screen, used internally and for telemetry. <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:65](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L65) +Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:65](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L65) Sends the verification code to the user's phone via the selected method (SMS or Voice). Corresponds to the 'Continue' action in the OpenAPI definition (action: 'default'). @@ -359,7 +258,7 @@ try { <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -378,7 +277,7 @@ An array of error objects from the transaction context. <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:108](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L108) +Defined in: [src/screens/reset-password-mfa-phone-challenge/index.ts:108](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-phone-challenge/index.ts#L108) Initiates the process for the user to select a different MFA authenticator. Corresponds to the 'Try Another Method' action in the OpenAPI definition (action: 'pick-authenticator'). diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush.mdx index 5aacc7a92..e2083888c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaPushChallengePush" --- -Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L21) +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L21) Class representing the reset-password-mfa-push-challenge-push screen functionality This screen is shown when a push notification has been sent to the user's device during password reset @@ -10,147 +10,10 @@ This screen is shown when a push notification has been sent to the user's device <RequestExample> ```ts -export default class ResetPasswordMfaPushChallengePush extends BaseContext implements ResetPasswordMfaPushChallengePushMembers { - static screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_PUSH_CHALLENGE_PUSH; - screen: ScreenOptions; - - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Continues with the push notification challenge - * @param payload Optional custom options to include with the request - * @example - * ```typescript - * import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; - * - * const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); - * await resetPasswordMfaPushChallengePush.continue(); - * ``` - */ - async continue(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaPushChallengePush.screenIdentifier, 'continue'], - }; - await new FormHandler(options).submitData<CustomOptions>(payload || {}); - } - - /** - * Re-sends the push notification - * @param payload Optional custom options to include with the request - * @example - * ```typescript - * import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; - * - * const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); - * await resetPasswordMfaPushChallengePush.resendPushNotification(); - * ``` - */ - async resendPushNotification(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaPushChallengePush.screenIdentifier, 'resendPushNotification'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.RESEND, - }); - } - - /** - * Switches to entering the verification code manually - * @param payload Optional custom options to include with the request - * @example - * ```typescript - * import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; - * - * const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); - * await resetPasswordMfaPushChallengePush.enterCodeManually(); - * ``` - */ - async enterCodeManually(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaPushChallengePush.screenIdentifier, 'enterCodeManually'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.ENTER_OTP_CODE, - }); - } - - /** - * Allows trying another authentication method - * @param payload Optional custom options to include with the request - * @example - * ```typescript - * import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; - * - * const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); - * await resetPasswordMfaPushChallengePush.tryAnotherMethod(); - * ``` - */ - async tryAnotherMethod(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaPushChallengePush.screenIdentifier, 'tryAnotherMethod'], - }; - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } - - /** - * Starts and manages polling for an MFA push challenge. - * - * Creates a polling session that repeatedly checks the MFA push challenge endpoint - * at the specified interval until the challenge is approved or an error occurs. - * When the approval condition is met, the provided - * {@link MfaPollingOptions.onCompleted | onCompleted} callback is invoked and - * polling stops automatically. - * - * Use the returned {@link MfaPushPollingControl} to start, stop, or check the - * status of the polling process at any time. - * - * @param options - {@link MfaPollingOptions | Configuration options} for the polling process: - * - `intervalMs` — Optional polling interval in milliseconds (defaults to SDK’s internal value, typically 5000 ms). - * - `onCompleted` — Optional callback fired when the MFA push is successfully approved. - * - `onError` — Optional callback fired when a polling error occurs, receiving an {@link ULError}. - * - * @returns A {@link MfaPushPollingControl} instance exposing: - * - `startPolling()` — Starts or resumes polling. - * - `stopPolling()` — Cancels polling immediately. - * - `isRunning()` — Indicates whether polling is currently active. - * - * @utilityFeature - * - * @example - * ```ts - * // Start polling every 5 seconds until the push challenge is approved - * const control = mfaPushChallengePush.pollingManager({ - * intervalMs: 5000, - * onCompleted: () => mfaPushChallengePush.continue(), - * onError: (error) => console.error('Polling error:', error), - * }); - * - * // Later, cancel polling if needed - * control.stopPolling(); - * ``` - * - * @remarks - * - HTTP 429 (rate limit) responses are handled internally: polling automatically - * waits until the rate limit resets before retrying. - * - Safe to call `startPolling()` multiple times; it has no effect if already running. - */ - pollingManager(options: MfaPollingOptions = {}): MfaPushPollingControl { - return createPollingControl(options); - } -} +import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; + +const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); +await resetPasswordMfaPushChallengePush.continue(); ``` </RequestExample> @@ -167,7 +30,7 @@ export default class ResetPasswordMfaPushChallengePush extends BaseContext imple <ParamField body="ResetPasswordMfaPushChallengePush" type="Constructor"> {/*> **new ResetPasswordMfaPushChallengePush**(): `ResetPasswordMfaPushChallengePush`*/} -Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L25) +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L25) #### Returns @@ -183,7 +46,7 @@ Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:25](htt <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -198,7 +61,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -213,7 +76,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -228,7 +91,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -243,7 +106,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush">ScreenMembersOnResetPasswordMfaPushChallengePush</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush)*/} -Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L23) +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L23) #### Implementation of @@ -258,7 +121,7 @@ Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:23](htt <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -273,7 +136,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -288,7 +151,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -303,7 +166,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -318,7 +181,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_PUSH_CHALLENGE_PUSH`*/} -Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L22) +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L22) #### Overrides @@ -330,7 +193,7 @@ Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:22](htt <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L42) +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L42) Continues with the push notification challenge @@ -364,7 +227,7 @@ await resetPasswordMfaPushChallengePush.continue(); <ParamField body='enterCodeManually' type='Promise<void>'> {/*> **enterCodeManually**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L83) +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L83) Switches to entering the verification code manually @@ -398,7 +261,7 @@ await resetPasswordMfaPushChallengePush.enterCodeManually(); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -417,7 +280,7 @@ An array of error objects from the transaction context. <ParamField body='pollingManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> {/*> **pollingManager**(`options`): [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl)*/} -Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:158](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L158) +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:158](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L158) **`Utility Feature`** @@ -481,7 +344,7 @@ control.stopPolling(); <ParamField body='resendPushNotification' type='Promise<void>'> {/*> **resendPushNotification**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L61) +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:61](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L61) Re-sends the push notification @@ -515,7 +378,7 @@ await resetPasswordMfaPushChallengePush.resendPushNotification(); <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:105](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L105) +Defined in: [src/screens/reset-password-mfa-push-challenge-push/index.ts:105](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L105) Allows trying another authentication method diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx index f09b4771e..070429f2e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx @@ -2,84 +2,23 @@ title: "ResetPasswordMfaRecoveryCodeChallenge" --- -Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L12) +Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L12) Class implementing the Reset Password MFA Recovery Code Challenge screen functionality. <RequestExample> ```ts -export default class ResetPasswordMfaRecoveryCodeChallenge extends BaseContext implements ResetPasswordMfaRecoveryCodeChallengeMembers { - static screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_RECOVERY_CODE_CHALLENGE; - - /** - * Creates an instance of the ResetPasswordMfaRecoveryCodeChallenge screen. - */ - constructor() { - super(); - } - - /** - * Continues with the provided recovery code. - * @param {string} code - The recovery code entered by the user. - * @param {CustomOptions} [payload] - Optional payload. - * @returns {Promise<void>} - * @example - * ```typescript - * import ResetPasswordMfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/reset-password-mfa-recovery-code-challenge'; - * const resetPasswordMfaManager = new ResetPasswordMfaRecoveryCodeChallenge(); - * const continueWithRecoveryCode = async () => { - * try { - * await resetPasswordMfaManager.continue('RECOVERY_CODE'); - * console.log('Recovery code submitted successfully.'); - * } catch (error) { - * console.error('Error submitting recovery code:', error); - * } - * }; - * ``` - */ - async continue(code: string, payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaRecoveryCodeChallenge.screenIdentifier, 'continue'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - code, - action: FormActions.DEFAULT, - }); - } - - /** - * Navigates to the screen where the user can pick another MFA method. - * @param {CustomOptions} [payload] - Optional payload. - * @returns {Promise<void>} - * @example - * ```typescript - * import ResetPasswordMfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/reset-password-mfa-recovery-code-challenge'; - * const resetPasswordMfaRecoveryCodeChallengeManager = new ResetPasswordMfaRecoveryCodeChallenge(); - * const handleTryAnotherMethod = async () => { - * try { - * await resetPasswordMfaRecoveryCodeChallengeManager.tryAnotherMethod(); - * } catch (error) { - * console.error('Failed to try another method:', error); - * } - * }; - * ``` - */ - async tryAnotherMethod(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaRecoveryCodeChallenge.screenIdentifier, 'tryAnotherMethod'], - }; - - await new FormHandler(options).submitData<CustomOptions>({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } -} +import ResetPasswordMfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/reset-password-mfa-recovery-code-challenge'; +const resetPasswordMfaManager = new ResetPasswordMfaRecoveryCodeChallenge(); +const continueWithRecoveryCode = async () => { + try { + await resetPasswordMfaManager.continue('RECOVERY_CODE'); + console.log('Recovery code submitted successfully.'); + } catch (error) { + console.error('Error submitting recovery code:', error); + } +}; ``` </RequestExample> @@ -96,7 +35,7 @@ export default class ResetPasswordMfaRecoveryCodeChallenge extends BaseContext i <ParamField body="ResetPasswordMfaRecoveryCodeChallenge" type="Constructor"> {/*> **new ResetPasswordMfaRecoveryCodeChallenge**(): `ResetPasswordMfaRecoveryCodeChallenge`*/} -Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L18) +Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L18) Creates an instance of the ResetPasswordMfaRecoveryCodeChallenge screen. @@ -114,7 +53,7 @@ Creates an instance of the ResetPasswordMfaRecoveryCodeChallenge screen. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -129,7 +68,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -144,7 +83,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -159,7 +98,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -174,7 +113,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -189,7 +128,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -204,7 +143,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -219,7 +158,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -234,7 +173,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -249,7 +188,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_RECOVERY_CODE_CHALLENGE`*/} -Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L13) +Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L13) #### Overrides @@ -261,7 +200,7 @@ Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:13] <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`code`, `payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L41) +Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L41) Continues with the provided recovery code. @@ -306,7 +245,7 @@ const continueWithRecoveryCode = async () => { <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -325,7 +264,7 @@ An array of error objects from the transaction context. <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:71](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L71) +Defined in: [src/screens/reset-password-mfa-recovery-code-challenge/index.ts:71](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L71) Navigates to the screen where the user can pick another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge.mdx index a86347a85..ea0f49720 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge.mdx @@ -2,142 +2,19 @@ title: "ResetPasswordMfaSmsChallenge" --- -Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L22) +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L22) This class provides methods to handle the reset-password-mfa-sms-challenge screen. <RequestExample> ```ts -export default class ResetPasswordMfaSmsChallenge extends BaseContext implements ResetPasswordMfaSmsChallengeMembers { - static screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_SMS_CHALLENGE; - screen: ScreenOptions; - - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Submits the MFA SMS challenge with the provided code. - * @param {MfaSmsChallengeOptions} payload - The payload containing the code. - * @returns {Promise<void>} - * @example - * ```typescript - * import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; - * - * const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); - * await resetPasswordMfaSmsChallenge.continueMfaSmsChallenge({ - * code: '123456', - * }); - * ``` - */ - async continueMfaSmsChallenge(payload: MfaSmsChallengeOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaSmsChallenge.screenIdentifier, 'continueMfaSmsChallenge'], - }; - const submitPayload: Record<string, string | number | boolean> = { ...payload, action: 'default' }; - await new FormHandler(options).submitData(submitPayload); - } - - /** - * Submits the action to resend the SMS code. - * @param {CustomOptions} [payload] - Optional payload. - * @returns {Promise<void>} - * @example - * ```typescript - * import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; - * - * const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); - * await resetPasswordMfaSmsChallenge.resendCode(); - * ``` - */ - async resendCode(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaSmsChallenge.screenIdentifier, 'resendCode'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.RESEND_CODE }); - } - - /** - * Submits the action to try another MFA method. - * @param {CustomOptions} [payload] - Optional payload. - * @returns {Promise<void>} - * @example - * ```typescript - * import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; - * - * const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); - * await resetPasswordMfaSmsChallenge.tryAnotherMethod(); - * ``` - */ - async tryAnotherMethod(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaSmsChallenge.screenIdentifier, 'tryAnotherMethod'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.PICK_AUTHENTICATOR }); - } - - /** - * Submits the action to switch to voice call verification. - * @param {CustomOptions} [payload] - Optional payload. - * @returns {Promise<void>} - * @example - * ```typescript - * import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; - * - * const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); - * await resetPasswordMfaSmsChallenge.getACall(); - * ``` - */ - async getACall(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaSmsChallenge.screenIdentifier, 'getACall'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.SWITCH_TO_VOICE }); - } +import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; - /** - * Gets resend functionality with timeout management for this screen - * @param options - Configuration options for resend functionality - * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) - * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) - * @param options.onTimeout - Callback to execute when timeout countdown reaches zero - * @returns ResendControl object with startResend method - * @utilityFeature - * - * @example - * ```typescript - * import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; - * - * const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); - * const { startResend } = resetPasswordMfaSmsChallenge.resendManager({ - * timeoutSeconds: 15, - * onStatusChange: (remainingSeconds, isDisabled) => { - * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); - * }, - * onTimeout: () => { - * console.log('Resend is now available'); - * } - * }); - * - * // Call startResend when user clicks resend button - * startResend(); - * ``` - */ - resendManager(options?: StartResendOptions): ResendControl { - return createResendControl( - ResetPasswordMfaSmsChallenge.screenIdentifier, - () => this.resendCode(), - options - ); - } -} +const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); +await resetPasswordMfaSmsChallenge.continueMfaSmsChallenge({ + code: '123456', +}); ``` </RequestExample> @@ -154,7 +31,7 @@ export default class ResetPasswordMfaSmsChallenge extends BaseContext implements <ParamField body="ResetPasswordMfaSmsChallenge" type="Constructor"> {/*> **new ResetPasswordMfaSmsChallenge**(): `ResetPasswordMfaSmsChallenge`*/} -Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L26) +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L26) #### Returns @@ -170,7 +47,7 @@ Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:26](https://g <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -185,7 +62,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -200,7 +77,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -215,7 +92,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -230,7 +107,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge">ScreenMembersOnResetPasswordMfaSmsChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge)*/} -Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L24) +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L24) #### Implementation of @@ -245,7 +122,7 @@ Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:24](https://g <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -260,7 +137,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -275,7 +152,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -290,7 +167,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -305,7 +182,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_SMS_CHALLENGE`*/} -Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L23) +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L23) #### Overrides @@ -317,7 +194,7 @@ Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:23](https://g <ParamField body='continueMfaSmsChallenge' type='Promise<void>'> {/*> **continueMfaSmsChallenge**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L46) +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L46) Submits the MFA SMS challenge with the provided code. @@ -353,7 +230,7 @@ await resetPasswordMfaSmsChallenge.continueMfaSmsChallenge({ <ParamField body='getACall' type='Promise<void>'> {/*> **getACall**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:107](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L107) +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:107](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L107) Submits the action to switch to voice call verification. @@ -387,7 +264,7 @@ await resetPasswordMfaSmsChallenge.getACall(); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -406,7 +283,7 @@ An array of error objects from the transaction context. <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:67](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L67) +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:67](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L67) Submits the action to resend the SMS code. @@ -440,7 +317,7 @@ await resetPasswordMfaSmsChallenge.resendCode(); <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:143](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L143) +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:143](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L143) **`Utility Feature`** @@ -489,7 +366,7 @@ startResend(); <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L87) +Defined in: [src/screens/reset-password-mfa-sms-challenge/index.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L87) Submits the action to try another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge.mdx index ec1100cdd..e882c213a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge.mdx @@ -2,140 +2,15 @@ title: "ResetPasswordMfaVoiceChallenge" --- -Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L25) +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L25) Class implementing the reset-password-mfa-voice-challenge screen functionality. <RequestExample> ```ts -export default class ResetPasswordMfaVoiceChallenge extends BaseContext implements ResetPasswordMfaVoiceChallengeMembers { - static screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_VOICE_CHALLENGE; - screen: ScreenOptions; - - /** - * Creates an instance of ResetPasswordMfaVoiceChallenge screen manager. - */ - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - this.screen = new ScreenOverride(screenContext); - } - - /** - * Continues with the voice challenge using the provided code. - * - * @param payload - The options containing the code. - * @returns A promise that resolves when the challenge is submitted. - * - * @example - * ```ts - * const reset = new ResetPasswordMfaVoiceChallenge(); - * await reset.continue({ code: '123456' }); - * ``` - */ - async continue(payload: ContinueOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaVoiceChallenge.screenIdentifier, 'continue'], - }; - - await new FormHandler(options).submitData({ - ...payload, - action: FormActions.DEFAULT, - }); - } - - /** - * Switches to SMS verification. - * - * @param payload - Optional custom options to include with the request. - * @returns A promise that resolves when the action completes. - */ - async switchToSms(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaVoiceChallenge.screenIdentifier, 'switchToSms'], - }; - - await new FormHandler(options).submitData({ - ...payload, - action: FormActions.SWITCH_TO_SMS, - }); - } - - /** - * Resends the code via voice call. - * - * @param payload - Optional custom options to include with the request. - * @returns A promise that resolves when the code is resent. - */ - async resendCode(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaVoiceChallenge.screenIdentifier, 'resendCode'], - }; - - await new FormHandler(options).submitData({ - ...payload, - action: FormActions.RESEND_CODE, - }); - } - - /** - * Allows the user to try another MFA method. - * - * @param payload - Optional custom options to include with the request. - * @returns A promise that resolves when the request is submitted. - */ - async tryAnotherMethod(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordMfaVoiceChallenge.screenIdentifier, 'tryAnotherMethod'], - }; - - await new FormHandler(options).submitData({ - ...payload, - action: FormActions.PICK_AUTHENTICATOR, - }); - } - - /** - * Gets resend functionality with timeout management for this screen - * @param options - Configuration options for resend functionality - * @param options.timeoutSeconds - Number of seconds to wait before allowing resend (default: 10) - * @param options.onStatusChange - Callback to receive state updates (remaining seconds, disabled status) - * @param options.onTimeout - Callback to execute when timeout countdown reaches zero - * @returns ResendControl object with startResend method - * @utilityFeature - * - * @example - * ```typescript - * import ResetPasswordMfaVoiceChallenge from '@auth0/auth0-acul-js/reset-password-mfa-voice-challenge'; - * - * const resetPasswordMfaVoiceChallenge = new ResetPasswordMfaVoiceChallenge(); - * const { startResend } = resetPasswordMfaVoiceChallenge.resendManager({ - * timeoutSeconds: 15, - * onStatusChange: (remainingSeconds, isDisabled) => { - * console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`); - * }, - * onTimeout: () => { - * console.log('Resend is now available'); - * } - * }); - * - * // Call startResend when user clicks resend button - * startResend(); - * ``` - */ - resendManager(options?: StartResendOptions): ResendControl { - return createResendControl( - ResetPasswordMfaVoiceChallenge.screenIdentifier, - () => this.resendCode(), - options - ); - } -} +const reset = new ResetPasswordMfaVoiceChallenge(); +await reset.continue({ code: '123456' }); ``` </RequestExample> @@ -152,7 +27,7 @@ export default class ResetPasswordMfaVoiceChallenge extends BaseContext implemen <ParamField body="ResetPasswordMfaVoiceChallenge" type="Constructor"> {/*> **new ResetPasswordMfaVoiceChallenge**(): `ResetPasswordMfaVoiceChallenge`*/} -Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L32) +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L32) Creates an instance of ResetPasswordMfaVoiceChallenge screen manager. @@ -170,7 +45,7 @@ Creates an instance of ResetPasswordMfaVoiceChallenge screen manager. <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -185,7 +60,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -200,7 +75,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -215,7 +90,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -230,7 +105,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge">ScreenMembersOnResetPasswordMfaVoiceChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge)*/} -Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L27) +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L27) #### Implementation of @@ -245,7 +120,7 @@ Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:27](https:/ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -260,7 +135,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -275,7 +150,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -290,7 +165,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -305,7 +180,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_VOICE_CHALLENGE`*/} -Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L26) +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L26) #### Overrides @@ -317,7 +192,7 @@ Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:26](https:/ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L50) +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:50](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L50) Continues with the voice challenge using the provided code. @@ -351,7 +226,7 @@ await reset.continue({ code: '123456' }); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -370,7 +245,7 @@ An array of error objects from the transaction context. <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L86) +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L86) Resends the code via voice call. @@ -397,7 +272,7 @@ A promise that resolves when the code is resent. <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:144](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L144) +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:144](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L144) **`Utility Feature`** @@ -446,7 +321,7 @@ startResend(); <ParamField body='switchToSms' type='Promise<void>'> {/*> **switchToSms**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:68](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L68) +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:68](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L68) Switches to SMS verification. @@ -473,7 +348,7 @@ A promise that resolves when the action completes. <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:104](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L104) +Defined in: [src/screens/reset-password-mfa-voice-challenge/index.ts:104](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L104) Allows the user to try another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx index 1b94c71e3..ffe4479e3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx @@ -2,14 +2,27 @@ title: "ResetPasswordMfaWebAuthnPlatformChallenge" --- -Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L37) +Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L37) ResetPasswordMfaWebAuthnPlatformChallenge <RequestExample> ```ts -export default class ResetPasswordMfaWebAuthnPlatformChallenge +// Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge +try { + await sdk.continueWithPasskey({ + rememberDevice: true // if user checked the box and sdk.screen.showRememberDevice is true + }); + // On success, Auth0 handles redirection. +} catch (error) { + console.error("Platform authenticator verification failed:", error); + // If it's a WebAuthn API error (DOMException), report it + if (error instanceof DOMException && error.name && error.message) { // DOMException check + await sdk.reportBrowserError({ error: { name: error.name, message: error.message } }); + } + // Check sdk.transaction.errors for server-side validation messages if the page reloads. +} ``` </RequestExample> @@ -26,7 +39,7 @@ export default class ResetPasswordMfaWebAuthnPlatformChallenge <ParamField body="ResetPasswordMfaWebAuthnPlatformChallenge" type="Constructor"> {/*> **new ResetPasswordMfaWebAuthnPlatformChallenge**(): `ResetPasswordMfaWebAuthnPlatformChallenge`*/} -Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L64) +Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:64](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L64) Initializes a new instance of the `ResetPasswordMfaWebAuthnPlatformChallenge` class. It retrieves the necessary context (screen, transaction, etc.) from the global `universal_login_context` @@ -51,7 +64,7 @@ in the context does not match `ResetPasswordMfaWebAuthnPlatformChallenge.screenI <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -66,7 +79,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -81,7 +94,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -96,7 +109,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -111,7 +124,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge">ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge)*/} -Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L55) +Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:55](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L55) #### Implementation of @@ -126,7 +139,7 @@ Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -141,7 +154,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -156,7 +169,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -171,7 +184,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -186,7 +199,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_WEBAUTHN_PLATFORM_CHALLENGE`*/} -Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L47) +Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:47](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L47) static @@ -200,7 +213,7 @@ static <ParamField body='continueWithPasskey' type='Promise<void>'> {/*> **continueWithPasskey**(`options?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:102](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L102) +Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:102](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L102) Initiates the WebAuthn platform authenticator challenge by calling `navigator.credentials.get()` using the challenge options provided in `screen.publicKey`. @@ -257,7 +270,7 @@ try { <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -276,7 +289,7 @@ An array of error objects from the transaction context. <ParamField body='reportBrowserError' type='Promise<void>'> {/*> **reportBrowserError**(`options`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L168) +Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:168](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L168) Reports a browser-side error that occurred during the `navigator.credentials.get()` API call. This is used to inform Auth0 about issues like user cancellation (`NotAllowedError`), @@ -328,7 +341,7 @@ If the form submission fails (e.g., network error, invalid state). <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:212](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L212) +Defined in: [src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts:212](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L212) Allows the user to opt-out of the WebAuthn platform authenticator challenge and select a different MFA method for verifying their identity during password reset. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx index 65d44aef8..ab09020b0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx @@ -2,14 +2,35 @@ title: "ResetPasswordMfaWebAuthnRoamingChallenge" --- -Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L32) +Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L32) ResetPasswordMfaWebAuthnRoamingChallenge <RequestExample> ```ts -export default class ResetPasswordMfaWebAuthnRoamingChallenge +// In your UI component for the reset-password-mfa-webauthn-roaming-challenge screen: +const sdk = new ResetPasswordMfaWebAuthnRoamingChallenge(); + +async function handleSecurityKeyAuth() { + try { + const userWantsToRemember = document.getElementById('remember-device-checkbox')?.checked || false; + await sdk.useSecurityKey({ rememberDevice: sdk.screen.showRememberDevice && userWantsToRemember }); + // On success, Auth0 typically handles redirection. + } catch (err) { + console.error("Security key authentication failed:", err); + // If it's a WebAuthn API error, report it to Auth0 + if (err.name && err.message) { // Basic check for DOMException-like error + try { + await sdk.showError({ error: { name: err.name, message: err.message } }); + } catch (reportError) { + console.error("Failed to report WebAuthn error:", reportError); + } + } + // Update UI to inform the user, e.g., "Security key verification failed. Please try again." + // Also check `sdk.transaction.errors` if the page might have reloaded with an error message from the server. + } +} ``` </RequestExample> @@ -26,7 +47,7 @@ export default class ResetPasswordMfaWebAuthnRoamingChallenge <ParamField body="ResetPasswordMfaWebAuthnRoamingChallenge" type="Constructor"> {/*> **new ResetPasswordMfaWebAuthnRoamingChallenge**(): `ResetPasswordMfaWebAuthnRoamingChallenge`*/} -Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L58) +Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L58) Initializes a new instance of the `ResetPasswordMfaWebAuthnRoamingChallenge` class. It retrieves the necessary context (screen, transaction, etc.) from the global @@ -50,7 +71,7 @@ in the context does not match `ResetPasswordMfaWebAuthnRoamingChallenge.screenId <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -65,7 +86,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -80,7 +101,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -95,7 +116,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -110,7 +131,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge">ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge)*/} -Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L50) +Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:50](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L50) Holds the specific screen data and properties for this screen, @@ -129,7 +150,7 @@ Holds the specific screen data and properties for this screen, <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -144,7 +165,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -159,7 +180,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -174,7 +195,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -189,7 +210,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `readonly` `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_MFA_WEBAUTHN_ROAMING_CHALLENGE`*/} -Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L41) +Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L41) The unique identifier for this screen, used for internal SDK logic and telemetry. @@ -203,7 +224,7 @@ The unique identifier for this screen, used for internal SDK logic and telemetry <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -222,7 +243,7 @@ An array of error objects from the transaction context. <ParamField body='showError' type='Promise<void>'> {/*> **showError**(`options`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L170) +Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:170](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L170) Reports a client-side WebAuthn API error (from `navigator.credentials.get()`) to Auth0. This method is intended to be called when [useSecurityKey](#usesecuritykey) (or a direct call to @@ -271,7 +292,7 @@ if (webAuthnError instanceof DOMException) { <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:217](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L217) +Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:217](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L217) Allows the user to opt-out of the WebAuthn roaming authenticator challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate @@ -313,7 +334,7 @@ await sdk.tryAnotherMethod({ rememberDevice: userWantsToRemember }); <ParamField body='useSecurityKey' type='Promise<void>'> {/*> **useSecurityKey**(`options?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:109](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L109) +Defined in: [src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts:109](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-roaming-challenge/index.ts#L109) Initiates the WebAuthn security key challenge. This method internally calls `navigator.credentials.get()` using the challenge diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordRequest.mdx index 5af8a4a43..496e31c13 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordRequest.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordRequest.mdx @@ -2,70 +2,14 @@ title: "ResetPasswordRequest" --- -Defined in: [src/screens/reset-password-request/index.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L21) +Defined in: [src/screens/reset-password-request/index.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L21) <RequestExample> ```ts -export default class ResetPasswordRequest extends BaseContext implements ResetPasswordRequestMembers { - static screenIdentifier: string = ScreenIds.RESET_PASSWORD_REQUEST; - screen: ScreenOptions; - transaction: TransactionOptions; - - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - const transactionContext = this.getContext('transaction') as TransactionContext; - this.screen = new ScreenOverride(screenContext); - this.transaction = new TransactionOverride(transactionContext); - } - - /** - * @example - * import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request'; - * - * const resetPasswordRequest = new ResetPasswordRequest(); - * resetPasswordRequest.resetPassword({ username: 'testuser' }); - */ - async resetPassword(payload: ResetPasswordRequestOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordRequest.screenIdentifier, 'resetPassword'], - }; - const updatedPayload = updatePayloadByIdentifier(payload, this.transaction.hasFlexibleIdentifier); - await new FormHandler(options).submitData(updatedPayload); - } - - /** - * @example - * import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request'; - * - * const resetPasswordRequest = new ResetPasswordRequest(); - * resetPasswordRequest.backToLogin(); - */ - async backToLogin(payload?: CustomOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [ResetPasswordRequest.screenIdentifier, 'backToLogin'], - }; - await new FormHandler(options).submitData<CustomOptions>({ ...payload, action: FormActions.BACK_TO_LOGIN }); - } - - /** - * Gets the active identifier types for the reset-password-request screen - * @returns An array of active identifier types or null if none are active - * @example - * ```typescript - * import ResetPasswordRequest from "@auth0/auth0-acul-js/reset-password-request"; - * const resetPasswordRequest = new ResetPasswordRequest(); - * resetPasswordRequest.getLoginIdentifiers(); - * ``` - * @utilityFeature - */ - getLoginIdentifiers(): IdentifierType[] | null { - return _getLoginIdentifiers(this.transaction.allowedIdentifiers); - } -} +import ResetPasswordRequest from "@auth0/auth0-acul-js/reset-password-request"; +const resetPasswordRequest = new ResetPasswordRequest(); +resetPasswordRequest.getLoginIdentifiers(); ``` </RequestExample> @@ -82,7 +26,7 @@ export default class ResetPasswordRequest extends BaseContext implements ResetPa <ParamField body="ResetPasswordRequest" type="Constructor"> {/*> **new ResetPasswordRequest**(): `ResetPasswordRequest`*/} -Defined in: [src/screens/reset-password-request/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L26) +Defined in: [src/screens/reset-password-request/index.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L26) #### Returns @@ -98,7 +42,7 @@ Defined in: [src/screens/reset-password-request/index.ts:26](https://github.com/ <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -113,7 +57,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -128,7 +72,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -143,7 +87,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -158,7 +102,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest">ScreenMembersOnResetPasswordRequest</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest)*/} -Defined in: [src/screens/reset-password-request/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L23) +Defined in: [src/screens/reset-password-request/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L23) #### Implementation of @@ -173,7 +117,7 @@ Defined in: [src/screens/reset-password-request/index.ts:23](https://github.com/ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -188,7 +132,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest">TransactionMembersOnResetPasswordRequest</a></span>}> {/*> **transaction**: [`TransactionMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest)*/} -Defined in: [src/screens/reset-password-request/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L24) +Defined in: [src/screens/reset-password-request/index.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L24) #### Implementation of @@ -203,7 +147,7 @@ Defined in: [src/screens/reset-password-request/index.ts:24](https://github.com/ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -218,7 +162,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -233,7 +177,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_REQUEST`*/} -Defined in: [src/screens/reset-password-request/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L22) +Defined in: [src/screens/reset-password-request/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L22) #### Overrides @@ -245,7 +189,7 @@ Defined in: [src/screens/reset-password-request/index.ts:22](https://github.com/ <ParamField body='backToLogin' type='Promise<void>'> {/*> **backToLogin**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-request/index.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L57) +Defined in: [src/screens/reset-password-request/index.ts:57](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L57) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -275,7 +219,7 @@ resetPasswordRequest.backToLogin(); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -294,7 +238,7 @@ An array of error objects from the transaction context. <ParamField body='getLoginIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType">ScreenIdentifierType</a>[]</span>}> {/*> **getLoginIdentifiers**(): [`ScreenIdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType)[] \| `null`*/} -Defined in: [src/screens/reset-password-request/index.ts:76](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L76) +Defined in: [src/screens/reset-password-request/index.ts:76](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L76) **`Utility Feature`** @@ -323,7 +267,7 @@ resetPasswordRequest.getLoginIdentifiers(); <ParamField body='resetPassword' type='Promise<void>'> {/*> **resetPassword**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/reset-password-request/index.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L41) +Defined in: [src/screens/reset-password-request/index.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-request/index.ts#L41) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions">ResetPasswordRequestOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordSuccess.mdx index 1d2433734..0dd01bac4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordSuccess.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordSuccess.mdx @@ -2,21 +2,9 @@ title: "ResetPasswordSuccess" --- -Defined in: [src/screens/reset-password-success/index.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-success/index.ts#L9) +Defined in: [src/screens/reset-password-success/index.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-success/index.ts#L9) -<RequestExample> -```ts -export default class ResetPasswordSuccess extends BaseContext implements ResetPasswordSuccessMembers { - static screenIdentifier: string = ScreenIds.RESET_PASSWORD_SUCCESS; - - constructor() { - super(); - } -} -``` -</RequestExample> - ## Extends - `BaseContext` @@ -30,7 +18,7 @@ export default class ResetPasswordSuccess extends BaseContext implements ResetPa <ParamField body="ResetPasswordSuccess" type="Constructor"> {/*> **new ResetPasswordSuccess**(): `ResetPasswordSuccess`*/} -Defined in: [src/screens/reset-password-success/index.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-success/index.ts#L12) +Defined in: [src/screens/reset-password-success/index.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-success/index.ts#L12) #### Returns @@ -46,7 +34,7 @@ Defined in: [src/screens/reset-password-success/index.ts:12](https://github.com/ <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -61,7 +49,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -76,7 +64,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -91,7 +79,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -106,7 +94,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L24) +Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L24) #### Implementation of @@ -121,7 +109,7 @@ Defined in: [src/models/base-context.ts:24](https://github.com/auth0/universal-l <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -136,7 +124,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L29) +Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L29) #### Implementation of @@ -151,7 +139,7 @@ Defined in: [src/models/base-context.ts:29](https://github.com/auth0/universal-l <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -166,7 +154,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -181,7 +169,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_SUCCESS`*/} -Defined in: [src/screens/reset-password-success/index.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/reset-password-success/index.ts#L10) +Defined in: [src/screens/reset-password-success/index.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-success/index.ts#L10) #### Overrides @@ -193,7 +181,7 @@ Defined in: [src/screens/reset-password-success/index.ts:10](https://github.com/ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError.mdx index 3ea15473a..ec6336fec 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError.mdx @@ -2,24 +2,11 @@ title: "SDKUsageError" --- -Defined in: [src/utils/errors.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L46) +Defined in: [src/utils/errors.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L46) SDKUsageError -<RequestExample> -```ts -export class SDKUsageError extends AculError { - public readonly code = 'SDK_USAGE_ERROR'; - - constructor(message: string, field?: string) { - super(message, field); - Object.setPrototypeOf(this, new.target.prototype); - } -} -``` -</RequestExample> - ## Param The error message. @@ -37,7 +24,7 @@ The optional field associated with the error. <ParamField body="SDKUsageError" type="Constructor"> {/*> **new SDKUsageError**(`message`, `field?`): `SDKUsageError`*/} -Defined in: [src/utils/errors.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L49) +Defined in: [src/utils/errors.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L49) <Expandable title="Parameters"> <ParamField body='message' type='string'> @@ -59,7 +46,7 @@ Defined in: [src/utils/errors.ts:49](https://github.com/auth0/universal-login/bl <ParamField body='code' type='"SDK_USAGE_ERROR"'> {/*> `readonly` **code**: `"SDK_USAGE_ERROR"` = `'SDK_USAGE_ERROR'`*/} -Defined in: [src/utils/errors.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L47) +Defined in: [src/utils/errors.ts:47](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L47) #### Overrides @@ -70,7 +57,7 @@ Defined in: [src/utils/errors.ts:47](https://github.com/auth0/universal-login/bl <ParamField body='field?' type='string'> {/*> `readonly` `optional` **field**: `string`*/} -Defined in: [src/utils/errors.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L12) +Defined in: [src/utils/errors.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L12) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Signup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Signup.mdx index a1f241f1d..88a67094b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Signup.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Signup.mdx @@ -2,141 +2,19 @@ title: "Signup" --- -Defined in: [src/screens/signup/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L25) +Defined in: [src/screens/signup/index.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup/index.ts#L25) <RequestExample> ```ts -export default class Signup extends BaseContext implements SignupMembers { - static screenIdentifier: string = ScreenIds.SIGNUP; - screen: ScreenOptions; - transaction: TransactionOptions; - - constructor() { - super(); - const screenContext = this.getContext('screen') as ScreenContext; - const transactionContext = this.getContext('transaction') as TransactionContext; - - this.screen = new ScreenOverride(screenContext); - this.transaction = new TransactionOverride(transactionContext); - } - /** - * @remarks - * This method handles the submission of the signup form. - * - * @example - * ```typescript - * import Signup from '@auth0/auth0-acul-js/signup'; - * - * const signupManager = new Signup(); - * - * signupManager.signup({ - * email: 'test@example.com', - * password: 'P@$$wOrd123!', - * }); - * ``` - */ - async signup(payload: SignupOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [Signup.screenIdentifier, 'signup'], - }; - await new FormHandler(options).submitData<SignupOptions>(payload); - } - - /** - * Handles the submission of the social signup form. - * - * @remarks - * This method is similar to the {@link signup} method but is used for social signups. - * - * @param payload - The payload containing the social signup options. - * - * @example - * ```typescript - * import Signup from '@auth0/auth0-acul-js/signup'; - * - * const signupManager = new Signup(); - * - * signupManager.federatedSignup({ - * connection: 'google-oauth2' - * }); - * ``` - */ - - async federatedSignup(payload: FederatedSignupOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [Signup.screenIdentifier, 'federatedSignup'], - }; - await new FormHandler(options).submitData<FederatedSignupOptions>(payload); - } - - /** - * @example - * import Signup from "@auth0/auth0-acul-js/signup"; - * const signupManager = new Signup(); - * - * signupManager.pickCountryCode(); - */ - async pickCountryCode(): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [Signup.screenIdentifier, 'pickCountryCode'], - }; - - await new FormHandler(options).submitData({ - action: FormActions.PICK_COUNTRY_CODE, - }); - } - - /** - * @param password - * @returns An object of type {@link PasswordValidationResult} indicating whether the password is valid and why. - * @utilityFeature - */ - validatePassword(password: string): PasswordValidationResult { - const passwordPolicy = this.transaction?.passwordPolicy; - return _validatePassword(password, passwordPolicy); - } - - /** - * Returns the list of enabled identifiers for the signup form, - * marking each as required or optional based on transaction config. - * - * @returns Array of identifier objects (e.g., email, phone, username). - * @utilityFeature - * @example - * const signup = new Signup(); - * const identifiers = signup.getSignupIdentifiers(); - * // [{ type: 'email', required: true }, { type: 'username', required: false }] - */ - getSignupIdentifiers(): Identifier[] | null { - const transaction = { - ...this.transaction, - errors: this.transaction.errors ?? undefined, // convert `null` to `undefined` - }; - return _getSignupIdentifiers(transaction.requiredIdentifiers ?? [], transaction.optionalIdentifiers ?? [], transaction.connectionStrategy); - } - - /** - * Validates a given username against the current username policy - * defined in the transaction context. - * - * @param username - The username string to validate. - * @returns Result object indicating whether the username is valid and why. - * @utilityFeature - * - * @example - * const signup = new Signup(); - * const result = signup.validateUsername('myusername'); - * // result => { valid: true, errors: [] } - */ - validateUsername(username: string): UsernameValidationResult { - const usernameValidationConfig = this.transaction.usernamePolicy; - return _validateUsername(username, usernameValidationConfig); - } -} +import Signup from '@auth0/auth0-acul-js/signup'; + +const signupManager = new Signup(); + +signupManager.signup({ + email: 'test@example.com', + password: 'P@$wOrd123!', +}); ``` </RequestExample> @@ -153,7 +31,7 @@ export default class Signup extends BaseContext implements SignupMembers { <ParamField body="Signup" type="Constructor"> {/*> **new Signup**(): `Signup`*/} -Defined in: [src/screens/signup/index.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L30) +Defined in: [src/screens/signup/index.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup/index.ts#L30) #### Returns @@ -169,7 +47,7 @@ Defined in: [src/screens/signup/index.ts:30](https://github.com/auth0/universal- <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -184,7 +62,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -199,7 +77,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -214,7 +92,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -229,7 +107,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup">ScreenMembersOnSignup</a></span>}> {/*> **screen**: [`ScreenMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup)*/} -Defined in: [src/screens/signup/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L27) +Defined in: [src/screens/signup/index.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup/index.ts#L27) #### Implementation of @@ -244,7 +122,7 @@ Defined in: [src/screens/signup/index.ts:27](https://github.com/auth0/universal- <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -259,7 +137,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup">TransactionMembersOnSignup</a></span>}> {/*> **transaction**: [`TransactionMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup)*/} -Defined in: [src/screens/signup/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L28) +Defined in: [src/screens/signup/index.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup/index.ts#L28) #### Implementation of @@ -274,7 +152,7 @@ Defined in: [src/screens/signup/index.ts:28](https://github.com/auth0/universal- <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -289,7 +167,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -304,7 +182,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.SIGNUP`*/} -Defined in: [src/screens/signup/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L26) +Defined in: [src/screens/signup/index.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup/index.ts#L26) #### Overrides @@ -316,7 +194,7 @@ Defined in: [src/screens/signup/index.ts:26](https://github.com/auth0/universal- <ParamField body='federatedSignup' type='Promise<void>'> {/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/signup/index.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L82) +Defined in: [src/screens/signup/index.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup/index.ts#L82) Handles the submission of the social signup form. @@ -357,7 +235,7 @@ signupManager.federatedSignup({ <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -376,7 +254,7 @@ An array of error objects from the transaction context. <ParamField body='getSignupIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier">Identifier</a>[]</span>}> {/*> **getSignupIdentifiers**(): [`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier)[] \| `null`*/} -Defined in: [src/screens/signup/index.ts:129](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L129) +Defined in: [src/screens/signup/index.ts:129](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup/index.ts#L129) **`Utility Feature`** @@ -406,7 +284,7 @@ const identifiers = signup.getSignupIdentifiers(); <ParamField body='pickCountryCode' type='Promise<void>'> {/*> **pickCountryCode**(): `Promise`\<`void`\>*/} -Defined in: [src/screens/signup/index.ts:97](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L97) +Defined in: [src/screens/signup/index.ts:97](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup/index.ts#L97) #### Returns @@ -430,7 +308,7 @@ signupManager.pickCountryCode(); <ParamField body='signup' type='Promise<void>'> {/*> **signup**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/signup/index.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L54) +Defined in: [src/screens/signup/index.ts:54](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup/index.ts#L54) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions">SignupPayloadOptions</a></span>}> @@ -468,7 +346,7 @@ signupManager.signup({ <ParamField body='validatePassword' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> {/*> **validatePassword**(`password`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult)*/} -Defined in: [src/screens/signup/index.ts:113](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L113) +Defined in: [src/screens/signup/index.ts:113](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup/index.ts#L113) **`Utility Feature`** @@ -493,7 +371,7 @@ An object of type [PasswordValidationResult](/docs/customize/login-pages/advance <ParamField body='validateUsername' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}> {/*> **validateUsername**(`username`): [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult)*/} -Defined in: [src/screens/signup/index.ts:150](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup/index.ts#L150) +Defined in: [src/screens/signup/index.ts:150](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup/index.ts#L150) **`Utility Feature`** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupId.mdx index 7826709e5..f155cdebe 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupId.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupId.mdx @@ -2,155 +2,22 @@ title: "SignupId" --- -Defined in: [src/screens/signup-id/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L24) +Defined in: [src/screens/signup-id/index.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-id/index.ts#L24) <RequestExample> ```ts -export default class SignupId extends BaseContext implements SignupIdMembers { - static screenIdentifier: string = ScreenIds.SIGNUP_ID; - screen: ScreenOptions; - transaction: TransactionOptions; - - constructor() { - super(); - - const screenContext = this.getContext('screen') as ScreenContext; - const transactionContext = this.getContext('transaction') as TransactionContext; - - this.screen = new ScreenOverride(screenContext); - this.transaction = new TransactionOverride(transactionContext); - } - - /** - * @remarks - * This methods handles signup-id related configuration. - * It allows to signup new users via different identifiers. - * - * @example - * import SignupId from "@auth0/auth0-acul-js/signup-id"; - * - * const signupIdManager = new SignupId(); - * const { transaction } = signupIdManager; - * - * //get mandatory & optional identifiers required for signup - * const mandatoryIdentifier = transaction.getRequiredIdentifiers(); // eg: email - * const optionalIdentifiers = transaction.getOptionalIdentifiers() // eg: phone - * - * const signupParams = { - * email : "testEmail", - * phone : "+91923456789" - * }; - * - * signupIdManager.signup(signupParams); - */ - async signup(payload: SignupOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [SignupId.screenIdentifier, 'signup'], - }; - - const activeIdentifiers = this.transaction.requiredIdentifiers || []; - const missingParameters = activeIdentifiers.filter((param) => !Object.keys(payload).includes(param)); - if (missingParameters.length) { - throw new Error(`Missing parameter(s): ${missingParameters.join(', ')}`); - } - - if (payload.phone?.trim() ?? '') { - const { phone, ...rest } = payload; - payload = { ...rest, phone_number: phone }; - } - - const browserCapabilities = await getBrowserCapabilities() - await new FormHandler(options).submitData<SignupOptions>({ - ...payload, - ...browserCapabilities - }); - } - - /** - * @remarks - * This methods handles allows signup via different social identifiers. - * Eg: Google, Facebook etc. - * - * @example - * import SignupId from "@auth0/auth0-acul-js/signup-id"; - * - * const signupIdManager = new SignupId(); - * const { transaction } = signupIdManager; - * - * //get social connections - * const socialConnection = transaction.alternateConnections; //eg: "google-oauth2" - * - * const signupParams = { - * connection : socialConnection[0].name, // "google-oauth2" - * }; - * - * signupIdManager.federatedSignup(signupParams); - */ - async federatedSignup(payload: FederatedSignupOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [SignupId.screenIdentifier, 'federatedSignup'], - }; - await new FormHandler(options).submitData<FederatedSignupOptions>(payload); - } - - /** - * Returns the list of enabled identifiers for the signup-id form, - * marking each as required or optional based on transaction config. - * - * @returns Array of identifier objects (e.g., email, phone, username). - * @utilityFeature - * @example - * const signupId = new SignupId(); - * const identifiers = signupId.getSignupIdentifiers(); - * // [{ type: 'email', required: true }, { type: 'username', required: false }] - */ - getSignupIdentifiers(): Identifier[] | null { - const transaction = { - ...this.transaction, - errors: this.transaction.errors ?? undefined, // convert `null` to `undefined` - }; - return _getSignupIdentifiers(transaction.requiredIdentifiers ?? [], transaction.optionalIdentifiers ?? [], transaction.connectionStrategy); - } - - /** - * @example - * import SignupId from "@auth0/auth0-acul-js/signup-id"; - * const signupIdManager = new SignupId(); - * - * signupIdManager.pickCountryCode(); - */ - async pickCountryCode(): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [SignupId.screenIdentifier, 'pickCountryCode'], - }; - - await new FormHandler(options).submitData({ - action: FormActions.PICK_COUNTRY_CODE, - }); - } - - /** - * Validates a given username against the current username policy - * defined in the transaction context. - * - * @param username - The username string to validate. - * @returns Result object indicating whether the username is valid and why. - * @utilityFeature - * - * @example - * const signupIdManager = new SignupId(); - * const result = signupIdManager.validateUsername('myusername'); - * // result => { valid: true, errors: [] } - */ - validateUsername(username: string): UsernameValidationResult { - const usernameValidationConfig = this.transaction.usernamePolicy; - return _validateUsername(username, usernameValidationConfig); - } -} +import SignupId from "@auth0/auth0-acul-js/signup-id"; +const signupIdManager = new SignupId(); +const { transaction } = signupIdManager; +//get mandatory & optional identifiers required for signup +const mandatoryIdentifier = transaction.getRequiredIdentifiers(); // eg: email +const optionalIdentifiers = transaction.getOptionalIdentifiers() // eg: phone +const signupParams = { + email : "testEmail", + phone : "+91923456789" +}; +signupIdManager.signup(signupParams); ``` </RequestExample> @@ -167,7 +34,7 @@ export default class SignupId extends BaseContext implements SignupIdMembers { <ParamField body="SignupId" type="Constructor"> {/*> **new SignupId**(): `SignupId`*/} -Defined in: [src/screens/signup-id/index.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L29) +Defined in: [src/screens/signup-id/index.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-id/index.ts#L29) #### Returns @@ -183,7 +50,7 @@ Defined in: [src/screens/signup-id/index.ts:29](https://github.com/auth0/univers <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -198,7 +65,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -213,7 +80,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -228,7 +95,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -243,7 +110,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId">ScreenMembersOnSignupId</a></span>}> {/*> **screen**: [`ScreenMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId)*/} -Defined in: [src/screens/signup-id/index.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L26) +Defined in: [src/screens/signup-id/index.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-id/index.ts#L26) #### Implementation of @@ -258,7 +125,7 @@ Defined in: [src/screens/signup-id/index.ts:26](https://github.com/auth0/univers <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -273,7 +140,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a></span>}> {/*> **transaction**: [`TransactionMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId)*/} -Defined in: [src/screens/signup-id/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L27) +Defined in: [src/screens/signup-id/index.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-id/index.ts#L27) #### Implementation of @@ -288,7 +155,7 @@ Defined in: [src/screens/signup-id/index.ts:27](https://github.com/auth0/univers <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -303,7 +170,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -318,7 +185,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.SIGNUP_ID`*/} -Defined in: [src/screens/signup-id/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L25) +Defined in: [src/screens/signup-id/index.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-id/index.ts#L25) #### Overrides @@ -330,7 +197,7 @@ Defined in: [src/screens/signup-id/index.ts:25](https://github.com/auth0/univers <ParamField body='federatedSignup' type='Promise<void>'> {/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/signup-id/index.ts:105](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L105) +Defined in: [src/screens/signup-id/index.ts:105](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-id/index.ts#L105) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions">FederatedSignupOptions</a></span>}> @@ -374,7 +241,7 @@ signupIdManager.federatedSignup(signupParams); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -393,7 +260,7 @@ An array of error objects from the transaction context. <ParamField body='getSignupIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier">Identifier</a>[]</span>}> {/*> **getSignupIdentifiers**(): [`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier)[] \| `null`*/} -Defined in: [src/screens/signup-id/index.ts:124](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L124) +Defined in: [src/screens/signup-id/index.ts:124](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-id/index.ts#L124) **`Utility Feature`** @@ -423,7 +290,7 @@ const identifiers = signupId.getSignupIdentifiers(); <ParamField body='pickCountryCode' type='Promise<void>'> {/*> **pickCountryCode**(): `Promise`\<`void`\>*/} -Defined in: [src/screens/signup-id/index.ts:139](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L139) +Defined in: [src/screens/signup-id/index.ts:139](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-id/index.ts#L139) #### Returns @@ -447,7 +314,7 @@ signupIdManager.pickCountryCode(); <ParamField body='signup' type='Promise<void>'> {/*> **signup**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/signup-id/index.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L61) +Defined in: [src/screens/signup-id/index.ts:61](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-id/index.ts#L61) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions">SignupOptions</a></span>}> @@ -493,7 +360,7 @@ signupIdManager.signup(signupParams); <ParamField body='validateUsername' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}> {/*> **validateUsername**(`username`): [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult)*/} -Defined in: [src/screens/signup-id/index.ts:163](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-id/index.ts#L163) +Defined in: [src/screens/signup-id/index.ts:163](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-id/index.ts#L163) **`Utility Feature`** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupPassword.mdx index 957ec8db8..42b8024fe 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupPassword.mdx @@ -2,123 +2,20 @@ title: "SignupPassword" --- -Defined in: [src/screens/signup-password/index.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L22) +Defined in: [src/screens/signup-password/index.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-password/index.ts#L22) <RequestExample> ```ts -export default class SignupPassword extends BaseContext implements SignupPasswordMembers { - static screenIdentifier: string = ScreenIds.SIGNUP_PASSWORD; - screen: ScreenOptions; - transaction: TransactionOptions; - - constructor() { - super(); - - const screenContext = this.getContext('screen') as ScreenContextOnSignupPassword; - const transactionContext = this.getContext('transaction') as TransactionContext; - - this.screen = new ScreenOverride(screenContext); - this.transaction = new TransactionOverride(transactionContext); - } - - /** - * @remarks - * This methods handles signup-password related screen configuration. - * It allows to proceed with registering signup password along with signup identifiers passed in previous screen - * - * @example - * import SignupPassword from "@auth0/auth0-acul-js/signup-password"; - * - * const signupPasswordManager = new SignupPassword(); - * const { transaction, screen } = signupPasswordManager; - * - * //get mandatory & optional identifiers required for signup-password screen to proceed - * const mandatoryIdentifier = transaction.getRequiredIdentifiers(); //eg: email - * const optionalIdentifiers = transaction.getOptionalIdentifiers() //eg: phone - * - * //get signup data submitted on previous screen from previous screen - * const data = transaction.screen.getScreenData(); //eg: email, phone - * - * - * const signupParams = { - * email : data.email, - * password: "******" - * }; - * - * signupPasswordManager.signup(signupParams); - */ - async signup(payload: SignupPasswordOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [this.constructor.name, 'signup'], - }; - - await new FormHandler(options).submitData<SignupPasswordOptions>(payload); - } - - /** - * @remarks - * This methods handles allows signup via different social identifiers. - * Eg: Google, Facebook etc. - * - * @example - * import SignupPassword from "@auth0/auth0-acul-js/signup-id"; - * - * const signupIdManager = new SignupPassword(); - * const { transaction } = signupIdManager; - * - * //get social connections - * const socialConnection = transaction.alternateConnections; //eg: "google-oauth2" - * - * const signupParams = { - * connection : socialConnection[0].name, // "google-oauth2" - * }; - * - * signupIdManager.federatedSignup(signupParams); - */ - async federatedSignup(payload: FederatedSignupOptions): Promise<void> { - const options: FormOptions = { - state: this.transaction.state, - telemetry: [SignupPassword.screenIdentifier, 'federatedSignup'], - }; - - await new FormHandler(options).submitData<FederatedSignupOptions>(payload); - } - - /** - * Validates a password string against the current transaction's password policy. - * - * This method retrieves the password policy from the current transaction context - * and delegates the actual validation to `coreValidatePassword`. - * - * It returns an array of validation results, each containing: - * - `code`: the identifier of the password rule, - * - `policy`: a user-friendly description of the rule, - * - `isValid`: boolean indicating if the password passed that rule. - * - * @param {string} password - The password string to validate. - * @returns {PasswordValidationResult} - * @utilityFeature - * - * @example - * ```ts - * import SignupPassword from "@auth0/auth0-acul-js/signup-password"; - * const signupPasswordManager = new SignupPassword(); - * const validationResults = signupPasswordManager.validatePassword('MyP@ssw0rd!'); - * console.log(validationResults); - * // [ - * // { code: 'password-policy-length-at-least', policy: 'At least 12 characters', isValid: false }, - * // { code: 'password-policy-lower-case', policy: 'Lowercase letters (a-z)', isValid: true }, - * // ... - * // ] - * ``` - */ - validatePassword(password: string): PasswordValidationResult { - const passwordPolicy = this.transaction?.passwordPolicy; - return _validatePassword(password, passwordPolicy); - } -} +import SignupPassword from "@auth0/auth0-acul-js/signup-password"; +const signupPasswordManager = new SignupPassword(); +const validationResults = signupPasswordManager.validatePassword('MyP@ssw0rd!'); +console.log(validationResults); +// [ +// { code: 'password-policy-length-at-least', policy: 'At least 12 characters', isValid: false }, +// { code: 'password-policy-lower-case', policy: 'Lowercase letters (a-z)', isValid: true }, +// ... +// ] ``` </RequestExample> @@ -135,7 +32,7 @@ export default class SignupPassword extends BaseContext implements SignupPasswor <ParamField body="SignupPassword" type="Constructor"> {/*> **new SignupPassword**(): `SignupPassword`*/} -Defined in: [src/screens/signup-password/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L27) +Defined in: [src/screens/signup-password/index.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-password/index.ts#L27) #### Returns @@ -151,7 +48,7 @@ Defined in: [src/screens/signup-password/index.ts:27](https://github.com/auth0/u <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L23) +Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L23) #### Implementation of @@ -166,7 +63,7 @@ Defined in: [src/models/base-context.ts:23](https://github.com/auth0/universal-l <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L28) +Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L28) #### Implementation of @@ -181,7 +78,7 @@ Defined in: [src/models/base-context.ts:28](https://github.com/auth0/universal-l <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L27) +Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L27) #### Implementation of @@ -196,7 +93,7 @@ Defined in: [src/models/base-context.ts:27](https://github.com/auth0/universal-l <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L26) +Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L26) #### Implementation of @@ -211,7 +108,7 @@ Defined in: [src/models/base-context.ts:26](https://github.com/auth0/universal-l <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword">ScreenMembersOnSignupPassword</a></span>}> {/*> **screen**: [`ScreenMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword)*/} -Defined in: [src/screens/signup-password/index.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L24) +Defined in: [src/screens/signup-password/index.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-password/index.ts#L24) #### Implementation of @@ -226,7 +123,7 @@ Defined in: [src/screens/signup-password/index.ts:24](https://github.com/auth0/u <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L25) +Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L25) #### Implementation of @@ -241,7 +138,7 @@ Defined in: [src/models/base-context.ts:25](https://github.com/auth0/universal-l <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword">TransactionMembersOnSignupPassword</a></span>}> {/*> **transaction**: [`TransactionMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword)*/} -Defined in: [src/screens/signup-password/index.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L25) +Defined in: [src/screens/signup-password/index.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-password/index.ts#L25) #### Implementation of @@ -256,7 +153,7 @@ Defined in: [src/screens/signup-password/index.ts:25](https://github.com/auth0/u <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L31) +Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L31) #### Implementation of @@ -271,7 +168,7 @@ Defined in: [src/models/base-context.ts:31](https://github.com/auth0/universal-l <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L30) +Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L30) #### Implementation of @@ -286,7 +183,7 @@ Defined in: [src/models/base-context.ts:30](https://github.com/auth0/universal-l <ParamField body='screenIdentifier' type='string'> {/*> `static` **screenIdentifier**: `string` = `ScreenIds.SIGNUP_PASSWORD`*/} -Defined in: [src/screens/signup-password/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L23) +Defined in: [src/screens/signup-password/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-password/index.ts#L23) #### Overrides @@ -298,7 +195,7 @@ Defined in: [src/screens/signup-password/index.ts:23](https://github.com/auth0/u <ParamField body='federatedSignup' type='Promise<void>'> {/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/signup-password/index.ts:92](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L92) +Defined in: [src/screens/signup-password/index.ts:92](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-password/index.ts#L92) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions">FederatedSignupPasswordPayloadOptions</a></span>}> @@ -342,7 +239,7 @@ signupIdManager.federatedSignup(signupParams); <ParamField body='getErrors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}> {/*> **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[]*/} -Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/models/base-context.ts#L99) +Defined in: [src/models/base-context.ts:99](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/models/base-context.ts#L99) Retrieves the array of transaction errors from the context, or an empty array if none exist. @@ -361,7 +258,7 @@ An array of error objects from the transaction context. <ParamField body='signup' type='Promise<void>'> {/*> **signup**(`payload`): `Promise`\<`void`\>*/} -Defined in: [src/screens/signup-password/index.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L63) +Defined in: [src/screens/signup-password/index.ts:63](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-password/index.ts#L63) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions">SignupPasswordOptions</a></span>}> @@ -410,7 +307,7 @@ signupPasswordManager.signup(signupParams); <ParamField body='validatePassword' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> {/*> **validatePassword**(`password`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult)*/} -Defined in: [src/screens/signup-password/index.ts:129](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/screens/signup-password/index.ts#L129) +Defined in: [src/screens/signup-password/index.ts:129](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup-password/index.ts#L129) **`Utility Feature`** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError.mdx index 5471a7745..3b3c36f84 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError.mdx @@ -2,24 +2,11 @@ title: "UserInputError" --- -Defined in: [src/utils/errors.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L30) +Defined in: [src/utils/errors.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L30) UserInputError -<RequestExample> -```ts -export class UserInputError extends AculError { - public readonly code = 'USER_INPUT_ERROR'; - - constructor(message: string, field?: string) { - super(message, field); - Object.setPrototypeOf(this, new.target.prototype); - } -} -``` -</RequestExample> - ## Param The error message. @@ -37,7 +24,7 @@ The optional field associated with the error. <ParamField body="UserInputError" type="Constructor"> {/*> **new UserInputError**(`message`, `field?`): `UserInputError`*/} -Defined in: [src/utils/errors.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L33) +Defined in: [src/utils/errors.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L33) <Expandable title="Parameters"> <ParamField body='message' type='string'> @@ -59,7 +46,7 @@ Defined in: [src/utils/errors.ts:33](https://github.com/auth0/universal-login/bl <ParamField body='code' type='"USER_INPUT_ERROR"'> {/*> `readonly` **code**: `"USER_INPUT_ERROR"` = `'USER_INPUT_ERROR'`*/} -Defined in: [src/utils/errors.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L31) +Defined in: [src/utils/errors.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L31) #### Overrides @@ -70,7 +57,7 @@ Defined in: [src/utils/errors.ts:31](https://github.com/auth0/universal-login/bl <ParamField body='field?' type='string'> {/*> `readonly` `optional` **field**: `string`*/} -Defined in: [src/utils/errors.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/utils/errors.ts#L12) +Defined in: [src/utils/errors.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L12) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreen.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreen.mdx index fcc1b7ffd..5e1e46479 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreen.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreen.mdx @@ -4,7 +4,7 @@ title: "getCurrentScreen" > **getCurrentScreen**(): `string` \| `null` -Defined in: [src/common/index.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/common/index.ts#L14) +Defined in: [src/common/index.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/common/index.ts#L14) **`Common Feature`** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreenOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreenOptions.mdx index c5ea4a468..4d05e6ad3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreenOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentScreenOptions.mdx @@ -4,7 +4,7 @@ title: "getCurrentScreenOptions" > **getCurrentScreenOptions**(): [`CurrentScreenOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CurrentScreenOptions) -Defined in: [src/common/index.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/common/index.ts#L23) +Defined in: [src/common/index.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/common/index.ts#L23) **`Common Feature`** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentThemeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentThemeOptions.mdx index ee93d51f0..629037e43 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentThemeOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getCurrentThemeOptions.mdx @@ -4,7 +4,7 @@ title: "getCurrentThemeOptions" > **getCurrentThemeOptions**(): [`FlattenedTheme`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FlattenedTheme) \| `null` -Defined in: [src/common/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/common/index.ts#L58) +Defined in: [src/common/index.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/common/index.ts#L58) **`Common Feature`** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getErrors.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getErrors.mdx index 2314f376d..4f65336e0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getErrors.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/functions/getErrors.mdx @@ -4,7 +4,7 @@ title: "getErrors" > **getErrors**(): [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null` -Defined in: [src/common/index.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/common/index.ts#L87) +Defined in: [src/common/index.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/common/index.ts#L87) **`Common Feature`** diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions.mdx index 223f15729..8f70ef87d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions.mdx @@ -2,7 +2,7 @@ title: "AbortEnrollmentOptions" --- -Defined in: [interfaces/screens/passkey-enrollment-local.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L19) +Defined in: [interfaces/screens/passkey-enrollment-local.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L19) <RequestExample> @@ -23,5 +23,5 @@ export interface AbortEnrollmentOptions { <ParamField body='doNotShowAgain?' type='boolean'> {/*> `optional` **doNotShowAgain**: `boolean`*/} -Defined in: [interfaces/screens/passkey-enrollment-local.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L20) +Defined in: [interfaces/screens/passkey-enrollment-local.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L20) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.mdx index 3fce73f94..c5559e433 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.mdx @@ -2,7 +2,7 @@ title: "AcceptInvitationMembers" --- -Defined in: [interfaces/screens/accept-invitation.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L16) +Defined in: [interfaces/screens/accept-invitation.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L16) <RequestExample> @@ -31,7 +31,7 @@ export interface AcceptInvitationMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -42,7 +42,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/screens/accept-invitation.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L17) +Defined in: [interfaces/screens/accept-invitation.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L17) #### Overrides @@ -53,7 +53,7 @@ Defined in: [interfaces/screens/accept-invitation.ts:17](https://github.com/auth <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/screens/accept-invitation.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L18) +Defined in: [interfaces/screens/accept-invitation.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L18) #### Overrides @@ -64,7 +64,7 @@ Defined in: [interfaces/screens/accept-invitation.ts:18](https://github.com/auth <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/screens/accept-invitation.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L19) +Defined in: [interfaces/screens/accept-invitation.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L19) #### Overrides @@ -75,7 +75,7 @@ Defined in: [interfaces/screens/accept-invitation.ts:19](https://github.com/auth <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation">ScreenMembersOnAcceptInvitation</a></span>}> {/*> **screen**: [`ScreenMembersOnAcceptInvitation`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation)*/} -Defined in: [interfaces/screens/accept-invitation.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L20) +Defined in: [interfaces/screens/accept-invitation.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L20) #### Overrides @@ -86,7 +86,7 @@ Defined in: [interfaces/screens/accept-invitation.ts:20](https://github.com/auth <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -97,7 +97,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/screens/accept-invitation.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L21) +Defined in: [interfaces/screens/accept-invitation.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L21) #### Overrides @@ -108,7 +108,7 @@ Defined in: [interfaces/screens/accept-invitation.ts:21](https://github.com/auth <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -119,7 +119,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -131,7 +131,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='acceptInvitation' type='Promise<void>'> {/*> **acceptInvitation**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/accept-invitation.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L26) +Defined in: [interfaces/screens/accept-invitation.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L26) Accepts the invitation to the organization. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential.mdx index 79b586521..11109f538 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential.mdx @@ -2,7 +2,7 @@ title: "AllowCredential" --- -Defined in: [interfaces/models/screen.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L10) +Defined in: [interfaces/models/screen.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L10) <RequestExample> @@ -20,19 +20,19 @@ export interface AllowCredential { <ParamField body='id' type='string'> {/*> **id**: `string`*/} -Defined in: [interfaces/models/screen.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L12) +Defined in: [interfaces/models/screen.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L12) </ParamField> <ParamField body='transports?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/AuthenticatorTransport">AuthenticatorTransport</a></span>}> {/*> `optional` **transports**: [`AuthenticatorTransport`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/AuthenticatorTransport)[]*/} -Defined in: [interfaces/models/screen.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L13) +Defined in: [interfaces/models/screen.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L13) </ParamField> <ParamField body='type' type='"public-key"'> {/*> **type**: `"public-key"`*/} -Defined in: [interfaces/models/screen.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L11) +Defined in: [interfaces/models/screen.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L11) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail.mdx index e52215d89..2621ce640 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail.mdx @@ -2,7 +2,7 @@ title: "AuthorizationDetail" --- -Defined in: [interfaces/models/screen.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L63) +Defined in: [interfaces/models/screen.ts:63](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L63) <RequestExample> @@ -23,5 +23,5 @@ export interface AuthorizationDetail { <ParamField body='type' type='string'> {/*> **type**: `string`*/} -Defined in: [interfaces/models/screen.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L64) +Defined in: [interfaces/models/screen.ts:64](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L64) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.mdx index 3cd774cef..a3fe3790e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers.mdx @@ -2,7 +2,7 @@ title: "BaseMembers" --- -Defined in: [interfaces/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L23) +Defined in: [interfaces/models/base-context.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L23) <RequestExample> @@ -105,61 +105,61 @@ export interface BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) </ParamField> <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) </ParamField> <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) </ParamField> <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) </ParamField> <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) </ParamField> <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) </ParamField> <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) </ParamField> <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) </ParamField> <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding.mdx index e150c2531..0133b1316 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding.mdx @@ -2,7 +2,7 @@ title: "Branding" --- -Defined in: [interfaces/models/organization.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L18) +Defined in: [interfaces/models/organization.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L18) <RequestExample> @@ -22,7 +22,7 @@ export interface Branding { <ParamField body='colors?' type='object'> {/*> `optional` **colors**: `object`*/} -Defined in: [interfaces/models/organization.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L20) +Defined in: [interfaces/models/organization.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L20) #### pageBackground? @@ -37,5 +37,5 @@ Defined in: [interfaces/models/organization.ts:20](https://github.com/auth0/univ <ParamField body='logoUrl?' type='string'> {/*> `optional` **logoUrl**: `string`*/} -Defined in: [interfaces/models/organization.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L19) +Defined in: [interfaces/models/organization.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L19) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers.mdx index fd7c63787..8a5c8c788 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers.mdx @@ -2,7 +2,7 @@ title: "BrandingMembers" --- -Defined in: [interfaces/models/branding.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L61) +Defined in: [interfaces/models/branding.ts:61](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L61) <RequestExample> @@ -19,12 +19,12 @@ export interface BrandingMembers { <ParamField body='settings' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings">BrandingSettings</a></span>}> {/*> **settings**: [`BrandingSettings`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings) \| `null`*/} -Defined in: [interfaces/models/branding.ts:62](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L62) +Defined in: [interfaces/models/branding.ts:62](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L62) </ParamField> <ParamField body='themes' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes">BrandingThemes</a></span>}> {/*> **themes**: [`BrandingThemes`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes) \| `null`*/} -Defined in: [interfaces/models/branding.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L63) +Defined in: [interfaces/models/branding.ts:63](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L63) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings.mdx index 062a8c596..c37a419fb 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings.mdx @@ -2,7 +2,7 @@ title: "BrandingSettings" --- -Defined in: [interfaces/models/branding.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L32) +Defined in: [interfaces/models/branding.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L32) <RequestExample> @@ -31,7 +31,7 @@ export interface BrandingSettings { <ParamField body='colors?' type='object'> {/*> `optional` **colors**: `object`*/} -Defined in: [interfaces/models/branding.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L33) +Defined in: [interfaces/models/branding.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L33) #### pageBackground? @@ -46,19 +46,19 @@ Defined in: [interfaces/models/branding.ts:33](https://github.com/auth0/universa <ParamField body='faviconUrl?' type='string'> {/*> `optional` **faviconUrl**: `string`*/} -Defined in: [interfaces/models/branding.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L44) +Defined in: [interfaces/models/branding.ts:44](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L44) </ParamField> <ParamField body='fontUrl?' type='string'> {/*> `optional` **fontUrl**: `string`*/} -Defined in: [interfaces/models/branding.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L46) +Defined in: [interfaces/models/branding.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L46) </ParamField> <ParamField body='logoUrl?' type='string'> {/*> `optional` **logoUrl**: `string`*/} -Defined in: [interfaces/models/branding.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L45) +Defined in: [interfaces/models/branding.ts:45](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L45) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes.mdx index 24715d83c..f2c51765e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes.mdx @@ -2,7 +2,7 @@ title: "BrandingThemes" --- -Defined in: [interfaces/models/branding.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L49) +Defined in: [interfaces/models/branding.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L49) <RequestExample> @@ -25,7 +25,7 @@ export interface BrandingThemes { <ParamField body='default' type='object'> {/*> **default**: `object`*/} -Defined in: [interfaces/models/branding.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/branding.ts#L50) +Defined in: [interfaces/models/branding.ts:50](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L50) #### borders diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext.mdx index 533094404..33cacb3f2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext.mdx @@ -2,7 +2,7 @@ title: "CaptchaContext" --- -Defined in: [interfaces/models/screen.ts:1](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L1) +Defined in: [interfaces/models/screen.ts:1](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L1) <RequestExample> @@ -20,19 +20,19 @@ export interface CaptchaContext { <ParamField body='image?' type='string'> {/*> `optional` **image**: `string`*/} -Defined in: [interfaces/models/screen.ts:3](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L3) +Defined in: [interfaces/models/screen.ts:3](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L3) </ParamField> <ParamField body='provider' type='string'> {/*> **provider**: `string`*/} -Defined in: [interfaces/models/screen.ts:2](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L2) +Defined in: [interfaces/models/screen.ts:2](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L2) </ParamField> <ParamField body='siteKey?' type='string'> {/*> `optional` **siteKey**: `string`*/} -Defined in: [interfaces/models/screen.ts:4](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L4) +Defined in: [interfaces/models/screen.ts:4](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L4) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers.mdx index 2edaeb9ca..5688ea389 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers.mdx @@ -2,7 +2,7 @@ title: "ClientMembers" --- -Defined in: [interfaces/models/client.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/client.ts#L12) +Defined in: [interfaces/models/client.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/client.ts#L12) <RequestExample> @@ -22,33 +22,33 @@ export interface ClientMembers { <ParamField body='description' type='string'> {/*> **description**: `string` \| `null`*/} -Defined in: [interfaces/models/client.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/client.ts#L16) +Defined in: [interfaces/models/client.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/client.ts#L16) </ParamField> <ParamField body='id' type='string'> {/*> **id**: `string`*/} -Defined in: [interfaces/models/client.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/client.ts#L13) +Defined in: [interfaces/models/client.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/client.ts#L13) </ParamField> <ParamField body='logoUrl' type='string'> {/*> **logoUrl**: `string` \| `null`*/} -Defined in: [interfaces/models/client.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/client.ts#L15) +Defined in: [interfaces/models/client.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/client.ts#L15) </ParamField> <ParamField body='metadata' type='key'> {/*> **metadata**: \{\[`key`: `string`\]: `string`; \} \| `null`*/} -Defined in: [interfaces/models/client.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/client.ts#L17) +Defined in: [interfaces/models/client.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/client.ts#L17) </ParamField> <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/client.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/client.ts#L14) +Defined in: [interfaces/models/client.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/client.ts#L14) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions.mdx index 42ef54cc3..db6c78a21 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions.mdx @@ -2,7 +2,7 @@ title: "ConfirmLogoutOptions" --- -Defined in: [interfaces/screens/logout.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/logout.ts#L7) +Defined in: [interfaces/screens/logout.ts:7](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/logout.ts#L7) Options for confirming logout @@ -29,7 +29,7 @@ export interface ConfirmLogoutOptions extends CustomOptions { <ParamField body='action' type='"accept"'> {/*> **action**: `"accept"` \| `"deny"`*/} -Defined in: [interfaces/screens/logout.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/logout.ts#L9) +Defined in: [interfaces/screens/logout.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/logout.ts#L9) The authentication transaction state </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection.mdx index 0cf204d1a..3d8f65e7d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection.mdx @@ -2,7 +2,7 @@ title: "Connection" --- -Defined in: [interfaces/models/transaction.ts:1](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L1) +Defined in: [interfaces/models/transaction.ts:1](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L1) <RequestExample> @@ -24,19 +24,19 @@ export interface Connection { <ParamField body='metadata?' type='Record'> {/*> `optional` **metadata**: `Record`\<`string`, `string`\>*/} -Defined in: [interfaces/models/transaction.ts:4](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L4) +Defined in: [interfaces/models/transaction.ts:4](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L4) </ParamField> <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/transaction.ts:2](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L2) +Defined in: [interfaces/models/transaction.ts:2](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L2) </ParamField> <ParamField body='strategy' type='string'> {/*> **strategy**: `string`*/} -Defined in: [interfaces/models/transaction.ts:3](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L3) +Defined in: [interfaces/models/transaction.ts:3](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L3) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.mdx index b3b64b61a..5a45b312a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.mdx @@ -2,7 +2,7 @@ title: "ConsentMembers" --- -Defined in: [interfaces/screens/consent.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/consent.ts#L40) +Defined in: [interfaces/screens/consent.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/consent.ts#L40) ConsentMembers @@ -85,7 +85,7 @@ export interface ConsentMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -96,7 +96,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -107,7 +107,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -118,7 +118,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -129,7 +129,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent">ScreenMembersOnConsent</a></span>}> {/*> **screen**: [`ScreenMembersOnConsent`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent)*/} -Defined in: [interfaces/screens/consent.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/consent.ts#L46) +Defined in: [interfaces/screens/consent.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/consent.ts#L46) Provides access to the specific properties and data of the Consent screen, including the list of `scopes` being requested and the `hideScopes` flag. @@ -143,7 +143,7 @@ including the list of `scopes` being requested and the `hideScopes` flag. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -154,7 +154,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -165,7 +165,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -176,7 +176,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -188,7 +188,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='accept' type='Promise<void>'> {/*> **accept**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/consent.ts:75](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/consent.ts#L75) +Defined in: [interfaces/screens/consent.ts:75](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/consent.ts#L75) Submits the user's decision to accept (grant) the requested permissions. This action posts to the `/u/consent` endpoint with `action: "accept"`. @@ -236,7 +236,7 @@ try { <ParamField body='deny' type='Promise<void>'> {/*> **deny**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/consent.ts:102](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/consent.ts#L102) +Defined in: [interfaces/screens/consent.ts:102](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/consent.ts#L102) Submits the user's decision to deny (reject) the requested permissions. This action posts to the `/u/consent` endpoint with `action: "deny"`. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions.mdx index bfc122fdc..50bffe4b9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions.mdx @@ -2,7 +2,7 @@ title: "ContinueOTPOptions" --- -Defined in: [interfaces/screens/mfa-otp-challenge.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L26) +Defined in: [interfaces/screens/mfa-otp-challenge.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L26) Options for continuing with the OTP challenge @@ -31,7 +31,7 @@ Any additional custom options <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/mfa-otp-challenge.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L28) +Defined in: [interfaces/screens/mfa-otp-challenge.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L28) The code entered by the user @@ -40,7 +40,7 @@ The code entered by the user <ParamField body='rememberDevice?' type='boolean'> {/*> `optional` **rememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/mfa-otp-challenge.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L30) +Defined in: [interfaces/screens/mfa-otp-challenge.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L30) Indicates whether to remember the browser </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions.mdx index 3d374dc62..70a232388 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions.mdx @@ -2,7 +2,7 @@ title: "ContinueOptions" --- -Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L17) +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L17) Options for continuing with the email challenge. @@ -31,7 +31,7 @@ Any additional custom options <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L19) +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L19) The code entered by the user. @@ -40,7 +40,7 @@ The code entered by the user. <ParamField body='rememberDevice?' type='boolean'> {/*> `optional` **rememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L21) +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L21) Indicates whether to remember the device. </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions.mdx index cf75e8ac4..40beae6cd 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions.mdx @@ -2,7 +2,7 @@ title: "ContinuePayloadOptions" --- -Defined in: [interfaces/screens/mfa-email-challenge.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L29) +Defined in: [interfaces/screens/mfa-email-challenge.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L29) Options for continuing with the email challenge @@ -31,7 +31,7 @@ Any additional custom options <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/mfa-email-challenge.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L31) +Defined in: [interfaces/screens/mfa-email-challenge.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L31) The code entered by the user @@ -40,7 +40,7 @@ The code entered by the user <ParamField body='rememberDevice?' type='boolean'> {/*> `optional` **rememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/mfa-email-challenge.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L33) +Defined in: [interfaces/screens/mfa-email-challenge.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L33) Indicates whether to remember the device </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload.mdx index 5103964d5..cff4fd8f5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload.mdx @@ -2,7 +2,7 @@ title: "ContinueWithCodeOptionPayload" --- -Defined in: [interfaces/screens/login-email-verification.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L12) +Defined in: [interfaces/screens/login-email-verification.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L12) ContinueWithCodeOptions description Options for the `continueWithCode` method on the Login Email Verification screen. @@ -38,7 +38,7 @@ export interface ContinueWithCodeOptions extends CustomOptions { <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/login-email-verification.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L20) +Defined in: [interfaces/screens/login-email-verification.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L20) The verification code sent to the user's email. This is typically a short numeric or alphanumeric string that the user must enter into the form. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions.mdx index 9bccd78e6..85e81dab1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions.mdx @@ -2,7 +2,7 @@ title: "ContinueWithOrganizationNameOptions" --- -Defined in: [interfaces/screens/organization-selection.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L12) +Defined in: [interfaces/screens/organization-selection.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L12) Options for continuing with the selected organization name. @@ -33,7 +33,7 @@ Any additional custom options. <ParamField body='organizationName' type='string'> {/*> **organizationName**: `string`*/} -Defined in: [interfaces/screens/organization-selection.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L16) +Defined in: [interfaces/screens/organization-selection.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L16) The organization name. </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse.mdx index 7506ea479..66537c375 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse.mdx @@ -2,7 +2,7 @@ title: "CredentialResponse" --- -Defined in: [interfaces/utils/passkeys.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L15) +Defined in: [interfaces/utils/passkeys.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L15) <RequestExample> @@ -20,19 +20,19 @@ export interface CredentialResponse { <ParamField body='attestationObject' type='string'> {/*> **attestationObject**: `string` \| `null`*/} -Defined in: [interfaces/utils/passkeys.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L17) +Defined in: [interfaces/utils/passkeys.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L17) </ParamField> <ParamField body='clientDataJSON' type='string'> {/*> **clientDataJSON**: `string` \| `null`*/} -Defined in: [interfaces/utils/passkeys.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L16) +Defined in: [interfaces/utils/passkeys.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L16) </ParamField> <ParamField body='transports?' type='string'> {/*> `optional` **transports**: `string`[]*/} -Defined in: [interfaces/utils/passkeys.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L18) +Defined in: [interfaces/utils/passkeys.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L18) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CurrentScreenOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CurrentScreenOptions.mdx index 90b8020ed..f448648d7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CurrentScreenOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CurrentScreenOptions.mdx @@ -2,7 +2,7 @@ title: "CurrentScreenOptions" --- -Defined in: [interfaces/common/index.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L27) +Defined in: [interfaces/common/index.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L27) CurrentScreenOptions details. @@ -44,47 +44,47 @@ export interface CurrentScreenOptions { <ParamField body='client' type='id'> {/*> **client**: \{ `id`: `string`; `metadata`: `Record`\<`string`, `string`\> \| `null`; \} \| `null`*/} -Defined in: [interfaces/common/index.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L28) +Defined in: [interfaces/common/index.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L28) </ParamField> <ParamField body='organization' type='id'> {/*> **organization**: \{ `id`: `string`; `metadata`: `Record`\<`string`, `string`\> \| `null`; \} \| `null`*/} -Defined in: [interfaces/common/index.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L32) +Defined in: [interfaces/common/index.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L32) </ParamField> <ParamField body='prompt' type='name'> {/*> **prompt**: \{ `name`: `string`; \} \| `null`*/} -Defined in: [interfaces/common/index.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L36) +Defined in: [interfaces/common/index.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L36) </ParamField> <ParamField body='screen' type='name'> {/*> **screen**: \{ `name`: `string`; \} \| `null`*/} -Defined in: [interfaces/common/index.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L39) +Defined in: [interfaces/common/index.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L39) </ParamField> <ParamField body='tenant' type='enabledLocales'> {/*> **tenant**: \{ `enabledLocales`: `string`[]; \} \| `null`*/} -Defined in: [interfaces/common/index.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L42) +Defined in: [interfaces/common/index.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L42) </ParamField> <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> {/*> **transaction**: \{ `errors`: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`; `locale`: `string`; `state`: `string`; \} \| `null`*/} -Defined in: [interfaces/common/index.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L45) +Defined in: [interfaces/common/index.ts:45](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L45) </ParamField> <ParamField body='untrustedData' type='authorizationParams'> {/*> **untrustedData**: \{ `authorizationParams`: `Record`\<`string`, `string`\> \| `null`; \} \| `null`*/} -Defined in: [interfaces/common/index.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L50) +Defined in: [interfaces/common/index.ts:50](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L50) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions.mdx index 970ee847a..91516a172 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions.mdx @@ -2,7 +2,7 @@ title: "CustomOptions" --- -Defined in: [interfaces/common/index.ts:2](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L2) +Defined in: [interfaces/common/index.ts:2](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L2) <RequestExample> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.mdx index 91d76e8f1..ff65305c3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.mdx @@ -2,7 +2,7 @@ title: "CustomizedConsentMembers" --- -Defined in: [interfaces/screens/customized-consent.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L52) +Defined in: [interfaces/screens/customized-consent.ts:52](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L52) CustomizedConsentMembers @@ -87,7 +87,7 @@ export interface CustomizedConsentMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -98,7 +98,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -109,7 +109,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -120,7 +120,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -131,7 +131,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent">ScreenMembersOnCustomizedConsent</a></span>}> {/*> **screen**: [`ScreenMembersOnCustomizedConsent`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent)*/} -Defined in: [interfaces/screens/customized-consent.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L58) +Defined in: [interfaces/screens/customized-consent.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L58) Provides access to the specific properties and data of the Customized Consent screen, including the list of `scopes` and `authorizationDetails` being requested. @@ -145,7 +145,7 @@ including the list of `scopes` and `authorizationDetails` being requested. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -156,7 +156,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -167,7 +167,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -178,7 +178,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -190,7 +190,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='accept' type='Promise<void>'> {/*> **accept**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/customized-consent.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L88) +Defined in: [interfaces/screens/customized-consent.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L88) Submits the user's decision to accept (grant) the requested permissions and authorization details. This action posts to the `/u/customized-consent` endpoint with `action: "accept"`. @@ -239,7 +239,7 @@ try { <ParamField body='deny' type='Promise<void>'> {/*> **deny**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/customized-consent.ts:116](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L116) +Defined in: [interfaces/screens/customized-consent.ts:116](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L116) Submits the user's decision to deny (reject) the requested permissions and authorization details. This action posts to the `/u/customized-consent` endpoint with `action: "deny"`. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.mdx index c332ce2ba..01249f38c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.mdx @@ -2,7 +2,7 @@ title: "DeviceCodeActivationAllowedMembers" --- -Defined in: [interfaces/screens/device-code-activation-allowed.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-activation-allowed.ts#L6) +Defined in: [interfaces/screens/device-code-activation-allowed.ts:6](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/device-code-activation-allowed.ts#L6) Interface describing the members of the Device Code Activation Allowed screen. @@ -22,7 +22,7 @@ export interface DeviceCodeActivationAllowedMembers extends BaseMembers {} <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -33,7 +33,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions.mdx index 3e63c2b15..b05830f40 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions.mdx @@ -2,7 +2,7 @@ title: "DeviceCodeActivationContinueOptions" --- -Defined in: [interfaces/screens/device-code-activation.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-activation.ts#L11) +Defined in: [interfaces/screens/device-code-activation.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/device-code-activation.ts#L11) payload for continuing device code activation. @@ -32,5 +32,5 @@ export interface ContinueOptions extends CustomOptions { <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/device-code-activation.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-activation.ts#L12) +Defined in: [interfaces/screens/device-code-activation.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/device-code-activation.ts#L12) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.mdx index b3b35b6ee..9b26089a4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.mdx @@ -2,7 +2,7 @@ title: "DeviceCodeActivationDeniedMembers" --- -Defined in: [interfaces/screens/device-code-activation-denied.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-activation-denied.ts#L6) +Defined in: [interfaces/screens/device-code-activation-denied.ts:6](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/device-code-activation-denied.ts#L6) Interface describing the members of the Device Code Activation Denied screen. @@ -22,7 +22,7 @@ export interface DeviceCodeActivationDeniedMembers extends BaseMembers {} <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -33,7 +33,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.mdx index d4fd38809..ab83c787a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.mdx @@ -2,7 +2,7 @@ title: "DeviceCodeActivationMembers" --- -Defined in: [interfaces/screens/device-code-activation.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-activation.ts#L18) +Defined in: [interfaces/screens/device-code-activation.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/device-code-activation.ts#L18) Interface describing the members of the Device Code Activation screen. @@ -34,7 +34,7 @@ export interface DeviceCodeActivationMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -45,7 +45,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -56,7 +56,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -67,7 +67,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) #### Inherited from @@ -89,7 +89,7 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -100,7 +100,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -111,7 +111,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -122,7 +122,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -134,7 +134,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/device-code-activation.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-activation.ts#L29) +Defined in: [interfaces/screens/device-code-activation.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/device-code-activation.ts#L29) Submits the device code entered by the user. This action is triggered when the user enters the code displayed on their device and submits the form. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.mdx index e033bc46b..caf97c904 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.mdx @@ -2,7 +2,7 @@ title: "DeviceCodeConfirmationMembers" --- -Defined in: [interfaces/screens/device-code-confirmation.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L17) +Defined in: [interfaces/screens/device-code-confirmation.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L17) Interface describing the members of the Device Code Confirmation screen. @@ -36,7 +36,7 @@ export interface DeviceCodeConfirmationMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -47,7 +47,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -58,7 +58,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -69,7 +69,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -80,7 +80,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation">ScreenMembersOnDeviceCodeConfirmation</a></span>}> {/*> **screen**: [`ScreenMembersOnDeviceCodeConfirmation`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation)*/} -Defined in: [interfaces/screens/device-code-confirmation.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L18) +Defined in: [interfaces/screens/device-code-confirmation.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L18) #### Overrides @@ -91,7 +91,7 @@ Defined in: [interfaces/screens/device-code-confirmation.ts:18](https://github.c <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -102,7 +102,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -113,7 +113,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -124,7 +124,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -136,7 +136,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='cancel' type='Promise<void>'> {/*> **cancel**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/device-code-confirmation.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L30) +Defined in: [interfaces/screens/device-code-confirmation.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L30) Cancels the device code flow. @@ -157,7 +157,7 @@ Optional custom options to include with the request. <ParamField body='confirm' type='Promise<void>'> {/*> **confirm**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/device-code-confirmation.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L24) +Defined in: [interfaces/screens/device-code-confirmation.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L24) Confirms the device code. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions.mdx index af14baff7..2f5d74bbb 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions.mdx @@ -2,7 +2,7 @@ title: "EmailChallengeOptions" --- -Defined in: [interfaces/screens/email-identifier-challenge.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L6) +Defined in: [interfaces/screens/email-identifier-challenge.ts:6](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L6) <RequestExample> @@ -24,12 +24,12 @@ export interface EmailChallengeOptions { <ParamField body='captcha?' type='string'> {/*> `optional` **captcha**: `string`*/} -Defined in: [interfaces/screens/email-identifier-challenge.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L8) +Defined in: [interfaces/screens/email-identifier-challenge.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L8) </ParamField> <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/email-identifier-challenge.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L7) +Defined in: [interfaces/screens/email-identifier-challenge.ts:7](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L7) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.mdx index 598049fdc..69c43a68e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "EmailIdentifierChallengeMembers" --- -Defined in: [interfaces/screens/email-identifier-challenge.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L20) +Defined in: [interfaces/screens/email-identifier-challenge.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L20) <RequestExample> @@ -26,7 +26,7 @@ export interface EmailIdentifierChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge">ScreenMembersOnEmailIdentifierChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnEmailIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge)*/} -Defined in: [interfaces/screens/email-identifier-challenge.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L21) +Defined in: [interfaces/screens/email-identifier-challenge.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L21) #### Overrides @@ -81,7 +81,7 @@ Defined in: [interfaces/screens/email-identifier-challenge.ts:21](https://github <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -103,7 +103,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -114,7 +114,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -126,7 +126,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/email-identifier-challenge.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L23) +Defined in: [interfaces/screens/email-identifier-challenge.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L23) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -143,7 +143,7 @@ Defined in: [interfaces/screens/email-identifier-challenge.ts:23](https://github <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`payload?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [interfaces/screens/email-identifier-challenge.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L24) +Defined in: [interfaces/screens/email-identifier-challenge.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L24) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> @@ -160,7 +160,7 @@ Defined in: [interfaces/screens/email-identifier-challenge.ts:24](https://github <ParamField body='returnToPrevious' type='Promise<void>'> {/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/email-identifier-challenge.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L25) +Defined in: [interfaces/screens/email-identifier-challenge.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L25) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -177,7 +177,7 @@ Defined in: [interfaces/screens/email-identifier-challenge.ts:25](https://github <ParamField body='submitEmailChallenge' type='Promise<void>'> {/*> **submitEmailChallenge**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/email-identifier-challenge.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L22) +Defined in: [interfaces/screens/email-identifier-challenge.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L22) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions">EmailChallengeOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.mdx index 04c68e7d2..3021f870d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "EmailOTPChallengeMembers" --- -Defined in: [interfaces/screens/email-otp-challenge.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L25) +Defined in: [interfaces/screens/email-otp-challenge.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L25) Represents the Email OTP Challenge screen interface. @@ -39,7 +39,7 @@ export interface EmailOTPChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -50,7 +50,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -83,7 +83,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge">ScreenMembersOnEmailOTPChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnEmailOTPChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge)*/} -Defined in: [interfaces/screens/email-otp-challenge.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L26) +Defined in: [interfaces/screens/email-otp-challenge.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L26) #### Overrides @@ -94,7 +94,7 @@ Defined in: [interfaces/screens/email-otp-challenge.ts:26](https://github.com/au <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -116,7 +116,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -127,7 +127,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -139,7 +139,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`options?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/email-otp-challenge.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L36) +Defined in: [interfaces/screens/email-otp-challenge.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L36) Requests a new OTP code to be sent to the user's email. @@ -160,7 +160,7 @@ Optional parameters to include in the resend request. <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [interfaces/screens/email-otp-challenge.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L41) +Defined in: [interfaces/screens/email-otp-challenge.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L41) Gets resend functionality with timeout management for this screen @@ -181,7 +181,7 @@ Configuration options for resend functionality <ParamField body='submitCode' type='Promise<void>'> {/*> **submitCode**(`options`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/email-otp-challenge.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L31) +Defined in: [interfaces/screens/email-otp-challenge.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L31) Submits the OTP code entered by the user. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.mdx index 9ac8b21f8..f341a53fd 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.mdx @@ -2,7 +2,7 @@ title: "EmailVerificationResultMembers" --- -Defined in: [interfaces/screens/email-verification-result.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts#L45) +Defined in: [interfaces/screens/email-verification-result.ts:45](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts#L45) EmailVerificationResultMembers @@ -29,7 +29,7 @@ export interface EmailVerificationResultMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -51,7 +51,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -73,7 +73,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult">ScreenMembersOnEmailVerificationResult</a></span>}> {/*> **screen**: [`ScreenMembersOnEmailVerificationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult)*/} -Defined in: [interfaces/screens/email-verification-result.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts#L51) +Defined in: [interfaces/screens/email-verification-result.ts:51](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts#L51) Screen-specific data, including verification status and login link. @@ -86,7 +86,7 @@ Screen-specific data, including verification status and login link. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -97,7 +97,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -108,7 +108,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -119,7 +119,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice.mdx index 7e5e989b3..ce060c89f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice.mdx @@ -2,7 +2,7 @@ title: "EnrolledDevice" --- -Defined in: [interfaces/models/user.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L12) +Defined in: [interfaces/models/user.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L12) <RequestExample> @@ -19,12 +19,12 @@ export interface EnrolledDevice { <ParamField body='device' type='string'> {/*> **device**: `string`*/} -Defined in: [interfaces/models/user.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L14) +Defined in: [interfaces/models/user.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L14) </ParamField> <ParamField body='id' type='number'> {/*> **id**: `number`*/} -Defined in: [interfaces/models/user.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L13) +Defined in: [interfaces/models/user.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L13) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail.mdx index a3c97e809..86db30e61 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail.mdx @@ -2,7 +2,7 @@ title: "EnrolledEmail" --- -Defined in: [interfaces/models/user.ts:2](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L2) +Defined in: [interfaces/models/user.ts:2](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L2) <RequestExample> @@ -19,12 +19,12 @@ export interface EnrolledEmail { <ParamField body='email' type='string'> {/*> **email**: `string`*/} -Defined in: [interfaces/models/user.ts:4](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L4) +Defined in: [interfaces/models/user.ts:4](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L4) </ParamField> <ParamField body='id' type='number'> {/*> **id**: `number`*/} -Defined in: [interfaces/models/user.ts:3](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L3) +Defined in: [interfaces/models/user.ts:3](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L3) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber.mdx index c92c1502d..57c724901 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber.mdx @@ -2,7 +2,7 @@ title: "EnrolledPhoneNumber" --- -Defined in: [interfaces/models/user.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L7) +Defined in: [interfaces/models/user.ts:7](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L7) <RequestExample> @@ -19,12 +19,12 @@ export interface EnrolledPhoneNumber { <ParamField body='id' type='number'> {/*> **id**: `number`*/} -Defined in: [interfaces/models/user.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L8) +Defined in: [interfaces/models/user.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L8) </ParamField> <ParamField body='phoneNumber' type='string'> {/*> **phoneNumber**: `string`*/} -Defined in: [interfaces/models/user.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L9) +Defined in: [interfaces/models/user.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L9) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection.mdx index aee05d3a9..ef6b4e7e3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection.mdx @@ -2,7 +2,7 @@ title: "EnterpriseConnection" --- -Defined in: [interfaces/models/transaction.ts:126](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L126) +Defined in: [interfaces/models/transaction.ts:126](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L126) <RequestExample> @@ -26,7 +26,7 @@ export interface EnterpriseConnection extends Connection { <ParamField body='metadata?' type='Record'> {/*> `optional` **metadata**: `Record`\<`string`, `string`\>*/} -Defined in: [interfaces/models/transaction.ts:4](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L4) +Defined in: [interfaces/models/transaction.ts:4](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L4) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/transaction.ts:4](https://github.com/auth0/univer <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/transaction.ts:2](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L2) +Defined in: [interfaces/models/transaction.ts:2](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L2) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/transaction.ts:2](https://github.com/auth0/univer <ParamField body='options' type='object'> {/*> **options**: `object`*/} -Defined in: [interfaces/models/transaction.ts:127](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L127) +Defined in: [interfaces/models/transaction.ts:127](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L127) #### displayName? @@ -67,7 +67,7 @@ Defined in: [interfaces/models/transaction.ts:127](https://github.com/auth0/univ <ParamField body='strategy' type='string'> {/*> **strategy**: `string`*/} -Defined in: [interfaces/models/transaction.ts:3](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L3) +Defined in: [interfaces/models/transaction.ts:3](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L3) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error.mdx index 7ba26e227..0a95c2ffa 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error.mdx @@ -2,7 +2,7 @@ title: "Error" --- -Defined in: [interfaces/models/transaction.ts:149](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L149) +Defined in: [interfaces/models/transaction.ts:149](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L149) <RequestExample> @@ -21,26 +21,26 @@ export interface Error { <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/models/transaction.ts:150](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L150) +Defined in: [interfaces/models/transaction.ts:150](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L150) </ParamField> <ParamField body='field?' type='string'> {/*> `optional` **field**: `string`*/} -Defined in: [interfaces/models/transaction.ts:151](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L151) +Defined in: [interfaces/models/transaction.ts:151](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L151) </ParamField> <ParamField body='message' type='string'> {/*> **message**: `string`*/} -Defined in: [interfaces/models/transaction.ts:152](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L152) +Defined in: [interfaces/models/transaction.ts:152](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L152) </ParamField> <ParamField body='rules?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule">PasswordComplexityRule</a></span>}> {/*> `optional` **rules**: [`PasswordComplexityRule`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule)[]*/} -Defined in: [interfaces/models/transaction.ts:153](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L153) +Defined in: [interfaces/models/transaction.ts:153](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L153) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions.mdx index 79d4ee192..b17e34824 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions.mdx @@ -2,7 +2,7 @@ title: "FederatedLoginOptions" --- -Defined in: [interfaces/screens/login-id.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L52) +Defined in: [interfaces/screens/login-id.ts:52](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L52) <RequestExample> @@ -23,5 +23,5 @@ export interface FederatedLoginOptions { <ParamField body='connection' type='string'> {/*> **connection**: `string`*/} -Defined in: [interfaces/screens/login-id.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L53) +Defined in: [interfaces/screens/login-id.ts:53](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L53) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions.mdx index b77e8db4c..055c05252 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions.mdx @@ -2,7 +2,7 @@ title: "FederatedLoginPasswordOptions" --- -Defined in: [interfaces/screens/login-password.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L48) +Defined in: [interfaces/screens/login-password.ts:48](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L48) <RequestExample> @@ -23,5 +23,5 @@ export interface FederatedLoginOptions { <ParamField body='connection' type='string'> {/*> **connection**: `string`*/} -Defined in: [interfaces/screens/login-password.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L49) +Defined in: [interfaces/screens/login-password.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L49) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions.mdx index 46f4360f5..237c0e5d7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions.mdx @@ -2,7 +2,7 @@ title: "FederatedLoginPayloadOptions" --- -Defined in: [interfaces/screens/login.ts:70](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L70) +Defined in: [interfaces/screens/login.ts:70](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L70) Options for performing social login operations @@ -29,7 +29,7 @@ Any additional custom options <ParamField body='connection' type='string'> {/*> **connection**: `string`*/} -Defined in: [interfaces/screens/login.ts:72](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L72) +Defined in: [interfaces/screens/login.ts:72](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L72) The social connection name to use </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions.mdx index 0c4da3a7f..74bd553b4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions.mdx @@ -2,7 +2,7 @@ title: "FederatedSignupOptions" --- -Defined in: [interfaces/screens/signup-id.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L41) +Defined in: [interfaces/screens/signup-id.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L41) <RequestExample> @@ -23,5 +23,5 @@ export interface FederatedSignupOptions { <ParamField body='connection' type='string'> {/*> **connection**: `string`*/} -Defined in: [interfaces/screens/signup-id.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L42) +Defined in: [interfaces/screens/signup-id.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L42) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions.mdx index 975fbd451..d27390877 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions.mdx @@ -2,7 +2,7 @@ title: "FederatedSignupPasswordPayloadOptions" --- -Defined in: [interfaces/screens/signup-password.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L24) +Defined in: [interfaces/screens/signup-password.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L24) <RequestExample> @@ -23,5 +23,5 @@ export interface FederatedSignupOptions { <ParamField body='connection' type='string'> {/*> **connection**: `string`*/} -Defined in: [interfaces/screens/signup-password.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L25) +Defined in: [interfaces/screens/signup-password.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L25) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions.mdx index 244df3151..869f64526 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions.mdx @@ -2,7 +2,7 @@ title: "FederatedSignupPayloadOptions" --- -Defined in: [interfaces/screens/signup.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L18) +Defined in: [interfaces/screens/signup.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L18) <RequestExample> @@ -23,5 +23,5 @@ export interface FederatedSignupOptions { <ParamField body='connection' type='string'> {/*> **connection**: `string`*/} -Defined in: [interfaces/screens/signup.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L19) +Defined in: [interfaces/screens/signup.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L19) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FlattenedTheme.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FlattenedTheme.mdx index d8e78379e..e5870b6fe 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FlattenedTheme.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FlattenedTheme.mdx @@ -2,7 +2,7 @@ title: "FlattenedTheme" --- -Defined in: [interfaces/common/index.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L55) +Defined in: [interfaces/common/index.ts:55](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L55) <RequestExample> @@ -22,33 +22,33 @@ export interface FlattenedTheme { <ParamField body='borders' type='Record'> {/*> **borders**: `Record`\<`string`, `string` \| `number` \| `boolean`\>*/} -Defined in: [interfaces/common/index.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L58) +Defined in: [interfaces/common/index.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L58) </ParamField> <ParamField body='colors' type='Record'> {/*> **colors**: `Record`\<`string`, `string`\>*/} -Defined in: [interfaces/common/index.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L56) +Defined in: [interfaces/common/index.ts:56](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L56) </ParamField> <ParamField body='fonts' type='Record'> {/*> **fonts**: `Record`\<`string`, `string` \| `number` \| `boolean` \| `object`\>*/} -Defined in: [interfaces/common/index.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L57) +Defined in: [interfaces/common/index.ts:57](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L57) </ParamField> <ParamField body='pageBackground' type='Record'> {/*> **pageBackground**: `Record`\<`string`, `string`\>*/} -Defined in: [interfaces/common/index.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L59) +Defined in: [interfaces/common/index.ts:59](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L59) </ParamField> <ParamField body='widget' type='Record'> {/*> **widget**: `Record`\<`string`, `string` \| `number`\>*/} -Defined in: [interfaces/common/index.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L60) +Defined in: [interfaces/common/index.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L60) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier.mdx index 4c4d8291f..41d19f2e1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier.mdx @@ -2,7 +2,7 @@ title: "Identifier" --- -Defined in: [interfaces/utils/signup-identifiers.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts#L30) +Defined in: [interfaces/utils/signup-identifiers.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts#L30) Describes a configured identifier field (e.g. email, phone, or username) for use in a signup form or authentication flow. @@ -40,7 +40,7 @@ const emailIdentifier: Identifier = { <ParamField body='required' type='boolean'> {/*> **required**: `boolean`*/} -Defined in: [interfaces/utils/signup-identifiers.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts#L41) +Defined in: [interfaces/utils/signup-identifiers.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts#L41) Whether this identifier is required for signup. @@ -49,7 +49,7 @@ Whether this identifier is required for signup. <ParamField body='type' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType">ScreenIdentifierType</a></span>}> {/*> **type**: [`ScreenIdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType)*/} -Defined in: [interfaces/utils/signup-identifiers.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts#L36) +Defined in: [interfaces/utils/signup-identifiers.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts#L36) The type of identifier, such as `'email'`, `'phone'`, or `'username'`. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.mdx index d53d869d4..7e57d592a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.mdx @@ -2,7 +2,7 @@ title: "InterstitialCaptchaMembers" --- -Defined in: [interfaces/screens/interstitial-captcha.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts#L8) +Defined in: [interfaces/screens/interstitial-captcha.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts#L8) <RequestExample> @@ -22,7 +22,7 @@ export interface InterstitialCaptchaMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -33,7 +33,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) #### Inherited from @@ -76,11 +76,11 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ <ParamField body='Parameters' type='unknown'>{/*> **submitCaptcha**: (`payload`) => `void`*/} -Defined in: [interfaces/screens/interstitial-captcha.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts#L9) +Defined in: [interfaces/screens/interstitial-captcha.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts#L9) -<Expandable title="Parameters"> +<<Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions">SubmitCaptchaOptions</a></span>}> -{/*> **payload**: [`SubmitCaptchaOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions)*/} +[`SubmitCaptchaOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions) </ParamField> </Expandable> #### Returns @@ -93,7 +93,7 @@ Defined in: [interfaces/screens/interstitial-captcha.ts:9](https://github.com/au <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -104,7 +104,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -115,7 +115,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -126,7 +126,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.mdx index 1668d6992..f218d1648 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.mdx @@ -2,7 +2,7 @@ title: "LoginEmailVerificationMembers" --- -Defined in: [interfaces/screens/login-email-verification.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L48) +Defined in: [interfaces/screens/login-email-verification.ts:48](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L48) LoginEmailVerificationMembers description Defines the members (properties and methods) available for interacting with the Login Email Verification screen. @@ -125,7 +125,7 @@ export interface LoginEmailVerificationMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -136,7 +136,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -147,7 +147,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -158,7 +158,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -169,7 +169,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) #### Inherited from @@ -180,7 +180,7 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -191,7 +191,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -202,7 +202,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -213,7 +213,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -225,7 +225,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continueWithCode' type='Promise<void>'> {/*> **continueWithCode**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/login-email-verification.ts:92](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L92) +Defined in: [interfaces/screens/login-email-verification.ts:92](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L92) Submits the email verification code entered by the user. This action corresponds to the user entering the code they received via email and @@ -289,7 +289,7 @@ if (manager.transaction.errors && manager.transaction.errors.length > 0) { <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/login-email-verification.ts:133](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L133) +Defined in: [interfaces/screens/login-email-verification.ts:133](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L133) Requests a new verification code to be sent to the user's email address. This action is typically invoked when the user clicks a "Resend Code" button, perhaps because @@ -349,7 +349,7 @@ if (manager.transaction.errors && manager.transaction.errors.length > 0) { <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [interfaces/screens/login-email-verification.ts:139](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L139) +Defined in: [interfaces/screens/login-email-verification.ts:139](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L139) Gets resend functionality with timeout management for this screen diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions.mdx index 260ae6a0b..4fcf0cf2e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions.mdx @@ -2,7 +2,7 @@ title: "LoginEnrollOptions" --- -Defined in: [interfaces/screens/mfa-login-options.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L19) +Defined in: [interfaces/screens/mfa-login-options.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L19) Options for continuing with a selected MFA factor @@ -29,7 +29,7 @@ Any additional custom options <ParamField body='action' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaLoginFactorType">MfaLoginFactorType</a></span>}> {/*> **action**: [`MfaLoginFactorType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaLoginFactorType)*/} -Defined in: [interfaces/screens/mfa-login-options.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L21) +Defined in: [interfaces/screens/mfa-login-options.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L21) The action indicating which factor to use for login </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.mdx index ec4f6dbfd..cf70d545b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.mdx @@ -2,7 +2,7 @@ title: "LoginIdMembers" --- -Defined in: [interfaces/screens/login-id.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L57) +Defined in: [interfaces/screens/login-id.ts:57](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L57) <RequestExample> @@ -28,7 +28,7 @@ export interface LoginIdMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -39,7 +39,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -50,7 +50,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId">ScreenMembersOnLoginId</a></span>}> {/*> **screen**: [`ScreenMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId)*/} -Defined in: [interfaces/screens/login-id.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L58) +Defined in: [interfaces/screens/login-id.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L58) #### Overrides @@ -83,7 +83,7 @@ Defined in: [interfaces/screens/login-id.ts:58](https://github.com/auth0/univers <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId">TransactionMembersOnLoginId</a></span>}> {/*> **transaction**: [`TransactionMembersOnLoginId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId)*/} -Defined in: [interfaces/screens/login-id.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L59) +Defined in: [interfaces/screens/login-id.ts:59](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L59) #### Overrides @@ -105,7 +105,7 @@ Defined in: [interfaces/screens/login-id.ts:59](https://github.com/auth0/univers <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -116,7 +116,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -128,7 +128,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='federatedLogin' type='Promise<void>'> {/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/login-id.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L61) +Defined in: [interfaces/screens/login-id.ts:61](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L61) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions">FederatedLoginOptions</a></span>}> @@ -145,7 +145,7 @@ Defined in: [interfaces/screens/login-id.ts:61](https://github.com/auth0/univers <ParamField body='getLoginIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> {/*> **getLoginIdentifiers**(): [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} -Defined in: [interfaces/screens/login-id.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L64) +Defined in: [interfaces/screens/login-id.ts:64](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L64) #### Returns @@ -156,7 +156,7 @@ Defined in: [interfaces/screens/login-id.ts:64](https://github.com/auth0/univers <ParamField body='login' type='Promise<void>'> {/*> **login**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/login-id.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L60) +Defined in: [interfaces/screens/login-id.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L60) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions">LoginOptions</a></span>}> @@ -173,7 +173,7 @@ Defined in: [interfaces/screens/login-id.ts:60](https://github.com/auth0/univers <ParamField body='passkeyLogin' type='Promise<void>'> {/*> **passkeyLogin**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/login-id.ts:62](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L62) +Defined in: [interfaces/screens/login-id.ts:62](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L62) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -190,7 +190,7 @@ Defined in: [interfaces/screens/login-id.ts:62](https://github.com/auth0/univers <ParamField body='pickCountryCode' type='Promise<void>'> {/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/login-id.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L63) +Defined in: [interfaces/screens/login-id.ts:63](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L63) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.mdx index 1442e1fe2..64f75ee38 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.mdx @@ -2,7 +2,7 @@ title: "LoginMembers" --- -Defined in: [interfaces/screens/login.ts:80](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L80) +Defined in: [interfaces/screens/login.ts:80](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L80) Login screen members interface extending base members @@ -46,7 +46,7 @@ export interface LoginMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -57,7 +57,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -79,7 +79,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -90,7 +90,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin">ScreenMembersOnLogin</a></span>}> {/*> **screen**: [`ScreenMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin)*/} -Defined in: [interfaces/screens/login.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L81) +Defined in: [interfaces/screens/login.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L81) #### Overrides @@ -101,7 +101,7 @@ Defined in: [interfaces/screens/login.ts:81](https://github.com/auth0/universal- <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -112,7 +112,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin">TransactionMembersOnLogin</a></span>}> {/*> **transaction**: [`TransactionMembersOnLogin`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin)*/} -Defined in: [interfaces/screens/login.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L82) +Defined in: [interfaces/screens/login.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L82) #### Overrides @@ -123,7 +123,7 @@ Defined in: [interfaces/screens/login.ts:82](https://github.com/auth0/universal- <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -134,7 +134,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -146,7 +146,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='federatedLogin' type='Promise<void>'> {/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/login.ts:92](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L92) +Defined in: [interfaces/screens/login.ts:92](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L92) Performs login with social provider @@ -167,7 +167,7 @@ The social login options <ParamField body='getLoginIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> {/*> **getLoginIdentifiers**(): [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} -Defined in: [interfaces/screens/login.ts:103](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L103) +Defined in: [interfaces/screens/login.ts:103](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L103) **`Utility Feature`** @@ -184,7 +184,7 @@ An array of active identifier types or null if none are active <ParamField body='login' type='Promise<void>'> {/*> **login**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/login.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L87) +Defined in: [interfaces/screens/login.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L87) Performs login with username/password @@ -205,7 +205,7 @@ The login options <ParamField body='pickCountryCode' type='Promise<void>'> {/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/login.ts:97](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L97) +Defined in: [interfaces/screens/login.ts:97](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L97) Picks country code for phone number input diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions.mdx index b4ca922da..4f60307e9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions.mdx @@ -2,7 +2,7 @@ title: "LoginOptions" --- -Defined in: [interfaces/screens/login-id.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L46) +Defined in: [interfaces/screens/login-id.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L46) <RequestExample> @@ -24,12 +24,12 @@ export interface LoginOptions { <ParamField body='captcha?' type='string'> {/*> `optional` **captcha**: `string`*/} -Defined in: [interfaces/screens/login-id.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L48) +Defined in: [interfaces/screens/login-id.ts:48](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L48) </ParamField> <ParamField body='username' type='string'> {/*> **username**: `string`*/} -Defined in: [interfaces/screens/login-id.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L47) +Defined in: [interfaces/screens/login-id.ts:47](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L47) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.mdx index 8bd2debd9..66ec97999 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.mdx @@ -2,7 +2,7 @@ title: "LoginPasswordMembers" --- -Defined in: [interfaces/screens/login-password.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L53) +Defined in: [interfaces/screens/login-password.ts:53](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L53) <RequestExample> @@ -25,7 +25,7 @@ export interface LoginPasswordMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -36,7 +36,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -47,7 +47,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -58,7 +58,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -69,7 +69,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword">ScreenMembersOnLoginPassword</a></span>}> {/*> **screen**: [`ScreenMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword)*/} -Defined in: [interfaces/screens/login-password.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L54) +Defined in: [interfaces/screens/login-password.ts:54](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L54) #### Overrides @@ -80,7 +80,7 @@ Defined in: [interfaces/screens/login-password.ts:54](https://github.com/auth0/u <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -91,7 +91,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword">TransactionMembersOnLoginPassword</a></span>}> {/*> **transaction**: [`TransactionMembersOnLoginPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword)*/} -Defined in: [interfaces/screens/login-password.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L55) +Defined in: [interfaces/screens/login-password.ts:55](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L55) #### Overrides @@ -102,7 +102,7 @@ Defined in: [interfaces/screens/login-password.ts:55](https://github.com/auth0/u <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -113,7 +113,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -125,7 +125,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='federatedLogin' type='Promise<void>'> {/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/login-password.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L57) +Defined in: [interfaces/screens/login-password.ts:57](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L57) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions">FederatedLoginPasswordOptions</a></span>}> @@ -142,7 +142,7 @@ Defined in: [interfaces/screens/login-password.ts:57](https://github.com/auth0/u <ParamField body='login' type='Promise<void>'> {/*> **login**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/login-password.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L56) +Defined in: [interfaces/screens/login-password.ts:56](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L56) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions">LoginPasswordOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions.mdx index 4f3b325d4..fde7d0eb7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions.mdx @@ -2,7 +2,7 @@ title: "LoginPasswordOptions" --- -Defined in: [interfaces/screens/login-password.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L41) +Defined in: [interfaces/screens/login-password.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L41) <RequestExample> @@ -25,19 +25,19 @@ export interface LoginPasswordOptions { <ParamField body='captcha?' type='string'> {/*> `optional` **captcha**: `string`*/} -Defined in: [interfaces/screens/login-password.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L44) +Defined in: [interfaces/screens/login-password.ts:44](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L44) </ParamField> <ParamField body='password' type='string'> {/*> **password**: `string`*/} -Defined in: [interfaces/screens/login-password.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L43) +Defined in: [interfaces/screens/login-password.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L43) </ParamField> <ParamField body='username' type='string'> {/*> **username**: `string`*/} -Defined in: [interfaces/screens/login-password.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L42) +Defined in: [interfaces/screens/login-password.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L42) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.mdx index 9db562f2c..b047be61c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.mdx @@ -2,7 +2,7 @@ title: "LoginPasswordlessEmailCodeMembers" --- -Defined in: [interfaces/screens/login-passwordless-email-code.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L27) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L27) <RequestExample> @@ -26,7 +26,7 @@ export interface LoginPasswordlessEmailCodeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode">ScreenMembersOnLoginPasswordlessEmailCode</a></span>}> {/*> **screen**: [`ScreenMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode)*/} -Defined in: [interfaces/screens/login-passwordless-email-code.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L28) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L28) #### Overrides @@ -81,7 +81,7 @@ Defined in: [interfaces/screens/login-passwordless-email-code.ts:28](https://git <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode">TransactionMembersOnLoginPasswordlessEmailCode</a></span>}> {/*> **transaction**: [`TransactionMembersOnLoginPasswordlessEmailCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode)*/} -Defined in: [interfaces/screens/login-passwordless-email-code.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L29) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L29) #### Overrides @@ -103,7 +103,7 @@ Defined in: [interfaces/screens/login-passwordless-email-code.ts:29](https://git <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -114,7 +114,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -126,7 +126,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/login-passwordless-email-code.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L31) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L31) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -143,7 +143,7 @@ Defined in: [interfaces/screens/login-passwordless-email-code.ts:31](https://git <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [interfaces/screens/login-passwordless-email-code.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L32) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L32) <Expandable title="Parameters"> <ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> @@ -160,7 +160,7 @@ Defined in: [interfaces/screens/login-passwordless-email-code.ts:32](https://git <ParamField body='submitCode' type='Promise<void>'> {/*> **submitCode**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/login-passwordless-email-code.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L30) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L30) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions">SubmitCodeOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.mdx index 4d195e7a6..529884d8d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.mdx @@ -2,7 +2,7 @@ title: "LoginPasswordlessSmsOtpMembers" --- -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L35) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:35](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L35) <RequestExample> @@ -30,7 +30,7 @@ export interface LoginPasswordlessSmsOtpMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -41,7 +41,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -52,7 +52,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -63,7 +63,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp">ScreenMembersOnLoginPasswordlessSmsOtp</a></span>}> {/*> **screen**: [`ScreenMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp)*/} -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L36) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L36) #### Overrides @@ -85,7 +85,7 @@ Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:36](https://github <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -96,7 +96,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp">TransactionMembersOnLoginPasswordlessSmsOtp</a></span>}> {/*> **transaction**: [`TransactionMembersOnLoginPasswordlessSmsOtp`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp)*/} -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L37) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L37) #### Overrides @@ -107,7 +107,7 @@ Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:37](https://github <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -118,7 +118,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -130,7 +130,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L44) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:44](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L44) Gets resend functionality with timeout management for this screen @@ -151,7 +151,7 @@ Configuration options for resend functionality <ParamField body='resendOTP' type='Promise<void>'> {/*> **resendOTP**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L39) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L39) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -168,7 +168,7 @@ Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:39](https://github <ParamField body='submitOTP' type='Promise<void>'> {/*> **submitOTP**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L38) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L38) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions">SubmitOTPOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions.mdx index 90d32ffb3..1d2919339 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions.mdx @@ -2,7 +2,7 @@ title: "LoginPayloadOptions" --- -Defined in: [interfaces/screens/login.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L56) +Defined in: [interfaces/screens/login.ts:56](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L56) Options for performing login operations @@ -33,7 +33,7 @@ Any additional custom options <ParamField body='captcha?' type='string'> {/*> `optional` **captcha**: `string`*/} -Defined in: [interfaces/screens/login.ts:62](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L62) +Defined in: [interfaces/screens/login.ts:62](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L62) Optional captcha value if required @@ -42,7 +42,7 @@ Optional captcha value if required <ParamField body='password' type='string'> {/*> **password**: `string`*/} -Defined in: [interfaces/screens/login.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L60) +Defined in: [interfaces/screens/login.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L60) The password for authentication @@ -51,7 +51,7 @@ The password for authentication <ParamField body='username' type='string'> {/*> **username**: `string`*/} -Defined in: [interfaces/screens/login.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L58) +Defined in: [interfaces/screens/login.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L58) The username/email to login with </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.mdx index e28b9981c..de675784c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.mdx @@ -2,7 +2,7 @@ title: "LogoutAbortedMembers" --- -Defined in: [interfaces/screens/logout-aborted.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/logout-aborted.ts#L6) +Defined in: [interfaces/screens/logout-aborted.ts:6](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/logout-aborted.ts#L6) Interface defining the available methods and properties for the logout-aborted screen @@ -22,7 +22,7 @@ export interface LogoutAbortedMembers extends BaseMembers {} <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -33,7 +33,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.mdx index 3007fdfdd..dd20f317b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.mdx @@ -2,7 +2,7 @@ title: "LogoutCompleteMembers" --- -Defined in: [interfaces/screens/logout-complete.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/logout-complete.ts#L6) +Defined in: [interfaces/screens/logout-complete.ts:6](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/logout-complete.ts#L6) Interface defining the available methods and properties for the logout-complete screen @@ -22,7 +22,7 @@ export interface LogoutCompleteMembers extends BaseMembers {} <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -33,7 +33,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.mdx index 4ba4a082f..7bbc7ba80 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.mdx @@ -2,7 +2,7 @@ title: "LogoutMembers" --- -Defined in: [interfaces/screens/logout.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/logout.ts#L15) +Defined in: [interfaces/screens/logout.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/logout.ts#L15) Interface defining the available methods and properties for the logout screen @@ -28,7 +28,7 @@ export interface LogoutMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -39,7 +39,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -50,7 +50,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) #### Inherited from @@ -83,7 +83,7 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -116,7 +116,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -128,7 +128,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='confirmLogout' type='Promise<void>'> {/*> **confirmLogout**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/logout.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/logout.ts#L20) +Defined in: [interfaces/screens/logout.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/logout.ts#L20) Confirms the logout action (accept or deny) diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.mdx index 7b8c7c169..66e1d90ef 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.mdx @@ -2,7 +2,7 @@ title: "MfaBeginEnrollOptionsMembers" --- -Defined in: [interfaces/screens/mfa-begin-enroll-options.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts#L17) +Defined in: [interfaces/screens/mfa-begin-enroll-options.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts#L17) MFA Begin Enroll Options screen members interface @@ -28,7 +28,7 @@ export interface MfaBeginEnrollOptionsMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -39,7 +39,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -50,7 +50,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) #### Inherited from @@ -83,7 +83,7 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -116,7 +116,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -128,7 +128,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='enroll' type='Promise<void>'> {/*> **enroll**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-begin-enroll-options.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts#L22) +Defined in: [interfaces/screens/mfa-begin-enroll-options.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts#L22) Continues the enrollment process with the selected factor diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.mdx index 8b996bc5e..a87a31a8b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.mdx @@ -2,7 +2,7 @@ title: "MfaCountryCodesMembers" --- -Defined in: [interfaces/screens/mfa-country-codes.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L30) +Defined in: [interfaces/screens/mfa-country-codes.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L30) Interface defining the available methods and properties for the mfa-country-codes screen @@ -34,7 +34,7 @@ export interface MfaCountryCodesMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -45,7 +45,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -56,7 +56,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -67,7 +67,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes">ScreenMembersOnMfaCountryCodes</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaCountryCodes`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes)*/} -Defined in: [interfaces/screens/mfa-country-codes.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L31) +Defined in: [interfaces/screens/mfa-country-codes.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L31) #### Overrides @@ -89,7 +89,7 @@ Defined in: [interfaces/screens/mfa-country-codes.ts:31](https://github.com/auth <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -100,7 +100,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -111,7 +111,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -122,7 +122,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -134,7 +134,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='goBack' type='Promise<void>'> {/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-country-codes.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L41) +Defined in: [interfaces/screens/mfa-country-codes.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L41) Navigates back to the previous screen @@ -155,7 +155,7 @@ Optional custom options to include with the request <ParamField body='selectCountryCode' type='Promise<void>'> {/*> **selectCountryCode**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-country-codes.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L36) +Defined in: [interfaces/screens/mfa-country-codes.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L36) Selects a country code from the available options diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx index 28a72f491..c89c1d209 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx @@ -2,7 +2,7 @@ title: "MfaDetectBrowserCapabilitiesMembers" --- -Defined in: [interfaces/screens/mfa-detect-browser-capabilities.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-detect-browser-capabilities.ts#L7) +Defined in: [interfaces/screens/mfa-detect-browser-capabilities.ts:7](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-detect-browser-capabilities.ts#L7) Interface defining the available methods and properties for the mfa-detect-browser-capabilities screen @@ -33,7 +33,7 @@ export interface MfaDetectBrowserCapabilitiesMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -121,7 +121,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -133,7 +133,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='detectCapabilities' type='Promise<void>'> {/*> **detectCapabilities**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-detect-browser-capabilities.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-detect-browser-capabilities.ts#L17) +Defined in: [interfaces/screens/mfa-detect-browser-capabilities.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-detect-browser-capabilities.ts#L17) Picks an authenticator based on browser capabilities diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.mdx index 372c15aca..26eea73ec 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "MfaEmailChallengeMembers" --- -Defined in: [interfaces/screens/mfa-email-challenge.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L57) +Defined in: [interfaces/screens/mfa-email-challenge.ts:57](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L57) Interface defining the available methods and properties for the mfa-email-challenge screen @@ -55,7 +55,7 @@ export interface MfaEmailChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge">ScreenMembersOnMfaEmailChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge)*/} -Defined in: [interfaces/screens/mfa-email-challenge.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L58) +Defined in: [interfaces/screens/mfa-email-challenge.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L58) #### Overrides @@ -110,7 +110,7 @@ Defined in: [interfaces/screens/mfa-email-challenge.ts:58](https://github.com/au <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -121,7 +121,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -132,7 +132,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge">UntrustedDataMembersOnMfaEmailChallenge</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembersOnMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge)*/} -Defined in: [interfaces/screens/mfa-email-challenge.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L59) +Defined in: [interfaces/screens/mfa-email-challenge.ts:59](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L59) #### Overrides @@ -143,7 +143,7 @@ Defined in: [interfaces/screens/mfa-email-challenge.ts:59](https://github.com/au <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -155,7 +155,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-email-challenge.ts:65](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L65) +Defined in: [interfaces/screens/mfa-email-challenge.ts:65](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L65) Continues with the email challenge using the provided code @@ -176,7 +176,7 @@ The options containing the code and rememberDevice flag <ParamField body='pickEmail' type='Promise<void>'> {/*> **pickEmail**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-email-challenge.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L83) +Defined in: [interfaces/screens/mfa-email-challenge.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L83) Submits the action to pick a different Email configuration, if available @@ -197,7 +197,7 @@ Optional custom options to include with the request <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-email-challenge.ts:71](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L71) +Defined in: [interfaces/screens/mfa-email-challenge.ts:71](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L71) Resends the email code @@ -218,7 +218,7 @@ Optional custom options to include with the request <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [interfaces/screens/mfa-email-challenge.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L89) +Defined in: [interfaces/screens/mfa-email-challenge.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L89) Gets resend functionality with timeout management for this screen @@ -239,7 +239,7 @@ Configuration options for resend functionality <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-email-challenge.ts:77](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L77) +Defined in: [interfaces/screens/mfa-email-challenge.ts:77](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L77) Allows the user to try another MFA method diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.mdx index cba2f4110..207a4b99f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.mdx @@ -2,7 +2,7 @@ title: "MfaEmailListMembers" --- -Defined in: [interfaces/screens/mfa-email-list.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L31) +Defined in: [interfaces/screens/mfa-email-list.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L31) Interface defining the available methods and properties for the mfa-email-list screen @@ -34,7 +34,7 @@ export interface MfaEmailListMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -45,7 +45,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -56,7 +56,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -67,7 +67,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList">ScreenMembersOnMfaEmailList</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaEmailList`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList)*/} -Defined in: [interfaces/screens/mfa-email-list.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L32) +Defined in: [interfaces/screens/mfa-email-list.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L32) #### Overrides @@ -89,7 +89,7 @@ Defined in: [interfaces/screens/mfa-email-list.ts:32](https://github.com/auth0/u <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -100,7 +100,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -111,7 +111,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -122,7 +122,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -134,7 +134,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='goBack' type='Promise<void>'> {/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-email-list.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L42) +Defined in: [interfaces/screens/mfa-email-list.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L42) Navigates back to the previous screen @@ -155,7 +155,7 @@ Optional custom options to include with the request <ParamField body='selectMfaEmail' type='Promise<void>'> {/*> **selectMfaEmail**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-email-list.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L37) +Defined in: [interfaces/screens/mfa-email-list.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L37) Selects an enrolled email address from the list diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions.mdx index 0e40d0fd3..949e6b12f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions.mdx @@ -2,7 +2,7 @@ title: "MfaEnrollOptions" --- -Defined in: [interfaces/screens/mfa-begin-enroll-options.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts#L7) +Defined in: [interfaces/screens/mfa-begin-enroll-options.ts:7](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts#L7) Options for continuing with factor enrollment @@ -29,7 +29,7 @@ Any additional custom options <ParamField body='action' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaEnrollFactorType">MfaEnrollFactorType</a></span>}> {/*> **action**: [`MfaEnrollFactorType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaEnrollFactorType)*/} -Defined in: [interfaces/screens/mfa-begin-enroll-options.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts#L9) +Defined in: [interfaces/screens/mfa-begin-enroll-options.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts#L9) The action indicating which factor to enroll </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.mdx index 676696598..02cc4e330 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.mdx @@ -2,7 +2,7 @@ title: "MfaEnrollResultMembers" --- -Defined in: [interfaces/screens/mfa-enroll-result.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts#L45) +Defined in: [interfaces/screens/mfa-enroll-result.ts:45](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts#L45) MfaEnrollResultMembers @@ -33,7 +33,7 @@ export interface MfaEnrollResultMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult">ScreenMembersOnMfaEnrollResult</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaEnrollResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult)*/} -Defined in: [interfaces/screens/mfa-enroll-result.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts#L51) +Defined in: [interfaces/screens/mfa-enroll-result.ts:51](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts#L51) Screen-specific data, including enrollment status. @@ -90,7 +90,7 @@ Screen-specific data, including enrollment status. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -101,7 +101,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -112,7 +112,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -123,7 +123,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.mdx index 45a908453..f984ff6b8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.mdx @@ -2,7 +2,7 @@ title: "MfaLoginOptionsMembers" --- -Defined in: [interfaces/screens/mfa-login-options.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L29) +Defined in: [interfaces/screens/mfa-login-options.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L29) Interface defining the available methods and properties for the mfa-login-options screen @@ -46,7 +46,7 @@ export interface MfaLoginOptionsMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -57,7 +57,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -79,7 +79,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -90,7 +90,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions">ScreenMembersOnMfaLoginOptions</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions)*/} -Defined in: [interfaces/screens/mfa-login-options.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L30) +Defined in: [interfaces/screens/mfa-login-options.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L30) #### Overrides @@ -101,7 +101,7 @@ Defined in: [interfaces/screens/mfa-login-options.ts:30](https://github.com/auth <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -112,7 +112,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -123,7 +123,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -134,7 +134,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -146,7 +146,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='enroll' type='Promise<void>'> {/*> **enroll**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-login-options.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L42) +Defined in: [interfaces/screens/mfa-login-options.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L42) Continues the login process with the selected MFA factor @@ -176,7 +176,7 @@ await mfaLoginOptions.enroll({ <ParamField body='returnToPrevious' type='Promise<void>'> {/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-login-options.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L52) +Defined in: [interfaces/screens/mfa-login-options.ts:52](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L52) Returns to the previous screen in the authentication flow diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.mdx index 0ae236bd9..21cb02f7f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "MfaOtpChallengeMembers" --- -Defined in: [interfaces/screens/mfa-otp-challenge.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L46) +Defined in: [interfaces/screens/mfa-otp-challenge.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L46) Interface defining the available methods and properties for the mfa-otp-challenge screen @@ -37,7 +37,7 @@ export interface MfaOtpChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -81,7 +81,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge">ScreenMembersOnMfaOtpChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge)*/} -Defined in: [interfaces/screens/mfa-otp-challenge.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L47) +Defined in: [interfaces/screens/mfa-otp-challenge.ts:47](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L47) #### Overrides @@ -92,7 +92,7 @@ Defined in: [interfaces/screens/mfa-otp-challenge.ts:47](https://github.com/auth <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -103,7 +103,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -114,7 +114,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge">UntrustedDataMembersOnMfaOtpChallenge</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembersOnMfaOtpChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge)*/} -Defined in: [interfaces/screens/mfa-otp-challenge.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L48) +Defined in: [interfaces/screens/mfa-otp-challenge.ts:48](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L48) #### Overrides @@ -125,7 +125,7 @@ Defined in: [interfaces/screens/mfa-otp-challenge.ts:48](https://github.com/auth <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -137,7 +137,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-otp-challenge.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L54) +Defined in: [interfaces/screens/mfa-otp-challenge.ts:54](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L54) Continues with the OTP challenge using the provided code @@ -158,7 +158,7 @@ The options containing the code and rememberDevice flag <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-otp-challenge.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L60) +Defined in: [interfaces/screens/mfa-otp-challenge.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L60) Allows the user to try another MFA method diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions.mdx index 33582f3c1..58827aac5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions.mdx @@ -2,7 +2,7 @@ title: "MfaOtpContinueOptions" --- -Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L7) +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:7](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L7) Options for continuing with the MFA OTP enrollment code. @@ -34,7 +34,7 @@ Any additional custom options. <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L11) +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L11) The OTP code entered by the user. </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.mdx index a81398f28..7a8159b82 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.mdx @@ -2,7 +2,7 @@ title: "MfaOtpEnrollmentCodeMembers" --- -Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L44) +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:44](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L44) Interface defining the available methods and properties for the mfa-otp-enrollment-code screen. @@ -39,7 +39,7 @@ export interface MfaOtpEnrollmentCodeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -50,7 +50,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -83,7 +83,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode">ScreenMembersOnMfaOtpEnrollmentCode</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaOtpEnrollmentCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode)*/} -Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L48) +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:48](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L48) The screen properties for the mfa-otp-enrollment-code screen. @@ -96,7 +96,7 @@ The screen properties for the mfa-otp-enrollment-code screen. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -107,7 +107,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -118,7 +118,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -129,7 +129,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -141,7 +141,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L54) +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:54](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L54) Continues the MFA OTP enrollment process by submitting the OTP code. @@ -162,7 +162,7 @@ The options containing the OTP code. <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L60) +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L60) Allows the user to try another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx index f9585f784..eaac1f484 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx @@ -2,7 +2,7 @@ title: "MfaOtpEnrollmentQrContinueOptions" --- -Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L18) +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L18) Interface for the payload of the continue method @@ -28,5 +28,5 @@ export interface ContinueOptions extends CustomOptions { <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L19) +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L19) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.mdx index 33c8adc10..a444b2f48 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.mdx @@ -2,7 +2,7 @@ title: "MfaOtpEnrollmentQrMembers" --- -Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L25) +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L25) Interface defining the available methods and properties for the mfa-otp-enrollment-qr screen @@ -42,7 +42,7 @@ export interface MfaOtpEnrollmentQrMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -53,7 +53,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -64,7 +64,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -75,7 +75,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr">ScreenMembersOnMfaOtpEnrollmentQr</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaOtpEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr)*/} -Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L26) +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L26) #### Overrides @@ -97,7 +97,7 @@ Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:26](https://github.com/ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -108,7 +108,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -119,7 +119,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -130,7 +130,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -142,7 +142,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L38) +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L38) Continues with the default action. @@ -163,7 +163,7 @@ Payload containing code and optional custom options <ParamField body='toggleView' type='Promise<void>'> {/*> **toggleView**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L32) +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L32) Toggles the view. @@ -184,7 +184,7 @@ Optional custom options to include with the request <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L44) +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:44](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L44) Allows trying another authentication method diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions.mdx index 3efc48aae..0678965f3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions.mdx @@ -2,7 +2,7 @@ title: "MfaOtpTryAnotherMethodOptions" --- -Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L22) +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L22) Options for trying another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions.mdx index 7352f8e2b..7268b3b8d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions.mdx @@ -2,7 +2,7 @@ title: "MfaPhoneChallengeContinueOptions" --- -Defined in: [interfaces/screens/mfa-phone-challenge.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L32) +Defined in: [interfaces/screens/mfa-phone-challenge.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L32) ContinueOptions Defines the options required to continue the MFA phone challenge process. @@ -36,7 +36,7 @@ export interface ContinueOptions extends CustomOptions { <ParamField body='type' type='"sms"'> {/*> **type**: `"sms"` \| `"voice"`*/} -Defined in: [interfaces/screens/mfa-phone-challenge.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L39) +Defined in: [interfaces/screens/mfa-phone-challenge.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L39) The type of challenge to perform. 'sms': Send the code via text message. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.mdx index 65849b37c..99c87e5ea 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "MfaPhoneChallengeMembers" --- -Defined in: [interfaces/screens/mfa-phone-challenge.ts:62](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L62) +Defined in: [interfaces/screens/mfa-phone-challenge.ts:62](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L62) MfaPhoneChallengeMembers @@ -86,7 +86,7 @@ export interface MfaPhoneChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -97,7 +97,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -108,7 +108,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -119,7 +119,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -130,7 +130,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge">ScreenMembersOnMfaPhoneChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge)*/} -Defined in: [interfaces/screens/mfa-phone-challenge.ts:66](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L66) +Defined in: [interfaces/screens/mfa-phone-challenge.ts:66](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L66) #### Overrides @@ -141,7 +141,7 @@ Defined in: [interfaces/screens/mfa-phone-challenge.ts:66](https://github.com/au <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -152,7 +152,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -163,7 +163,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -174,7 +174,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -186,7 +186,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-phone-challenge.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L89) +Defined in: [interfaces/screens/mfa-phone-challenge.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L89) continue Submits the choice of MFA delivery method (SMS or Voice) to proceed with the challenge. @@ -229,7 +229,7 @@ await mfaPhoneChallenge.continue({ type: 'voice' }); <ParamField body='pickPhone' type='Promise<void>'> {/*> **pickPhone**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-phone-challenge.ts:107](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L107) +Defined in: [interfaces/screens/mfa-phone-challenge.ts:107](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L107) pickPhone Initiates the action to pick a different phone number. @@ -267,7 +267,7 @@ await mfaPhoneChallenge.pickPhone(); <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-phone-challenge.ts:125](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L125) +Defined in: [interfaces/screens/mfa-phone-challenge.ts:125](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L125) tryAnotherMethod Initiates the action to select a different MFA factor/authenticator. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx index 80e4ef03b..b085cf4c7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx @@ -2,7 +2,7 @@ title: "MfaPhoneChallengePickAuthenticatorOptions" --- -Defined in: [interfaces/screens/mfa-phone-challenge.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L55) +Defined in: [interfaces/screens/mfa-phone-challenge.ts:55](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L55) PickAuthenticatorOptions Defines the options for the 'pick-authenticator' action. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions.mdx index 7416374f5..1966151c3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions.mdx @@ -2,7 +2,7 @@ title: "MfaPhoneChallengePickPhoneOptions" --- -Defined in: [interfaces/screens/mfa-phone-challenge.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L48) +Defined in: [interfaces/screens/mfa-phone-challenge.ts:48](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L48) PickPhoneOptions Defines the options for the 'pick-phone' action. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions.mdx index 4311d89c8..90cac1462 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions.mdx @@ -2,7 +2,7 @@ title: "MfaPhoneEnrollmentContinueOptions" --- -Defined in: [interfaces/screens/mfa-phone-enrollment.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L14) +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L14) Options for continuing with the MFA phone enrollment. @@ -31,12 +31,12 @@ export interface ContinueOptions extends CustomOptions { <ParamField body='phone' type='string'> {/*> **phone**: `string`*/} -Defined in: [interfaces/screens/mfa-phone-enrollment.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L15) +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L15) </ParamField> <ParamField body='type' type='"sms"'> {/*> **type**: `"sms"` \| `"voice"`*/} -Defined in: [interfaces/screens/mfa-phone-enrollment.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L16) +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L16) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.mdx index f4f8a12e6..b1110d770 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.mdx @@ -2,7 +2,7 @@ title: "MfaPhoneEnrollmentMembers" --- -Defined in: [interfaces/screens/mfa-phone-enrollment.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L19) +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L19) <RequestExample> @@ -44,7 +44,7 @@ export interface MfaPhoneEnrollmentMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/screens/mfa-phone-enrollment.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L20) +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L20) #### Overrides @@ -66,7 +66,7 @@ Defined in: [interfaces/screens/mfa-phone-enrollment.ts:20](https://github.com/a <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/screens/mfa-phone-enrollment.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L21) +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L21) #### Overrides @@ -77,7 +77,7 @@ Defined in: [interfaces/screens/mfa-phone-enrollment.ts:21](https://github.com/a <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/screens/mfa-phone-enrollment.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L22) +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L22) #### Overrides @@ -88,7 +88,7 @@ Defined in: [interfaces/screens/mfa-phone-enrollment.ts:22](https://github.com/a <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/screens/mfa-phone-enrollment.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L23) +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L23) #### Overrides @@ -99,7 +99,7 @@ Defined in: [interfaces/screens/mfa-phone-enrollment.ts:23](https://github.com/a <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/screens/mfa-phone-enrollment.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L24) +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L24) #### Overrides @@ -121,7 +121,7 @@ Defined in: [interfaces/screens/mfa-phone-enrollment.ts:24](https://github.com/a <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -132,7 +132,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -144,7 +144,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continueEnrollment' type='Promise<void>'> {/*> **continueEnrollment**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-phone-enrollment.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L36) +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L36) Continues the enrollment process with the provided phone number and type (SMS or voice). @@ -165,7 +165,7 @@ The phone number, type, and optional custom options. <ParamField body='pickCountryCode' type='Promise<void>'> {/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-phone-enrollment.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L30) +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L30) Selects the country code for the phone number. @@ -186,7 +186,7 @@ Optional custom options to include with the request. <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-phone-enrollment.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L42) +Defined in: [interfaces/screens/mfa-phone-enrollment.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-enrollment.ts#L42) Allows the user to try another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.mdx index 3f48348cb..7c364db5b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.mdx @@ -2,7 +2,7 @@ title: "MfaPushChallengePushMembers" --- -Defined in: [interfaces/screens/mfa-push-challenge-push.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L39) +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L39) Interface defining the available methods and properties for the mfa-push-challenge-push screen @@ -56,7 +56,7 @@ export interface MfaPushChallengePushMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -67,7 +67,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -89,7 +89,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -100,7 +100,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush">ScreenMembersOnMfaPushChallengePush</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush)*/} -Defined in: [interfaces/screens/mfa-push-challenge-push.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L40) +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L40) #### Overrides @@ -111,7 +111,7 @@ Defined in: [interfaces/screens/mfa-push-challenge-push.ts:40](https://github.co <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -122,7 +122,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -133,7 +133,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush">UntrustedDataMembersOnMfaPushChallengePush</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembersOnMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush)*/} -Defined in: [interfaces/screens/mfa-push-challenge-push.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L41) +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L41) #### Overrides @@ -144,7 +144,7 @@ Defined in: [interfaces/screens/mfa-push-challenge-push.ts:41](https://github.co <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -156,7 +156,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-push-challenge-push.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L47) +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:47](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L47) Continues with the push notification challenge @@ -177,7 +177,7 @@ Optional custom options to include with the request <ParamField body='enterCodeManually' type='Promise<void>'> {/*> **enterCodeManually**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-push-challenge-push.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L59) +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:59](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L59) Switches to entering the verification code manually @@ -198,7 +198,7 @@ Optional custom options to include with the request <ParamField body='pollingManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> {/*> **pollingManager**(`options`): [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl)*/} -Defined in: [interfaces/screens/mfa-push-challenge-push.ts:72](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L72) +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:72](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L72) Manages polling for MFA push challenge status @@ -221,7 +221,7 @@ An object to control the polling process <ParamField body='resendPushNotification' type='Promise<void>'> {/*> **resendPushNotification**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-push-challenge-push.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L53) +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:53](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L53) Resends the push notification @@ -242,7 +242,7 @@ Optional custom options to include with the request <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-push-challenge-push.ts:65](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L65) +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:65](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L65) Allows trying another authentication method diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.mdx index 7110aa79f..24dffe8d6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.mdx @@ -2,7 +2,7 @@ title: "MfaPushEnrollmentQrMembers" --- -Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L24) +Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L24) Interface defining the available methods and properties for the mfa-push-enrollment-qr screen @@ -32,7 +32,7 @@ export interface MfaPushEnrollmentQrMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -43,7 +43,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -54,7 +54,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -65,7 +65,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -76,7 +76,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr">ScreenMembersOnMfaPushEnrollmentQr</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaPushEnrollmentQr`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr)*/} -Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L25) +Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L25) #### Overrides @@ -87,7 +87,7 @@ Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:25](https://github.com <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -98,7 +98,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -109,7 +109,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -120,7 +120,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -132,7 +132,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='pickAuthenticator' type='Promise<void>'> {/*> **pickAuthenticator**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L30) +Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L30) Navigates to the authenticator selection screen. @@ -153,7 +153,7 @@ Optional custom options to include with the request <ParamField body='pollingManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> {/*> **pollingManager**(`options`): [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl)*/} -Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L32) +Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L32) <Expandable title="Parameters"> <ParamField body='options' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions">MfaPollingOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.mdx index d2fb5678f..50983406c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.mdx @@ -2,7 +2,7 @@ title: "MfaPushListMembers" --- -Defined in: [interfaces/screens/mfa-push-list.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L19) +Defined in: [interfaces/screens/mfa-push-list.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L19) Interface defining the available methods and properties for the mfa-push-list screen @@ -33,7 +33,7 @@ export interface MfaPushListMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -121,7 +121,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -133,7 +133,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='goBack' type='Promise<void>'> {/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-push-list.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L29) +Defined in: [interfaces/screens/mfa-push-list.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L29) Navigates back to the previous screen. @@ -154,7 +154,7 @@ Optional custom options to include with the request. <ParamField body='selectMfaPushDevice' type='Promise<void>'> {/*> **selectMfaPushDevice**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-push-list.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L24) +Defined in: [interfaces/screens/mfa-push-list.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L24) Selects a registered device from the list to initiate MFA push. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl.mdx index e55d2ba7d..8d1c94481 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl.mdx @@ -2,7 +2,7 @@ title: "MfaPushPollingControl" --- -Defined in: [interfaces/utils/polling-control.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L53) +Defined in: [interfaces/utils/polling-control.ts:53](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L53) Control interface for managing an MFA push-notification polling session. @@ -69,7 +69,7 @@ export interface MfaPushPollingControl { <ParamField body='Returns' type='unknown'>{/*> **isRunning**: () => `boolean`*/} -Defined in: [interfaces/utils/polling-control.ts:100](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L100) +Defined in: [interfaces/utils/polling-control.ts:100](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L100) Indicates whether the polling process is currently running. @@ -94,7 +94,7 @@ if (control.isRunning()) { <ParamField body='Returns' type='unknown'>{/*> **startPolling**: () => `void`*/} -Defined in: [interfaces/utils/polling-control.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L83) +Defined in: [interfaces/utils/polling-control.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L83) Starts or resumes the polling process. @@ -115,7 +115,7 @@ control.startPolling(); // Begin checking the MFA push challenge <ParamField body='Returns' type='unknown'>{/*> **stopPolling**: () => `void`*/} -Defined in: [interfaces/utils/polling-control.ts:70](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L70) +Defined in: [interfaces/utils/polling-control.ts:70](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L70) Stops the polling process immediately. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.mdx index 95699fa8b..8faf532b8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.mdx @@ -2,7 +2,7 @@ title: "MfaPushWelcomeMembers" --- -Defined in: [interfaces/screens/mfa-push-welcome.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L19) +Defined in: [interfaces/screens/mfa-push-welcome.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L19) <RequestExample> @@ -24,7 +24,7 @@ export interface MfaPushWelcomeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -35,7 +35,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -57,7 +57,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome">ScreenMembersOnMfaPushWelcome</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaPushWelcome`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome)*/} -Defined in: [interfaces/screens/mfa-push-welcome.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L20) +Defined in: [interfaces/screens/mfa-push-welcome.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L20) #### Overrides @@ -79,7 +79,7 @@ Defined in: [interfaces/screens/mfa-push-welcome.ts:20](https://github.com/auth0 <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -90,7 +90,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -101,7 +101,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -112,7 +112,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -124,7 +124,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='enroll' type='Promise<void>'> {/*> **enroll**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-push-welcome.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L21) +Defined in: [interfaces/screens/mfa-push-welcome.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L21) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -141,7 +141,7 @@ Defined in: [interfaces/screens/mfa-push-welcome.ts:21](https://github.com/auth0 <ParamField body='pickAuthenticator' type='Promise<void>'> {/*> **pickAuthenticator**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-push-welcome.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L22) +Defined in: [interfaces/screens/mfa-push-welcome.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L22) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx index 19c411986..19696c3c1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx @@ -2,7 +2,7 @@ title: "MfaRecoveryCodeChallengeContinueOptions" --- -Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L12) +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L12) Options for continuing with the MFA Recovery Code Challenge. @@ -28,5 +28,5 @@ export interface ContinueOptions extends CustomOptions { <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L13) +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L13) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.mdx index 6488b3958..3da00c661 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "MfaRecoveryCodeChallengeMembers" --- -Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L19) +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L19) Interface describing the members of the Mfa Recovery Code Challenge screen. @@ -42,7 +42,7 @@ export interface MfaRecoveryCodeChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -53,7 +53,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L20) +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L20) #### Overrides @@ -64,7 +64,7 @@ Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:20](https://githu <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L21) +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L21) #### Overrides @@ -75,7 +75,7 @@ Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:21](https://githu <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L22) +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L22) #### Overrides @@ -86,7 +86,7 @@ Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:22](https://githu <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L23) +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L23) #### Overrides @@ -97,7 +97,7 @@ Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:23](https://githu <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -108,7 +108,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L24) +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L24) #### Overrides @@ -119,7 +119,7 @@ Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:24](https://githu <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -130,7 +130,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -142,7 +142,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L31) +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L31) Continues with the provided recovery code. @@ -165,7 +165,7 @@ A promise that resolves when the continuation is successful. <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L38) +Defined in: [interfaces/screens/mfa-recovery-code-challenge.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge.ts#L38) Navigates to the screen where the user can pick another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx index 229a5b0ee..4c1187497 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx @@ -2,7 +2,7 @@ title: "MfaRecoveryCodeChallengeNewCodeContinueOptions" --- -Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L32) +Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L32) ContinueOptions diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx index 90dab4298..189221db7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx @@ -2,7 +2,7 @@ title: "MfaRecoveryCodeChallengeNewCodeMembers" --- -Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L44) +Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:44](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L44) MfaRecoveryCodeChallengeNewCodeMembers @@ -56,7 +56,7 @@ export interface MfaRecoveryCodeChallengeNewCodeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -67,7 +67,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -89,7 +89,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -100,7 +100,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode">ScreenMembersOnMfaRecoveryCodeChallengeNewCode</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaRecoveryCodeChallengeNewCode`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode)*/} -Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L50) +Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:50](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L50) Access to the specific properties and data of the 'mfa-recovery-code-challenge-new-code' screen. Includes the `textCode` which is the recovery code to be displayed. @@ -114,7 +114,7 @@ Includes the `textCode` which is the recovery code to be displayed. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -125,7 +125,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -136,7 +136,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -147,7 +147,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -159,7 +159,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:77](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L77) +Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:77](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L77) Confirms that the user has saved the new recovery code and continues the authentication flow. This method should be called after the user indicates they have securely stored the displayed recovery code. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx index 10d14ad99..a5561e898 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx @@ -2,7 +2,7 @@ title: "MfaRecoveryCodeEnrollmentContinueOptions" --- -Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L17) +Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L17) <RequestExample> @@ -26,5 +26,5 @@ export interface MfaRecoveryCodeEnrollmentContinueOptions extends CustomOptions <ParamField body='isCodeCopied' type='boolean'> {/*> **isCodeCopied**: `boolean`*/} -Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L18) +Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L18) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx index f303fd35b..f11a9e020 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx @@ -2,7 +2,7 @@ title: "MfaRecoveryCodeEnrollmentMembers" --- -Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L24) +Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L24) Interface describing the members of the Mfa Recovery Code Enrollment screen. @@ -36,7 +36,7 @@ export interface MfaRecoveryCodeEnrollmentMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -47,7 +47,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -58,7 +58,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -69,7 +69,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -80,7 +80,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment">ScreenMembersOnMfaRecoveryCodeEnrollment</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaRecoveryCodeEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment)*/} -Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L25) +Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L25) #### Overrides @@ -91,7 +91,7 @@ Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:25](https://gith <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -102,7 +102,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -113,7 +113,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -124,7 +124,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -136,7 +136,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L37) +Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L37) Declares that the user saved the recovery code. This action is triggered when the user declares that they have saved the recovery code. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.mdx index d3dafa03a..3b0e9a227 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "MfaSmsChallengeMembers" --- -Defined in: [interfaces/screens/mfa-sms-challenge.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L33) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L33) <RequestExample> @@ -33,7 +33,7 @@ export interface MfaSmsChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge">ScreenMembersOnMfaSmsChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge)*/} -Defined in: [interfaces/screens/mfa-sms-challenge.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L34) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L34) #### Overrides @@ -88,7 +88,7 @@ Defined in: [interfaces/screens/mfa-sms-challenge.ts:34](https://github.com/auth <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge">UntrustedDataMembersOnMfaSmsChallenge</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembersOnMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge)*/} -Defined in: [interfaces/screens/mfa-sms-challenge.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L35) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:35](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L35) #### Overrides @@ -121,7 +121,7 @@ Defined in: [interfaces/screens/mfa-sms-challenge.ts:35](https://github.com/auth <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -133,7 +133,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continueMfaSmsChallenge' type='Promise<void>'> {/*> **continueMfaSmsChallenge**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-sms-challenge.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L36) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L36) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions">MfaSmsChallengeOptions</a></span>}> @@ -150,7 +150,7 @@ Defined in: [interfaces/screens/mfa-sms-challenge.ts:36](https://github.com/auth <ParamField body='getACall' type='Promise<void>'> {/*> **getACall**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-sms-challenge.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L40) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L40) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -167,7 +167,7 @@ Defined in: [interfaces/screens/mfa-sms-challenge.ts:40](https://github.com/auth <ParamField body='pickSms' type='Promise<void>'> {/*> **pickSms**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-sms-challenge.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L37) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L37) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -184,7 +184,7 @@ Defined in: [interfaces/screens/mfa-sms-challenge.ts:37](https://github.com/auth <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-sms-challenge.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L38) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L38) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -201,7 +201,7 @@ Defined in: [interfaces/screens/mfa-sms-challenge.ts:38](https://github.com/auth <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [interfaces/screens/mfa-sms-challenge.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L45) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:45](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L45) Gets resend functionality with timeout management for this screen @@ -222,7 +222,7 @@ Configuration options for resend functionality <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-sms-challenge.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L39) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L39) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions.mdx index 00944066c..caf389ba2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions.mdx @@ -2,7 +2,7 @@ title: "MfaSmsChallengeOptions" --- -Defined in: [interfaces/screens/mfa-sms-challenge.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L7) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:7](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L7) <RequestExample> @@ -24,12 +24,12 @@ export interface MfaSmsChallengeOptions { <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/mfa-sms-challenge.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L8) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L8) </ParamField> <ParamField body='rememberDevice?' type='boolean'> {/*> `optional` **rememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/mfa-sms-challenge.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L9) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L9) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.mdx index 26b0be685..009ebaf80 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.mdx @@ -2,7 +2,7 @@ title: "MfaSmsEnrollmentMembers" --- -Defined in: [interfaces/screens/mfa-sms-enrollment.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L17) +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L17) <RequestExample> @@ -25,7 +25,7 @@ export interface MfaSmsEnrollmentMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -36,7 +36,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -47,7 +47,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -58,7 +58,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -69,7 +69,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment">ScreenMembersOnMfaSmsEnrollment</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaSmsEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment)*/} -Defined in: [interfaces/screens/mfa-sms-enrollment.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L18) +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L18) #### Overrides @@ -80,7 +80,7 @@ Defined in: [interfaces/screens/mfa-sms-enrollment.ts:18](https://github.com/aut <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -91,7 +91,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -102,7 +102,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -113,7 +113,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -125,7 +125,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continueEnrollment' type='Promise<void>'> {/*> **continueEnrollment**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-sms-enrollment.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L20) +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L20) <Expandable title="Parameters"> <ParamField body='payload' type='string'> @@ -148,7 +148,7 @@ Defined in: [interfaces/screens/mfa-sms-enrollment.ts:20](https://github.com/aut <ParamField body='pickCountryCode' type='Promise<void>'> {/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-sms-enrollment.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L19) +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L19) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -165,7 +165,7 @@ Defined in: [interfaces/screens/mfa-sms-enrollment.ts:19](https://github.com/aut <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-sms-enrollment.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L21) +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L21) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions.mdx index 369755a91..583f19677 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions.mdx @@ -2,7 +2,7 @@ title: "MfaSmsEnrollmentOptions" --- -Defined in: [interfaces/screens/mfa-sms-enrollment.ts:5](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L5) +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:5](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L5) <RequestExample> @@ -24,12 +24,12 @@ export interface MfaSmsEnrollmentOptions { <ParamField body='captcha?' type='string'> {/*> `optional` **captcha**: `string`*/} -Defined in: [interfaces/screens/mfa-sms-enrollment.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L7) +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:7](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L7) </ParamField> <ParamField body='phone?' type='string'> {/*> `optional` **phone**: `string`*/} -Defined in: [interfaces/screens/mfa-sms-enrollment.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L6) +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:6](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L6) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.mdx index 2b4d44b51..c352e5eb4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.mdx @@ -2,7 +2,7 @@ title: "MfaSmsListMembers" --- -Defined in: [interfaces/screens/mfa-sms-list.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts#L22) +Defined in: [interfaces/screens/mfa-sms-list.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts#L22) MfaSmsListMembers Interface defining the members and methods for the MfaSmsList class. @@ -37,7 +37,7 @@ export interface MfaSmsListMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -81,7 +81,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -103,7 +103,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -114,7 +114,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -125,7 +125,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -137,7 +137,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='backAction' type='Promise<void>'> {/*> **backAction**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-sms-list.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts#L35) +Defined in: [interfaces/screens/mfa-sms-list.ts:35](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts#L35) Navigates back to the previous screen. @@ -158,7 +158,7 @@ Optional payload for the action. <ParamField body='selectPhoneNumber' type='Promise<void>'> {/*> **selectPhoneNumber**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-sms-list.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts#L29) +Defined in: [interfaces/screens/mfa-sms-list.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts#L29) Selects a phone number from the list of enrolled phone numbers. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions.mdx index adcc6eea2..82004ce64 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions.mdx @@ -2,7 +2,7 @@ title: "MfaSmsListOptions" --- -Defined in: [interfaces/screens/mfa-sms-list.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts#L8) +Defined in: [interfaces/screens/mfa-sms-list.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts#L8) MfaSmsListOptions Options for performing actions on the mfa-sms-list screen. @@ -32,7 +32,7 @@ Any additional custom options <ParamField body='index' type='number'> {/*> **index**: `number`*/} -Defined in: [interfaces/screens/mfa-sms-list.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts#L12) +Defined in: [interfaces/screens/mfa-sms-list.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-list.ts#L12) #### Param diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions.mdx index 013a07a16..e338b9282 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions.mdx @@ -2,7 +2,7 @@ title: "MfaVoiceChallengeContinueOptions" --- -Defined in: [interfaces/screens/mfa-voice-challenge.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L10) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L10) Options for submitting the voice challenge code. @@ -39,7 +39,7 @@ Additional custom options to pass with the request. <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/mfa-voice-challenge.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L14) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L14) The verification code received via voice call. @@ -48,7 +48,7 @@ The verification code received via voice call. <ParamField body='rememberDevice?' type='boolean'> {/*> `optional` **rememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/mfa-voice-challenge.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L19) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L19) Optional flag to remember the device for 30 days, skipping future MFA challenges. </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.mdx index 84ff4d88f..2cd9a5aac 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "MfaVoiceChallengeMembers" --- -Defined in: [interfaces/screens/mfa-voice-challenge.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L55) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:55](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L55) Interface defining all members and operations available on the MFA Voice Challenge screen. @@ -108,7 +108,7 @@ export interface MfaVoiceChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -119,7 +119,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -130,7 +130,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -141,7 +141,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -152,7 +152,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge">ScreenMembersOnMfaVoiceChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge)*/} -Defined in: [interfaces/screens/mfa-voice-challenge.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L59) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:59](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L59) Screen-specific properties and data. @@ -165,7 +165,7 @@ Screen-specific properties and data. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -176,7 +176,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -187,7 +187,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge">UntrustedDataMembersOnMfaVoiceChallenge</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembersOnMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge)*/} -Defined in: [interfaces/screens/mfa-voice-challenge.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L61) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:61](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L61) #### Overrides @@ -198,7 +198,7 @@ Defined in: [interfaces/screens/mfa-voice-challenge.ts:61](https://github.com/au <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -210,7 +210,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-voice-challenge.ts:78](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L78) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:78](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L78) Submits the voice verification code to validate the MFA challenge. @@ -243,7 +243,7 @@ mfaVoiceChallenge.continue({ <ParamField body='pickPhone' type='Promise<void>'> {/*> **pickPhone**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-voice-challenge.ts:92](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L92) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:92](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L92) Navigates to the screen for selecting a different phone number. @@ -273,7 +273,7 @@ mfaVoiceChallenge.pickPhone(); <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-voice-challenge.ts:120](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L120) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:120](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L120) Requests a new voice call with a verification code. @@ -303,7 +303,7 @@ mfaVoiceChallenge.resendCode(); <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [interfaces/screens/mfa-voice-challenge.ts:140](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L140) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:140](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L140) Gets resend functionality with timeout management for this screen @@ -324,7 +324,7 @@ Configuration options for resend functionality <ParamField body='switchToSms' type='Promise<void>'> {/*> **switchToSms**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-voice-challenge.ts:106](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L106) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:106](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L106) Switches to SMS verification method instead of voice call. @@ -354,7 +354,7 @@ mfaVoiceChallenge.switchToSms(); <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-voice-challenge.ts:134](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L134) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:134](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L134) Navigates to the screen for selecting an alternative MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions.mdx index eb238ab6e..dbcde6eac 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions.mdx @@ -2,7 +2,7 @@ title: "MfaVoiceEnrollmentContinueOptions" --- -Defined in: [interfaces/screens/mfa-voice-enrollment.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L12) +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L12) Payload for continuing the MFA Voice Enrollment flow. @@ -28,5 +28,5 @@ export interface ContinueOptions extends CustomOptions { <ParamField body='phone' type='string'> {/*> **phone**: `string`*/} -Defined in: [interfaces/screens/mfa-voice-enrollment.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L13) +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L13) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.mdx index 82448f373..179b528b7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.mdx @@ -2,7 +2,7 @@ title: "MfaVoiceEnrollmentMembers" --- -Defined in: [interfaces/screens/mfa-voice-enrollment.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L19) +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L19) Interface describing the members of the Mfa Voice Enrollment screen. @@ -49,7 +49,7 @@ export interface MfaVoiceEnrollmentMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -60,7 +60,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/screens/mfa-voice-enrollment.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L20) +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L20) #### Overrides @@ -71,7 +71,7 @@ Defined in: [interfaces/screens/mfa-voice-enrollment.ts:20](https://github.com/a <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/screens/mfa-voice-enrollment.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L21) +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L21) #### Overrides @@ -82,7 +82,7 @@ Defined in: [interfaces/screens/mfa-voice-enrollment.ts:21](https://github.com/a <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/screens/mfa-voice-enrollment.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L22) +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L22) #### Overrides @@ -93,7 +93,7 @@ Defined in: [interfaces/screens/mfa-voice-enrollment.ts:22](https://github.com/a <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/screens/mfa-voice-enrollment.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L23) +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L23) #### Overrides @@ -104,7 +104,7 @@ Defined in: [interfaces/screens/mfa-voice-enrollment.ts:23](https://github.com/a <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -115,7 +115,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/screens/mfa-voice-enrollment.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L24) +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L24) #### Overrides @@ -126,7 +126,7 @@ Defined in: [interfaces/screens/mfa-voice-enrollment.ts:24](https://github.com/a <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -137,7 +137,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -149,7 +149,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-voice-enrollment.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L31) +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L31) Continues with the voice enrollment process. @@ -172,7 +172,7 @@ Promise that resolves when enrollment continues. <ParamField body='selectPhoneCountryCode' type='Promise<void>'> {/*> **selectPhoneCountryCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-voice-enrollment.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L45) +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:45](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L45) Allows picking a country code for the phone number. @@ -195,7 +195,7 @@ Promise that resolves when the country code is selected. <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-voice-enrollment.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L38) +Defined in: [interfaces/screens/mfa-voice-enrollment.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-enrollment.ts#L38) Allows trying another authentication method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx index 0f6a3d538..da543e16f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx @@ -2,7 +2,7 @@ title: "MfaWebAuthnChangeKeyNicknameContinueOptions" --- -Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L43) +Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L43) ContinueOptions @@ -36,7 +36,7 @@ export interface ContinueOptions extends CustomOptions { <ParamField body='nickname' type='string'> {/*> **nickname**: `string`*/} -Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L52) +Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:52](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L52) The new nickname for the WebAuthn security key. This is the value entered by the user in the input field. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx index 77866f86b..e4fff183a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx @@ -2,7 +2,7 @@ title: "MfaWebAuthnChangeKeyNicknameMembers" --- -Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:70](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L70) +Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:70](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L70) MfaWebAuthnChangeKeyNicknameMembers @@ -72,7 +72,7 @@ export interface MfaWebAuthnChangeKeyNicknameMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -83,7 +83,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -116,7 +116,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname">ScreenMembersOnMfaWebAuthnChangeKeyNickname</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaWebAuthnChangeKeyNickname`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname)*/} -Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:74](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L74) +Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:74](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L74) The screen object with MFA WebAuthn Change Key Nickname specific data structure. @@ -129,7 +129,7 @@ The screen object with MFA WebAuthn Change Key Nickname specific data structure. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -140,7 +140,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -151,7 +151,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -162,7 +162,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -174,7 +174,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continueWithNewNickname' type='Promise<void>'> {/*> **continueWithNewNickname**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:119](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L119) +Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:119](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L119) Submits the new nickname for the WebAuthn security key. This action corresponds to the user entering a new nickname and clicking a "Save" or "Continue" button. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx index e4e87bfea..bb5cdf277 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx @@ -2,7 +2,7 @@ title: "MfaWebAuthnEnrollmentSuccessMembers" --- -Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L58) +Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L58) MfaWebAuthnEnrollmentSuccessMembers @@ -53,7 +53,7 @@ export interface MfaWebAuthnEnrollmentSuccessMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -64,7 +64,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -75,7 +75,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -97,7 +97,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess">ScreenMembersOnMfaWebAuthnEnrollmentSuccess</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaWebAuthnEnrollmentSuccess`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess)*/} -Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L64) +Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:64](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L64) Access to the specific properties and data of the 'mfa-webauthn-enrollment-success' screen. Includes the `nickname` of the enrolled authenticator and its `webauthnType`. @@ -111,7 +111,7 @@ Includes the `nickname` of the enrolled authenticator and its `webauthnType`. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -122,7 +122,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -133,7 +133,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -144,7 +144,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -156,7 +156,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L88) +Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L88) Allows the user to continue the authentication flow after successful WebAuthn enrollment. This method sends a POST request to the `/u/mfa-webauthn-enrollment-success` endpoint with `action: "default"`. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.mdx index fc0980e3a..9994d089f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.mdx @@ -2,7 +2,7 @@ title: "MfaWebAuthnErrorMembers" --- -Defined in: [interfaces/screens/mfa-webauthn-error.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L46) +Defined in: [interfaces/screens/mfa-webauthn-error.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L46) MfaWebAuthnErrorMembers @@ -87,7 +87,7 @@ export interface MfaWebAuthnErrorMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -98,7 +98,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -109,7 +109,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -120,7 +120,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -131,7 +131,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError">ScreenMembersOnMfaWebAuthnError</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaWebAuthnError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError)*/} -Defined in: [interfaces/screens/mfa-webauthn-error.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L50) +Defined in: [interfaces/screens/mfa-webauthn-error.ts:50](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L50) The screen object with MFA WebAuthn Error specific data structure. @@ -144,7 +144,7 @@ The screen object with MFA WebAuthn Error specific data structure. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -155,7 +155,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -166,7 +166,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -177,7 +177,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -189,7 +189,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='noThanks' type='Promise<void>'> {/*> **noThanks**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-error.ts:110](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L110) +Defined in: [interfaces/screens/mfa-webauthn-error.ts:110](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L110) Allows the user to refuse adding a device or completing the WebAuthn step, effectively declining the current WebAuthn flow. This action is typically used in enrollment scenarios where the user decides not to proceed. @@ -224,7 +224,7 @@ await sdk.noThanks(); <ParamField body='tryAgain' type='Promise<void>'> {/*> **tryAgain**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-error.ts:65](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L65) +Defined in: [interfaces/screens/mfa-webauthn-error.ts:65](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L65) Allows the user to attempt the previous WebAuthn operation again. This typically redirects the user back to the screen where the WebAuthn operation was initiated. @@ -259,7 +259,7 @@ await sdk.tryAgain(); <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-error.ts:95](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L95) +Defined in: [interfaces/screens/mfa-webauthn-error.ts:95](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L95) Allows the user to select a different MFA method if other factors are enrolled or available. This navigates the user to an authenticator selection screen. @@ -294,7 +294,7 @@ await sdk.tryAnotherMethod(); <ParamField body='usePassword' type='Promise<void>'> {/*> **usePassword**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-error.ts:80](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L80) +Defined in: [interfaces/screens/mfa-webauthn-error.ts:80](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L80) Allows the user to opt for password-based authentication as an alternative, if configured. This is typically available if the primary authentication or a previous step involved a password. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx index 7146b923e..5c6ccacf9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx @@ -2,7 +2,7 @@ title: "MfaWebAuthnNotAvailableErrorMembers" --- -Defined in: [interfaces/screens/mfa-webauthn-not-available-error.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-not-available-error.ts#L14) +Defined in: [interfaces/screens/mfa-webauthn-not-available-error.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-not-available-error.ts#L14) MfaWebAuthnNotAvailableErrorMembers @@ -44,7 +44,7 @@ export interface MfaWebAuthnNotAvailableErrorMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -121,7 +121,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -132,7 +132,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -144,7 +144,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-not-available-error.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-not-available-error.ts#L35) +Defined in: [interfaces/screens/mfa-webauthn-not-available-error.ts:35](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-not-available-error.ts#L35) Allows the user to select a different MFA method because WebAuthn is not available. This action navigates the user to an authenticator selection screen where they can choose diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx index fa85a6986..d52811e5c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "MfaWebAuthnPlatformChallengeMembers" --- -Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:80](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L80) +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:80](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L80) MfaWebAuthnPlatformChallengeMembers @@ -113,7 +113,7 @@ export interface MfaWebAuthnPlatformChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -124,7 +124,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -135,7 +135,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -146,7 +146,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -157,7 +157,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge">ScreenMembersOnMfaWebAuthnPlatformChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge)*/} -Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L85) +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L85) Screen-specific properties and data, including WebAuthn challenge options and remember device preference. @@ -170,7 +170,7 @@ Screen-specific properties and data, including WebAuthn challenge options and re <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -181,7 +181,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -192,7 +192,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -203,7 +203,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -215,7 +215,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='reportBrowserError' type='Promise<void>'> {/*> **reportBrowserError**(`options`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:148](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L148) +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:148](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L148) Reports a specific WebAuthn API error (from `navigator.credentials.get()`) to Auth0. This method should be used when `verify()` (or a manual `navigator.credentials.get()` call) fails due to @@ -261,7 +261,7 @@ try { <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L170) +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:170](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L170) Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate @@ -302,7 +302,7 @@ try { <ParamField body='verify' type='Promise<void>'> {/*> **verify**(`options?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:121](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L121) +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:121](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L121) Initiates the WebAuthn platform authenticator challenge. This method internally calls `navigator.credentials.get()` using the challenge options diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx index 0e79a05b1..964239f6f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions.mdx @@ -2,7 +2,7 @@ title: "MfaWebAuthnPlatformChallengeReportErrorOptions" --- -Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L56) +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:56](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L56) ReportBrowserErrorOptions @@ -25,7 +25,7 @@ export interface ReportBrowserErrorOptions { <ParamField body='error' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>}> {/*> **error**: [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails)*/} -Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:62](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L62) +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:62](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L62) The error object from the WebAuthn API (`navigator.credentials.get()`) to be reported. </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx index b66a65ee1..116db9aef 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx @@ -2,7 +2,7 @@ title: "MfaWebAuthnPlatformChallengeTryAnotherMethodOptions" --- -Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:72](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L72) +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:72](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L72) TryAnotherMethodOptions diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx index 6966a04d1..2fae0d0a1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx @@ -2,7 +2,7 @@ title: "MfaWebAuthnPlatformEnrollmentMembers" --- -Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L55) +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:55](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L55) MfaWebAuthnPlatformEnrollmentMembers @@ -74,7 +74,7 @@ export interface MfaWebAuthnPlatformEnrollmentMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -85,7 +85,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -96,7 +96,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -107,7 +107,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -118,7 +118,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment">ScreenMembersOnMfaWebAuthnPlatformEnrollment</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaWebAuthnPlatformEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment)*/} -Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L59) +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:59](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L59) The screen object with MFA WebAuthn Platform Enrollment specific data structure. @@ -131,7 +131,7 @@ The screen object with MFA WebAuthn Platform Enrollment specific data structure. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -142,7 +142,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -153,7 +153,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -164,7 +164,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -176,7 +176,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='refuseEnrollmentOnThisDevice' type='Promise<void>'> {/*> **refuseEnrollmentOnThisDevice**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:140](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L140) +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:140](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L140) Allows the user to refuse WebAuthn platform enrollment on the current device. This action indicates the user does not want to use a platform authenticator on this specific device. @@ -211,7 +211,7 @@ await sdk.refuseEnrollmentOnThisDevice(); <ParamField body='reportBrowserError' type='Promise<void>'> {/*> **reportBrowserError**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:110](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L110) +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:110](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L110) Reports a browser-side error encountered during the WebAuthn `navigator.credentials.create()` operation. This method sends the error details to the server. @@ -252,7 +252,7 @@ Throws an error if the submission fails. <ParamField body='snoozeEnrollment' type='Promise<void>'> {/*> **snoozeEnrollment**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:125](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L125) +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:125](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L125) Allows the user to snooze or postpone the WebAuthn platform enrollment. This action typically means the user will be reminded to enroll at a later time. @@ -287,7 +287,7 @@ await sdk.snoozeEnrollment(); <ParamField body='submitPasskeyCredential' type='Promise<void>'> {/*> **submitPasskeyCredential**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L89) +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L89) Initiates the WebAuthn platform credential creation process using the public key options available on `this.screen.publicKey` and submits the resulting credential to the server. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx index 45df59f79..a6337fd8f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "MfaWebAuthnRoamingChallengeMembers" --- -Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L60) +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L60) MfaWebAuthnRoamingChallengeMembers @@ -106,7 +106,7 @@ export interface MfaWebAuthnRoamingChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -117,7 +117,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -128,7 +128,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -139,7 +139,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -150,7 +150,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge">ScreenMembersOnMfaWebAuthnRoamingChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge)*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:65](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L65) +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:65](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L65) Screen-specific properties and data, including WebAuthn challenge options. @@ -163,7 +163,7 @@ Screen-specific properties and data, including WebAuthn challenge options. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -174,7 +174,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -185,7 +185,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -196,7 +196,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -208,7 +208,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='reportWebAuthnError' type='Promise<void>'> {/*> **reportWebAuthnError**(`options`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:121](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L121) +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:121](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L121) Reports a specific WebAuthn API error to Auth0. This method should be used if `navigator.credentials.get()` fails in a way that @@ -254,7 +254,7 @@ try { <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:143](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L143) +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:143](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L143) Allows the user to opt-out of the WebAuthn challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate @@ -295,7 +295,7 @@ try { <ParamField body='verify' type='Promise<void>'> {/*> **verify**(`options?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:94](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L94) +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:94](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L94) Initiates the WebAuthn challenge by calling `navigator.credentials.get()` with the options provided in `screen.data.publicKeyChallengeOptions`. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx index 47d3ac971..cdb2ad09f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions.mdx @@ -2,7 +2,7 @@ title: "MfaWebAuthnRoamingChallengeReportErrorOptions" --- -Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L42) +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L42) ReportWebAuthnErrorOptions @@ -20,7 +20,7 @@ export interface ReportWebAuthnErrorOptions { <ParamField body='error' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>}> {/*> **error**: [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails)*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L43) +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L43) The error object from the WebAuthn API to be reported. </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx index 3fd6f2d9b..d5876b845 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx @@ -2,7 +2,7 @@ title: "MfaWebAuthnRoamingChallengeTryAnotherMethodOptions" --- -Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L52) +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:52](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L52) TryAnotherMethodOptions diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx index bed09ed10..583f45e0f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx @@ -2,7 +2,7 @@ title: "MfaWebAuthnRoamingEnrollmentMembers" --- -Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L36) +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L36) Interface defining the available methods and properties for the mfa-webauthn-roaming-enrollment screen. @@ -84,7 +84,7 @@ export interface MfaWebAuthnRoamingEnrollmentMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -95,7 +95,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -106,7 +106,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -117,7 +117,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -128,7 +128,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment">ScreenMembersOnMfaWebAuthnRoamingEnrollment</a></span>}> {/*> **screen**: [`ScreenMembersOnMfaWebAuthnRoamingEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment)*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L37) +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L37) #### Overrides @@ -139,7 +139,7 @@ Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:37](https://g <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -150,7 +150,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -161,7 +161,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -172,7 +172,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -184,7 +184,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='enroll' type='Promise<void>'> {/*> **enroll**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L60) +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L60) Initiates the WebAuthn credential creation and submits the result to the server. This corresponds to the user interacting with the FIDO Security Keys prompt. @@ -225,7 +225,7 @@ try { <ParamField body='showError' type='Promise<void>'> {/*> **showError**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L84) +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L84) Submits details about a WebAuthn browser error to the server. This is used when the browser's WebAuthn API encounters an error. @@ -267,7 +267,7 @@ const handleError = async (error: any) => { <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:97](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L97) +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:97](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L97) Allows the user to try another MFA method. This corresponds to the "Try Another Method" button. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx index 1c9ff95bc..fab02f4ad 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions.mdx @@ -2,7 +2,7 @@ title: "MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions" --- -Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L27) +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L27) Options for trying another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers.mdx index 625585c62..cb42a92c4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers.mdx @@ -2,7 +2,7 @@ title: "OrganizationMembers" --- -Defined in: [interfaces/models/organization.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L26) +Defined in: [interfaces/models/organization.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L26) <RequestExample> @@ -23,40 +23,40 @@ export interface OrganizationMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding">Branding</a></span>}> {/*> **branding**: [`Branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding) \| `null`*/} -Defined in: [interfaces/models/organization.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L31) +Defined in: [interfaces/models/organization.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L31) </ParamField> <ParamField body='displayName' type='string'> {/*> **displayName**: `string` \| `null`*/} -Defined in: [interfaces/models/organization.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L30) +Defined in: [interfaces/models/organization.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L30) </ParamField> <ParamField body='id' type='string'> {/*> **id**: `string` \| `null`*/} -Defined in: [interfaces/models/organization.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L27) +Defined in: [interfaces/models/organization.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L27) </ParamField> <ParamField body='metadata' type='key'> {/*> **metadata**: \{\[`key`: `string`\]: `string`; \} \| `null`*/} -Defined in: [interfaces/models/organization.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L32) +Defined in: [interfaces/models/organization.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L32) </ParamField> <ParamField body='name' type='string'> {/*> **name**: `string` \| `null`*/} -Defined in: [interfaces/models/organization.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L28) +Defined in: [interfaces/models/organization.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L28) </ParamField> <ParamField body='usage' type='string'> {/*> **usage**: `string` \| `null`*/} -Defined in: [interfaces/models/organization.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/organization.ts#L29) +Defined in: [interfaces/models/organization.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L29) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.mdx index d7ed3dc92..6024c1ade 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.mdx @@ -2,7 +2,7 @@ title: "OrganizationPickerMembers" --- -Defined in: [interfaces/screens/organization-picker.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L12) +Defined in: [interfaces/screens/organization-picker.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L12) Interface defining the available methods and properties for the organization-picker screen @@ -34,7 +34,7 @@ export interface OrganizationPickerMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -45,7 +45,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -56,7 +56,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -67,7 +67,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) #### Inherited from @@ -89,7 +89,7 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -100,7 +100,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -111,7 +111,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -122,7 +122,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -134,7 +134,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='selectOrganization' type='Promise<void>'> {/*> **selectOrganization**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/organization-picker.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L17) +Defined in: [interfaces/screens/organization-picker.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L17) Selects an organization for the user. @@ -161,7 +161,7 @@ The options containing the organization ID. <ParamField body='skipOrganizationSelection' type='Promise<void>'> {/*> **skipOrganizationSelection**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/organization-picker.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L23) +Defined in: [interfaces/screens/organization-picker.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L23) Skips the organization selection, proceeding with the user's personal account. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.mdx index 713f1194e..ff38ab51c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.mdx @@ -2,7 +2,7 @@ title: "OrganizationSelectionMembers" --- -Defined in: [interfaces/screens/organization-selection.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L38) +Defined in: [interfaces/screens/organization-selection.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L38) Interface defining the available methods and properties for the organization-selection screen. @@ -32,7 +32,7 @@ export interface OrganizationSelectionMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -43,7 +43,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -54,7 +54,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -65,7 +65,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -76,7 +76,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection">ScreenMembersOnOrganizationSelection</a></span>}> {/*> **screen**: [`ScreenMembersOnOrganizationSelection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection)*/} -Defined in: [interfaces/screens/organization-selection.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L42) +Defined in: [interfaces/screens/organization-selection.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L42) The screen properties. @@ -89,7 +89,7 @@ The screen properties. <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -100,7 +100,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -111,7 +111,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -122,7 +122,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -134,7 +134,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continueWithOrganizationName' type='Promise<void>'> {/*> **continueWithOrganizationName**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/organization-selection.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L47) +Defined in: [interfaces/screens/organization-selection.ts:47](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L47) Continues with the selected organization name. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Organizations.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Organizations.mdx index a82efe1ca..cf83ce997 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Organizations.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Organizations.mdx @@ -2,7 +2,7 @@ title: "Organizations" --- -Defined in: [interfaces/models/user.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L32) +Defined in: [interfaces/models/user.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L32) <RequestExample> @@ -21,26 +21,26 @@ export interface Organizations { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding">Branding</a></span>}> {/*> **branding**: [`Branding`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding)*/} -Defined in: [interfaces/models/user.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L36) +Defined in: [interfaces/models/user.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L36) </ParamField> <ParamField body='displayName' type='string'> {/*> **displayName**: `string` \| `undefined`*/} -Defined in: [interfaces/models/user.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L35) +Defined in: [interfaces/models/user.ts:35](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L35) </ParamField> <ParamField body='organizationId' type='string'> {/*> **organizationId**: `string` \| `undefined`*/} -Defined in: [interfaces/models/user.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L33) +Defined in: [interfaces/models/user.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L33) </ParamField> <ParamField body='organizationName' type='string'> {/*> **organizationName**: `string` \| `undefined`*/} -Defined in: [interfaces/models/user.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L34) +Defined in: [interfaces/models/user.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L34) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions.mdx index 6ef93b0f3..c580bb327 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions.mdx @@ -2,7 +2,7 @@ title: "OtpCodeOptions" --- -Defined in: [interfaces/screens/email-otp-challenge.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L14) +Defined in: [interfaces/screens/email-otp-challenge.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L14) <RequestExample> @@ -29,7 +29,7 @@ export interface OtpCodeOptions extends CustomOptions { <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/email-otp-challenge.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L18) +Defined in: [interfaces/screens/email-otp-challenge.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L18) The OTP code that the user enters to submit. </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate.mdx index 57a7fd883..dde238082 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate.mdx @@ -2,7 +2,7 @@ title: "PasskeyCreate" --- -Defined in: [interfaces/models/screen.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L23) +Defined in: [interfaces/models/screen.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L23) <RequestExample> @@ -37,59 +37,60 @@ export interface PasskeyCreate { ## Properties -<ParamField body='public_key' type='object'> -{/*> **public_key**: `object`*/} +### public\_key -Defined in: [interfaces/models/screen.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L24) +> **public\_key**: `object` -<Expandable title="Properties"> -<ParamField body='authenticatorSelection' type='object'> +Defined in: [interfaces/models/screen.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L24) + +<<ParamField body='authenticatorSelection' type='object'> {/*> **authenticatorSelection**: `object`*/} -<Expandable title="Properties"> -<ParamField body='authenticatorSelection.authenticatorAttachment?' type='string'> +##### authenticatorSelection.authenticatorAttachment? + {/*> `optional` **authenticatorAttachment**: `string`*/} -</ParamField> -<ParamField body='authenticatorSelection.residentKey' type='string'> + +##### authenticatorSelection.residentKey + {/*> **residentKey**: `string`*/} -</ParamField> -<ParamField body='authenticatorSelection.userVerification' type='string'> + +##### authenticatorSelection.userVerification + {/*> **userVerification**: `string`*/} -</ParamField> -</Expandable> -</ParamField> -<ParamField body='challenge' type='object'> + +#### challenge + {/*> **challenge**: `string`*/} -</ParamField> -<ParamField body='pubKeyCredParams' type='object'> -{/*> **pubKeyCredParams**: `[{ alg: number; type: string; }]`*/} -</ParamField> -<ParamField body='rp' type='object'> + +#### pubKeyCredParams + +{/*> **pubKeyCredParams**: \[\{ `alg`: `number`; `type`: `string`; \}\]*/} + +#### rp + {/*> **rp**: `object`*/} -<Expandable title="Properties"> -<ParamField body='rp.id' type='string'> +##### rp.id + {/*> **id**: `string`*/} -</ParamField> -<ParamField body='rp.name' type='string'> + +##### rp.name + {/*> **name**: `string`*/} -</ParamField> -</Expandable> -</ParamField> -<ParamField body='user' type='object'> + +#### user + {/*> **user**: `object`*/} -<Expandable title="Properties"> -<ParamField body='user.displayName' type='string'> +##### user.displayName + {/*> **displayName**: `string`*/} -</ParamField> -<ParamField body='user.id' type='string'> + +##### user.id + {/*> **id**: `string`*/} -</ParamField> -<ParamField body='user.name' type='string'> + +##### user.name + {/*> **name**: `string`*/} -</ParamField> -</Expandable> -</ParamField> -</Expandable> </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreateResponse.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreateResponse.mdx index 915c208f0..8046f3757 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreateResponse.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreateResponse.mdx @@ -2,7 +2,7 @@ title: "PasskeyCreateResponse" --- -Defined in: [interfaces/utils/passkeys.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L21) +Defined in: [interfaces/utils/passkeys.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L21) <RequestExample> @@ -22,33 +22,33 @@ export interface PasskeyCreateResponse { <ParamField body='authenticatorAttachment' type='string'> {/*> **authenticatorAttachment**: `string` \| `null`*/} -Defined in: [interfaces/utils/passkeys.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L25) +Defined in: [interfaces/utils/passkeys.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L25) </ParamField> <ParamField body='id' type='string'> {/*> **id**: `string`*/} -Defined in: [interfaces/utils/passkeys.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L22) +Defined in: [interfaces/utils/passkeys.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L22) </ParamField> <ParamField body='rawId' type='string'> {/*> **rawId**: `string` \| `null`*/} -Defined in: [interfaces/utils/passkeys.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L23) +Defined in: [interfaces/utils/passkeys.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L23) </ParamField> <ParamField body='response' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse">CredentialResponse</a></span>}> {/*> **response**: [`CredentialResponse`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse)*/} -Defined in: [interfaces/utils/passkeys.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L26) +Defined in: [interfaces/utils/passkeys.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L26) </ParamField> <ParamField body='type' type='string'> {/*> **type**: `string`*/} -Defined in: [interfaces/utils/passkeys.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L24) +Defined in: [interfaces/utils/passkeys.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L24) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.mdx index 58c2cdf64..574518a31 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.mdx @@ -2,7 +2,7 @@ title: "PasskeyEnrollmentLocalMembers" --- -Defined in: [interfaces/screens/passkey-enrollment-local.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L28) +Defined in: [interfaces/screens/passkey-enrollment-local.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L28) <RequestExample> @@ -24,7 +24,7 @@ export interface PasskeyEnrollmentLocalMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -35,7 +35,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -57,7 +57,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal">ScreenMembersOnPasskeyEnrollmentLocal</a></span>}> {/*> **screen**: [`ScreenMembersOnPasskeyEnrollmentLocal`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal)*/} -Defined in: [interfaces/screens/passkey-enrollment-local.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L29) +Defined in: [interfaces/screens/passkey-enrollment-local.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L29) #### Overrides @@ -79,7 +79,7 @@ Defined in: [interfaces/screens/passkey-enrollment-local.ts:29](https://github.c <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -90,7 +90,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -101,7 +101,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -112,7 +112,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -124,7 +124,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='abortPasskeyEnrollment' type='Promise<void>'> {/*> **abortPasskeyEnrollment**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/passkey-enrollment-local.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L31) +Defined in: [interfaces/screens/passkey-enrollment-local.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L31) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions">AbortEnrollmentOptions</a></span>}> @@ -141,7 +141,7 @@ Defined in: [interfaces/screens/passkey-enrollment-local.ts:31](https://github.c <ParamField body='continuePasskeyEnrollment' type='Promise<void>'> {/*> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/passkey-enrollment-local.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L30) +Defined in: [interfaces/screens/passkey-enrollment-local.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L30) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.mdx index 4181c7371..8e1140c23 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.mdx @@ -2,7 +2,7 @@ title: "PasskeyEnrollmentMembers" --- -Defined in: [interfaces/screens/passkey-enrollment.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L25) +Defined in: [interfaces/screens/passkey-enrollment.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L25) <RequestExample> @@ -24,7 +24,7 @@ export interface PasskeyEnrollmentMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -35,7 +35,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -57,7 +57,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment">ScreenMembersOnPasskeyEnrollment</a></span>}> {/*> **screen**: [`ScreenMembersOnPasskeyEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment)*/} -Defined in: [interfaces/screens/passkey-enrollment.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L26) +Defined in: [interfaces/screens/passkey-enrollment.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L26) #### Overrides @@ -79,7 +79,7 @@ Defined in: [interfaces/screens/passkey-enrollment.ts:26](https://github.com/aut <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -90,7 +90,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -101,7 +101,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -112,7 +112,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -124,7 +124,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='abortPasskeyEnrollment' type='Promise<void>'> {/*> **abortPasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/passkey-enrollment.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L28) +Defined in: [interfaces/screens/passkey-enrollment.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L28) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -141,7 +141,7 @@ Defined in: [interfaces/screens/passkey-enrollment.ts:28](https://github.com/aut <ParamField body='continuePasskeyEnrollment' type='Promise<void>'> {/*> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/passkey-enrollment.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L27) +Defined in: [interfaces/screens/passkey-enrollment.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L27) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule.mdx index dd433c060..cffee3964 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule.mdx @@ -2,7 +2,7 @@ title: "PasswordComplexityRule" --- -Defined in: [interfaces/models/transaction.ts:136](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L136) +Defined in: [interfaces/models/transaction.ts:136](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L136) <RequestExample> @@ -27,7 +27,7 @@ export interface PasswordComplexityRule { <ParamField body='args?' type='object'> {/*> `optional` **args**: `object`*/} -Defined in: [interfaces/models/transaction.ts:141](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L141) +Defined in: [interfaces/models/transaction.ts:141](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L141) #### count @@ -46,33 +46,33 @@ Defined in: [interfaces/models/transaction.ts:141](https://github.com/auth0/univ <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/models/transaction.ts:137](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L137) +Defined in: [interfaces/models/transaction.ts:137](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L137) </ParamField> <ParamField body='isValid' type='boolean'> {/*> **isValid**: `boolean`*/} -Defined in: [interfaces/models/transaction.ts:140](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L140) +Defined in: [interfaces/models/transaction.ts:140](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L140) </ParamField> <ParamField body='items?' type='PasswordComplexityRule'> {/*> `optional` **items**: `PasswordComplexityRule`[]*/} -Defined in: [interfaces/models/transaction.ts:146](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L146) +Defined in: [interfaces/models/transaction.ts:146](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L146) </ParamField> <ParamField body='label' type='string'> {/*> **label**: `string`*/} -Defined in: [interfaces/models/transaction.ts:138](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L138) +Defined in: [interfaces/models/transaction.ts:138](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L138) </ParamField> <ParamField body='status' type='"valid"'> {/*> **status**: `"valid"` \| `"error"`*/} -Defined in: [interfaces/models/transaction.ts:139](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L139) +Defined in: [interfaces/models/transaction.ts:139](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L139) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy.mdx index 32fe54d2a..1ec793e56 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy.mdx @@ -2,7 +2,7 @@ title: "PasswordPolicy" --- -Defined in: [interfaces/models/transaction.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L57) +Defined in: [interfaces/models/transaction.ts:57](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L57) <RequestExample> @@ -21,26 +21,26 @@ export interface PasswordPolicy { <ParamField body='enabled?' type='boolean'> {/*> `optional` **enabled**: `boolean`*/} -Defined in: [interfaces/models/transaction.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L58) +Defined in: [interfaces/models/transaction.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L58) </ParamField> <ParamField body='minLength?' type='number'> {/*> `optional` **minLength**: `number`*/} -Defined in: [interfaces/models/transaction.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L59) +Defined in: [interfaces/models/transaction.ts:59](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L59) </ParamField> <ParamField body='passwordSecurityInfo?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule">PasswordComplexityRule</a></span>}> {/*> `optional` **passwordSecurityInfo**: [`PasswordComplexityRule`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule)[]*/} -Defined in: [interfaces/models/transaction.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L61) +Defined in: [interfaces/models/transaction.ts:61](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L61) </ParamField> <ParamField body='policy' type='"none"'> {/*> **policy**: `"none"` \| `"low"` \| `"fair"` \| `"good"` \| `"excellent"`*/} -Defined in: [interfaces/models/transaction.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L60) +Defined in: [interfaces/models/transaction.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L60) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult.mdx index dfad198ab..847ea73fa 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult.mdx @@ -2,7 +2,7 @@ title: "PasswordValidationResult" --- -Defined in: [interfaces/utils/validate-password.ts:2](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-password.ts#L2) +Defined in: [interfaces/utils/validate-password.ts:2](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/validate-password.ts#L2) <RequestExample> @@ -32,7 +32,7 @@ export interface PasswordValidationResult { <ParamField body='isValid' type='boolean'> {/*> **isValid**: `boolean`*/} -Defined in: [interfaces/utils/validate-password.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-password.ts#L8) +Defined in: [interfaces/utils/validate-password.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/validate-password.ts#L8) Overall outcome of all password policy checks. @@ -43,7 +43,7 @@ Overall outcome of all password policy checks. <ParamField body='results' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule">PasswordComplexityRule</a></span>}> {/*> **results**: [`PasswordComplexityRule`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule)[]*/} -Defined in: [interfaces/utils/validate-password.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-password.ts#L17) +Defined in: [interfaces/utils/validate-password.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/validate-password.ts#L17) Array of evaluated password rules. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions.mdx index 72f088d95..8237a8d34 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions.mdx @@ -2,7 +2,7 @@ title: "PhoneChallengeOptions" --- -Defined in: [interfaces/screens/phone-identifier-challenge.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L6) +Defined in: [interfaces/screens/phone-identifier-challenge.ts:6](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L6) <RequestExample> @@ -24,12 +24,12 @@ export interface PhoneChallengeOptions { <ParamField body='captcha?' type='string'> {/*> `optional` **captcha**: `string`*/} -Defined in: [interfaces/screens/phone-identifier-challenge.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L8) +Defined in: [interfaces/screens/phone-identifier-challenge.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L8) </ParamField> <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/phone-identifier-challenge.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L7) +Defined in: [interfaces/screens/phone-identifier-challenge.ts:7](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L7) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions.mdx index b41cff20d..42d7e590b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions.mdx @@ -2,7 +2,7 @@ title: "PhoneEnrollmentOptions" --- -Defined in: [interfaces/screens/phone-identifier-enrollment.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L18) +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L18) <RequestExample> @@ -23,5 +23,5 @@ export interface PhoneEnrollmentOptions { <ParamField body='type' type='"voice"'> {/*> **type**: `"voice"` \| `"text"`*/} -Defined in: [interfaces/screens/phone-identifier-enrollment.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L19) +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L19) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.mdx index 2bc53c5f4..0d3cec534 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "PhoneIdentifierChallengeMembers" --- -Defined in: [interfaces/screens/phone-identifier-challenge.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L36) +Defined in: [interfaces/screens/phone-identifier-challenge.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L36) <RequestExample> @@ -28,7 +28,7 @@ export interface PhoneIdentifierChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -39,7 +39,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -50,7 +50,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge">ScreenMembersOnPhoneIdentifierChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnPhoneIdentifierChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge)*/} -Defined in: [interfaces/screens/phone-identifier-challenge.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L37) +Defined in: [interfaces/screens/phone-identifier-challenge.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L37) #### Overrides @@ -83,7 +83,7 @@ Defined in: [interfaces/screens/phone-identifier-challenge.ts:37](https://github <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -116,7 +116,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -128,7 +128,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/phone-identifier-challenge.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L39) +Defined in: [interfaces/screens/phone-identifier-challenge.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L39) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -145,7 +145,7 @@ Defined in: [interfaces/screens/phone-identifier-challenge.ts:39](https://github <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [interfaces/screens/phone-identifier-challenge.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L40) +Defined in: [interfaces/screens/phone-identifier-challenge.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L40) <Expandable title="Parameters"> <ParamField body='options?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions">StartResendOptions</a></span>}> @@ -162,7 +162,7 @@ Defined in: [interfaces/screens/phone-identifier-challenge.ts:40](https://github <ParamField body='returnToPrevious' type='Promise<void>'> {/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/phone-identifier-challenge.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L41) +Defined in: [interfaces/screens/phone-identifier-challenge.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L41) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -179,7 +179,7 @@ Defined in: [interfaces/screens/phone-identifier-challenge.ts:41](https://github <ParamField body='submitPhoneChallenge' type='Promise<void>'> {/*> **submitPhoneChallenge**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/phone-identifier-challenge.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L38) +Defined in: [interfaces/screens/phone-identifier-challenge.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L38) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions">PhoneChallengeOptions</a></span>}> @@ -196,7 +196,7 @@ Defined in: [interfaces/screens/phone-identifier-challenge.ts:38](https://github <ParamField body='switchToText' type='Promise<void>'> {/*> **switchToText**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/phone-identifier-challenge.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L43) +Defined in: [interfaces/screens/phone-identifier-challenge.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L43) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -213,7 +213,7 @@ Defined in: [interfaces/screens/phone-identifier-challenge.ts:43](https://github <ParamField body='switchToVoice' type='Promise<void>'> {/*> **switchToVoice**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/phone-identifier-challenge.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L42) +Defined in: [interfaces/screens/phone-identifier-challenge.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L42) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.mdx index 6825fa7c5..0d17c54c2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.mdx @@ -2,7 +2,7 @@ title: "PhoneIdentifierEnrollmentMembers" --- -Defined in: [interfaces/screens/phone-identifier-enrollment.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L23) +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L23) <RequestExample> @@ -24,7 +24,7 @@ export interface PhoneIdentifierEnrollmentMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -35,7 +35,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -57,7 +57,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment">ScreenMembersOnPhoneIdentifierEnrollment</a></span>}> {/*> **screen**: [`ScreenMembersOnPhoneIdentifierEnrollment`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment)*/} -Defined in: [interfaces/screens/phone-identifier-enrollment.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L24) +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L24) #### Overrides @@ -79,7 +79,7 @@ Defined in: [interfaces/screens/phone-identifier-enrollment.ts:24](https://githu <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -90,7 +90,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -101,7 +101,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -112,7 +112,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -124,7 +124,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continuePhoneEnrollment' type='Promise<void>'> {/*> **continuePhoneEnrollment**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/phone-identifier-enrollment.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L25) +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L25) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions">PhoneEnrollmentOptions</a></span>}> @@ -141,7 +141,7 @@ Defined in: [interfaces/screens/phone-identifier-enrollment.ts:25](https://githu <ParamField body='returnToPrevious' type='Promise<void>'> {/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/phone-identifier-enrollment.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L26) +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L26) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix.mdx index dcf98e9f1..7502dcd43 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix.mdx @@ -2,7 +2,7 @@ title: "PhonePrefix" --- -Defined in: [interfaces/models/screen.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L49) +Defined in: [interfaces/models/screen.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L49) <RequestExample> @@ -23,7 +23,7 @@ export interface PhonePrefix { <ParamField body='country' type='string'> {/*> **country**: `string`*/} -Defined in: [interfaces/models/screen.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L51) +Defined in: [interfaces/models/screen.ts:51](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L51) The country name @@ -33,7 +33,7 @@ The country name > **country\_code**: `string` -Defined in: [interfaces/models/screen.ts:53](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L53) +Defined in: [interfaces/models/screen.ts:53](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L53) The country code (e.g. 'US', 'GB') @@ -42,6 +42,6 @@ The country code (e.g. 'US', 'GB') > **phone\_prefix**: `string` -Defined in: [interfaces/models/screen.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L55) +Defined in: [interfaces/models/screen.ts:55](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L55) The phone prefix (e.g. '+1', '+44') \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers.mdx index e4e7ea122..fc2c1393c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers.mdx @@ -2,7 +2,7 @@ title: "PromptMembers" --- -Defined in: [interfaces/models/prompt.ts:5](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/prompt.ts#L5) +Defined in: [interfaces/models/prompt.ts:5](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/prompt.ts#L5) <RequestExample> @@ -18,5 +18,5 @@ export interface PromptMembers { <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/prompt.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/prompt.ts#L6) +Defined in: [interfaces/models/prompt.ts:6](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/prompt.ts#L6) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.mdx index d4c0e588e..86ec9f21d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.mdx @@ -2,7 +2,7 @@ title: "RedeemTicketMembers" --- -Defined in: [interfaces/screens/redeem-ticket.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L12) +Defined in: [interfaces/screens/redeem-ticket.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L12) Interface describing the data available on the Redeem Ticket screen. @@ -43,7 +43,7 @@ export interface RedeemTicketMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -54,7 +54,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/screens/redeem-ticket.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L13) +Defined in: [interfaces/screens/redeem-ticket.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L13) #### Overrides @@ -65,7 +65,7 @@ Defined in: [interfaces/screens/redeem-ticket.ts:13](https://github.com/auth0/un <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/screens/redeem-ticket.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L14) +Defined in: [interfaces/screens/redeem-ticket.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L14) #### Overrides @@ -76,7 +76,7 @@ Defined in: [interfaces/screens/redeem-ticket.ts:14](https://github.com/auth0/un <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/screens/redeem-ticket.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L15) +Defined in: [interfaces/screens/redeem-ticket.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L15) #### Overrides @@ -87,7 +87,7 @@ Defined in: [interfaces/screens/redeem-ticket.ts:15](https://github.com/auth0/un <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/screens/redeem-ticket.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L16) +Defined in: [interfaces/screens/redeem-ticket.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L16) #### Overrides @@ -98,7 +98,7 @@ Defined in: [interfaces/screens/redeem-ticket.ts:16](https://github.com/auth0/un <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -109,7 +109,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/screens/redeem-ticket.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L17) +Defined in: [interfaces/screens/redeem-ticket.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L17) #### Overrides @@ -120,7 +120,7 @@ Defined in: [interfaces/screens/redeem-ticket.ts:17](https://github.com/auth0/un <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -131,7 +131,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -143,7 +143,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/redeem-ticket.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L32) +Defined in: [interfaces/screens/redeem-ticket.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/redeem-ticket.ts#L32) Performs the default action on the redeem-ticket screen, which usually involves continuing the flow. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions.mdx index 38166dd5c..dc3e8536d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions.mdx @@ -2,7 +2,7 @@ title: "ReportBrowserErrorOptions" --- -Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L37) +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L37) ReportBrowserErrorOptions @@ -28,7 +28,7 @@ export interface ReportBrowserErrorOptions { <ParamField body='error' type='object'> {/*> **error**: `object`*/} -Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L43) +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L43) #### message diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions.mdx index 9cc3ab9c5..eff1a5880 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions.mdx @@ -2,7 +2,7 @@ title: "ResendCodeOptions" --- -Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L29) +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L29) Options for resending the email code. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload.mdx index a4723725b..faf71945f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload.mdx @@ -2,7 +2,7 @@ title: "ResendCodeOptionsPayload" --- -Defined in: [interfaces/screens/login-email-verification.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L30) +Defined in: [interfaces/screens/login-email-verification.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L30) ResendCodeOptions description Options for the `resendCode` method on the Login Email Verification screen. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions.mdx index 2185a5454..915080365 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions.mdx @@ -2,7 +2,7 @@ title: "ResendCodePayloadOptions" --- -Defined in: [interfaces/screens/mfa-email-challenge.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L41) +Defined in: [interfaces/screens/mfa-email-challenge.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L41) Options for resending the email code diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl.mdx index 508457b45..ba86a6075 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl.mdx @@ -2,7 +2,7 @@ title: "ResendControl" --- -Defined in: [interfaces/utils/resend-control.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L20) +Defined in: [interfaces/utils/resend-control.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L20) Control object returned by resendManager method @@ -19,7 +19,7 @@ export interface ResendControl { <ParamField body='Returns' type='unknown'>{/*> **startResend**: () => `void`*/} -Defined in: [interfaces/utils/resend-control.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L21) +Defined in: [interfaces/utils/resend-control.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L21) < `void` diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.mdx index d602a8b7a..f20a6a37b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordEmailMembers" --- -Defined in: [interfaces/screens/reset-password-email.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L19) +Defined in: [interfaces/screens/reset-password-email.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L19) <RequestExample> @@ -23,7 +23,7 @@ export interface ResetPasswordEmailMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -34,7 +34,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -45,7 +45,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -56,7 +56,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -67,7 +67,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail">ScreenMembersOnResetPasswordEmail</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordEmail`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail)*/} -Defined in: [interfaces/screens/reset-password-email.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L20) +Defined in: [interfaces/screens/reset-password-email.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L20) #### Overrides @@ -78,7 +78,7 @@ Defined in: [interfaces/screens/reset-password-email.ts:20](https://github.com/a <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -89,7 +89,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -100,7 +100,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -111,7 +111,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -123,7 +123,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='resendEmail' type='Promise<void>'> {/*> **resendEmail**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-email.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L21) +Defined in: [interfaces/screens/reset-password-email.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L21) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailOptions.mdx index 6c4a9bb7d..43b7076b6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailOptions.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordEmailOptions" --- -Defined in: [interfaces/screens/reset-password-email.ts:5](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L5) +Defined in: [interfaces/screens/reset-password-email.ts:5](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L5) <RequestExample> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.mdx index a70328335..8fb5fc729 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordErrorMembers" --- -Defined in: [interfaces/screens/reset-password-error.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts#L14) +Defined in: [interfaces/screens/reset-password-error.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts#L14) <RequestExample> @@ -22,7 +22,7 @@ export interface ResetPasswordErrorMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -33,7 +33,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError">ScreenMembersOnResetPasswordError</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError)*/} -Defined in: [interfaces/screens/reset-password-error.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts#L15) +Defined in: [interfaces/screens/reset-password-error.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts#L15) #### Overrides @@ -77,7 +77,7 @@ Defined in: [interfaces/screens/reset-password-error.ts:15](https://github.com/a <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.mdx index 25e736b2f..c6365f79c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMembers" --- -Defined in: [interfaces/screens/reset-password.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L22) +Defined in: [interfaces/screens/reset-password.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L22) <RequestExample> @@ -25,7 +25,7 @@ export interface ResetPasswordMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -36,7 +36,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -47,7 +47,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -58,7 +58,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -69,7 +69,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword">ScreenMembersOnResetPassword</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword)*/} -Defined in: [interfaces/screens/reset-password.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L23) +Defined in: [interfaces/screens/reset-password.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L23) #### Overrides @@ -80,7 +80,7 @@ Defined in: [interfaces/screens/reset-password.ts:23](https://github.com/auth0/u <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -91,7 +91,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword">TransactionMembersOnResetPassword</a></span>}> {/*> **transaction**: [`TransactionMembersOnResetPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword)*/} -Defined in: [interfaces/screens/reset-password.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L24) +Defined in: [interfaces/screens/reset-password.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L24) #### Overrides @@ -102,7 +102,7 @@ Defined in: [interfaces/screens/reset-password.ts:24](https://github.com/auth0/u <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -113,7 +113,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -125,7 +125,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='resetPassword' type='Promise<void>'> {/*> **resetPassword**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L25) +Defined in: [interfaces/screens/reset-password.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L25) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions">ResetPasswordOptions</a></span>}> @@ -142,7 +142,7 @@ Defined in: [interfaces/screens/reset-password.ts:25](https://github.com/auth0/u <ParamField body='validatePassword' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> {/*> **validatePassword**(`password`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult)*/} -Defined in: [interfaces/screens/reset-password.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L26) +Defined in: [interfaces/screens/reset-password.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L26) <Expandable title="Parameters"> <ParamField body='password' type='string'> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx index 8896af54b..fce695cbc 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaEmailChallengeMembers" --- -Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L45) +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:45](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L45) Interface defining the available methods and properties for the reset-password-mfa-email-challenge screen @@ -48,7 +48,7 @@ export interface ResetPasswordMfaEmailChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -81,7 +81,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge">ScreenMembersOnResetPasswordMfaEmailChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordMfaEmailChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge)*/} -Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L46) +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L46) #### Overrides @@ -103,7 +103,7 @@ Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:46](https: <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -114,7 +114,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -125,7 +125,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -136,7 +136,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -148,7 +148,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L52) +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:52](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L52) Continues with the email challenge using the provided code. @@ -169,7 +169,7 @@ The options containing the code and rememberDevice flag. <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L58) +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L58) Resends the email code. @@ -190,7 +190,7 @@ Optional custom options to include with the request. <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:70](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L70) +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:70](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L70) Gets resend functionality with timeout management for this screen @@ -211,7 +211,7 @@ Configuration options for resend functionality <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L64) +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:64](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L64) Allows the user to try another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx index d562d7e2d..f7f88aae1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaOtpChallengeContinueOptions" --- -Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L6) +Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:6](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L6) Options for continuing with the OTP challenge. @@ -29,7 +29,7 @@ Any additional custom options <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L8) +Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L8) The code entered by the user. </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx index 2bad107bf..8360ba17d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaOtpChallengeMembers" --- -Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L24) +Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L24) Interface defining the available methods and properties for the reset-password-mfa-otp-challenge screen @@ -33,7 +33,7 @@ export interface ResetPasswordMfaOtpChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) +Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -121,7 +121,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -133,7 +133,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L29) +Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L29) Continues with the OTP challenge using the provided code. @@ -154,7 +154,7 @@ The options containing the code. <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L34) +Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L34) Allows the user to try another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx index 3e39591c2..f29974703 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaOtpChallengeTryAnotherMethodOptions" --- -Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L16) +Defined in: [interfaces/screens/reset-password-mfa-otp-challenge.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L16) Options for trying another method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx index f28a709ab..4c92a2046 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaPhoneChallengeContinueOptions" --- -Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L32) +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L32) ContinueOptions @@ -34,7 +34,7 @@ export interface ContinueOptions extends CustomOptions { <ParamField body='type' type='"sms"'> {/*> **type**: `"sms"` \| `"voice"`*/} -Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L39) +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L39) The delivery method selected by the user for receiving the verification code. - `sms`: Send the code via text message. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx index 397fe8c09..8596b870f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaPhoneChallengeMembers" --- -Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:67](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L67) +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:67](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L67) ResetPasswordMfaPhoneChallengeMembers @@ -97,7 +97,7 @@ export interface ResetPasswordMfaPhoneChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -108,7 +108,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:72](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L72) +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:72](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L72) Access to client-specific information (e.g., client ID, name). @@ -121,7 +121,7 @@ Access to client-specific information (e.g., client ID, name). <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:78](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L78) +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:78](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L78) Access to organization-specific information, if applicable. @@ -134,7 +134,7 @@ Access to organization-specific information, if applicable. <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L84) +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L84) Access to prompt details (e.g., prompt name). @@ -147,7 +147,7 @@ Access to prompt details (e.g., prompt name). <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge">ScreenMembersOnResetPasswordMfaPhoneChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordMfaPhoneChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge)*/} -Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:90](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L90) +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:90](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L90) Access to the specific properties and data of the 'reset-password-mfa-phone-challenge' screen. @@ -160,7 +160,7 @@ Access to the specific properties and data of the 'reset-password-mfa-phone-chal <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -171,7 +171,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:96](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L96) +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:96](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L96) Access to the current transaction details (e.g., state, errors). @@ -184,7 +184,7 @@ Access to the current transaction details (e.g., state, errors). <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -195,7 +195,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -207,7 +207,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:119](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L119) +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:119](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L119) Sends the verification code to the user's phone via the specified method (SMS or Voice). This action corresponds to the user clicking the "Send Code via SMS" or "Send Code via Voice Call" button. @@ -250,7 +250,7 @@ await screen.continue({ type: 'voice' }); <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:141](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L141) +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:141](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L141) Navigates the user to the screen where they can select an alternative MFA method. This action corresponds to the user clicking a "Try Another Method" button. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx index 1598949bc..40755e7e4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions" --- -Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L49) +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L49) TryAnotherMethodOptions @@ -35,7 +35,7 @@ export interface TryAnotherMethodOptions extends CustomOptions { <ParamField body='type' type='"sms"'> {/*> **type**: `"sms"` \| `"voice"`*/} -Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L57) +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:57](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L57) The delivery method that was initially presented or selected on the current screen. This is required by the API endpoint to correctly process the 'pick-authenticator' action. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx index 8d111f28e..d7bc70ce3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaPushChallengePushMembers" --- -Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L23) +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L23) Interface defining the available methods and properties for the reset-password-mfa-push-challenge-push screen @@ -54,7 +54,7 @@ export interface ResetPasswordMfaPushChallengePushMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -65,7 +65,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -76,7 +76,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -87,7 +87,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -98,7 +98,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush">ScreenMembersOnResetPasswordMfaPushChallengePush</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordMfaPushChallengePush`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush)*/} -Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L24) +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L24) #### Overrides @@ -109,7 +109,7 @@ Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:24](ht <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -120,7 +120,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -131,7 +131,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -142,7 +142,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -154,7 +154,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L30) +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L30) Continues with the push notification challenge @@ -175,7 +175,7 @@ Optional custom options to include with the request <ParamField body='enterCodeManually' type='Promise<void>'> {/*> **enterCodeManually**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L42) +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L42) Switches to entering the verification code manually @@ -196,7 +196,7 @@ Optional custom options to include with the request <ParamField body='pollingManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl">MfaPushPollingControl</a></span>}> {/*> **pollingManager**(`options?`): [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl)*/} -Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L54) +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:54](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L54) Allows polling for the push notification challenge to be approved. @@ -217,7 +217,7 @@ of type [MfaPollingOptions](/docs/customize/login-pages/advanced-customizations/ <ParamField body='resendPushNotification' type='Promise<void>'> {/*> **resendPushNotification**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L36) +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L36) Resends the push notification @@ -238,7 +238,7 @@ Optional custom options to include with the request <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L48) +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:48](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L48) Allows trying another authentication method diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx index 9f173aa8f..7171c73cf 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaRecoveryCodeChallengeMembers" --- -Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L12) +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L12) Interface describing the members of the Mfa Recovery Code Challenge screen. @@ -43,7 +43,7 @@ export interface ResetPasswordMfaRecoveryCodeChallengeMembers extends BaseMember <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -54,7 +54,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L13) +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L13) #### Overrides @@ -65,7 +65,7 @@ Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:13 <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L14) +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L14) #### Overrides @@ -76,7 +76,7 @@ Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:14 <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L15) +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L15) #### Overrides @@ -87,7 +87,7 @@ Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:15 <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L16) +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L16) #### Overrides @@ -98,7 +98,7 @@ Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:16 <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -109,7 +109,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L17) +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L17) #### Overrides @@ -120,7 +120,7 @@ Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:17 <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -131,7 +131,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -143,7 +143,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`code`, `payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L25) +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L25) Continues with the provided recovery code. @@ -169,7 +169,7 @@ Optional payload. <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L32) +Defined in: [interfaces/screens/reset-password-mfa-recovery-code-challenge.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-recovery-code-challenge.ts#L32) Navigates to the screen where the user can pick another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx index 784b9ed09..1b2a486e4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaSmsChallengeMembers" --- -Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L21) +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L21) <RequestExample> @@ -31,7 +31,7 @@ export interface ResetPasswordMfaSmsChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -42,7 +42,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -53,7 +53,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -64,7 +64,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -75,7 +75,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge">ScreenMembersOnResetPasswordMfaSmsChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordMfaSmsChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge)*/} -Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L22) +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L22) #### Overrides @@ -86,7 +86,7 @@ Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:22](https:// <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -97,7 +97,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -108,7 +108,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -119,7 +119,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -131,7 +131,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continueMfaSmsChallenge' type='Promise<void>'> {/*> **continueMfaSmsChallenge**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L23) +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L23) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions">ResetPasswordMfaSmsChallengeOptions</a></span>}> @@ -148,7 +148,7 @@ Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:23](https:// <ParamField body='getACall' type='Promise<void>'> {/*> **getACall**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L26) +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L26) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -165,7 +165,7 @@ Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:26](https:// <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L24) +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L24) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -182,7 +182,7 @@ Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:24](https:// <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L31) +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L31) Gets resend functionality with timeout management for this screen @@ -203,7 +203,7 @@ Configuration options for resend functionality <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L25) +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L25) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx index 3403c1de4..c747637f2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaSmsChallengeOptions" --- -Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L6) +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:6](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L6) <RequestExample> @@ -23,5 +23,5 @@ export interface MfaSmsChallengeOptions { <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L7) +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:7](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L7) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx index 433791645..a50648e37 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaVoiceChallengeContinueOptions" --- -Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L26) +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L26) Payload for the `continue()` method on ResetPasswordMfaVoiceChallengeMembers. @@ -31,7 +31,7 @@ export interface ContinueOptions extends CustomOptions { <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L30) +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L30) The OTP code entered by the user. </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx index ea22432ef..706afdd25 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaVoiceChallengeMembers" --- -Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L36) +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L36) Interface defining the available methods and properties for the reset-password-mfa-voice-challenge screen. @@ -68,7 +68,7 @@ export interface ResetPasswordMfaVoiceChallengeMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -79,7 +79,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -90,7 +90,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -101,7 +101,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -112,7 +112,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge">ScreenMembersOnResetPasswordMfaVoiceChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordMfaVoiceChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge)*/} -Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L37) +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L37) #### Overrides @@ -123,7 +123,7 @@ Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:37](https: <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -134,7 +134,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -145,7 +145,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -156,7 +156,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -168,7 +168,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continue' type='Promise<void>'> {/*> **continue**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L51) +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:51](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L51) Continues with the voice challenge using the provided code. @@ -198,7 +198,7 @@ await reset.continue({ code: '123456' }); <ParamField body='resendCode' type='Promise<void>'> {/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:67](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L67) +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:67](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L67) Re-sends the code via voice call. @@ -221,7 +221,7 @@ A promise that resolves when the code is resent. <ParamField body='resendManager' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl">ResendControl</a></span>}> {/*> **resendManager**(`options?`): [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl)*/} -Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L81) +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L81) Gets resend functionality with timeout management for this screen @@ -242,7 +242,7 @@ Configuration options for resend functionality <ParamField body='switchToSms' type='Promise<void>'> {/*> **switchToSms**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L59) +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:59](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L59) Switches to SMS verification. @@ -265,7 +265,7 @@ A promise that resolves when the action completes. <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:75](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L75) +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:75](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L75) Allows the user to try another MFA method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx index 44537c0be..61defbcd1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions" --- -Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L58) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L58) ContinueWithPasskeyOptions @@ -33,7 +33,7 @@ export interface ContinueWithPasskeyOptions extends CustomOptions { <ParamField body='rememberDevice?' type='boolean'> {/*> `optional` **rememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L64) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:64](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L64) Optional. If `true` and `screen.showRememberDevice` is also `true`, this indicates the user has opted to remember the current browser, diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx index 476ff01ad..cd31f2e6e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaWebAuthnPlatformChallengeMembers" --- -Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:115](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L115) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:115](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L115) ResetPasswordMfaWebAuthnPlatformChallengeMembers @@ -110,7 +110,7 @@ export interface ResetPasswordMfaWebAuthnPlatformChallengeMembers extends BaseMe <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -121,7 +121,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -132,7 +132,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -143,7 +143,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -154,7 +154,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge">ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge)*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:120](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L120) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:120](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L120) Access to the specific properties and data of the 'reset-password-mfa-webauthn-platform-challenge' screen. @@ -167,7 +167,7 @@ Access to the specific properties and data of the 'reset-password-mfa-webauthn-p <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -178,7 +178,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -189,7 +189,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -200,7 +200,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -212,7 +212,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='continueWithPasskey' type='Promise<void>'> {/*> **continueWithPasskey**(`options?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:154](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L154) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:154](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L154) Initiates the WebAuthn platform authenticator challenge by calling `navigator.credentials.get()` using the challenge options provided in `screen.publicKey`. @@ -265,7 +265,7 @@ try { <ParamField body='reportBrowserError' type='Promise<void>'> {/*> **reportBrowserError**(`options`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:180](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L180) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:180](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L180) Reports a browser-side error that occurred during the `navigator.credentials.get()` API call. This is used to inform Auth0 about issues like user cancellation, timeout, or unsupported hardware. @@ -310,7 +310,7 @@ try { <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:202](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L202) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:202](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L202) Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx index a659c8728..09e6ee748 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions" --- -Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:77](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L77) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:77](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L77) ReportBrowserErrorOptions @@ -26,7 +26,7 @@ export interface ReportBrowserErrorOptions { <ParamField body='error' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>}> {/*> **error**: [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails)*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L84) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L84) The error object from the WebAuthn API (`navigator.credentials.get()`) to be reported. Must include `name` and `message`. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx index 335b31fb4..2510bef48 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions" --- -Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:94](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L94) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:94](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L94) TryAnotherMethodOptions diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx index 666a2e627..9edf4da5e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaWebAuthnRoamingChallengeMembers" --- -Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:145](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L145) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:145](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L145) ResetPasswordMfaWebAuthnRoamingChallengeMembers @@ -75,7 +75,7 @@ export interface ResetPasswordMfaWebAuthnRoamingChallengeMembers extends BaseMem <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -97,7 +97,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -108,7 +108,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -119,7 +119,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge">ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge)*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:152](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L152) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:152](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L152) Access to the specific properties and data of the `reset-password-mfa-webauthn-roaming-challenge` screen, including WebAuthn `publicKey` challenge options and the `showRememberDevice` flag. @@ -133,7 +133,7 @@ including WebAuthn `publicKey` challenge options and the `showRememberDevice` fl <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -144,7 +144,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -155,7 +155,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -166,7 +166,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -178,7 +178,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='showError' type='Promise<void>'> {/*> **showError**(`options`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:185](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L185) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:185](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L185) Reports a client-side WebAuthn API error (from `navigator.credentials.get()`) to Auth0. This method should be used when `useSecurityKey()` (or a manual `navigator.credentials.get()` call) @@ -211,7 +211,7 @@ Throws an error if the form submission fails (e.g., network error, invalid state <ParamField body='tryAnotherMethod' type='Promise<void>'> {/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:197](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L197) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:197](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L197) Allows the user to opt-out of the WebAuthn roaming challenge and select a different MFA method. This action submits `action: "pick-authenticator"` to Auth0, which should navigate @@ -241,7 +241,7 @@ Throws an error if the form submission fails. <ParamField body='useSecurityKey' type='Promise<void>'> {/*> **useSecurityKey**(`options?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L170) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:170](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L170) Initiates the WebAuthn assertion process (security key challenge). This method will internally call `navigator.credentials.get()` using the challenge diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx index e27553148..f84370546 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions" --- -Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:96](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L96) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:96](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L96) ShowErrorOptions @@ -34,7 +34,7 @@ export interface ShowErrorOptions { <ParamField body='error' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>}> {/*> **error**: [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails)*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:103](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L103) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:103](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L103) The error object from the WebAuthn API (`navigator.credentials.get()`) containing `name` and `message` of the DOMException. @@ -44,7 +44,7 @@ containing `name` and `message` of the DOMException. <ParamField body='rememberDevice?' type='boolean'> {/*> `optional` **rememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:111](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L111) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:111](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L111) Optional. If `true` and `screen.showRememberDevice` is also `true`, the SDK will include `rememberBrowser=true` in the form submission. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx index 5116cd4ef..32eeaf0ca 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions" --- -Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:123](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L123) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:123](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L123) TryAnotherMethodOptions @@ -34,7 +34,7 @@ export interface TryAnotherMethodOptions extends CustomOptions { <ParamField body='rememberDevice?' type='boolean'> {/*> `optional` **rememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:130](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L130) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:130](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L130) Optional. If `true` and `screen.showRememberDevice` is also `true`, the SDK will include `rememberBrowser=true` in the form submission. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx index 27ff215c6..bb870cec8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions" --- -Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:74](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L74) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:74](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L74) UseSecurityKeyOptions @@ -35,7 +35,7 @@ export interface UseSecurityKeyOptions extends CustomOptions { <ParamField body='rememberDevice?' type='boolean'> {/*> `optional` **rememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L82) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L82) Optional. If `true` and `screen.showRememberDevice` is also `true`, the SDK will include `rememberBrowser=true` in the form submission, indicating the user's diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions.mdx index 826f40a41..3be1077c6 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordOptions" --- -Defined in: [interfaces/screens/reset-password.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L6) +Defined in: [interfaces/screens/reset-password.ts:6](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L6) <RequestExample> @@ -25,11 +25,11 @@ export interface ResetPasswordOptions { > **password-reset**: `string` -Defined in: [interfaces/screens/reset-password.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L7) +Defined in: [interfaces/screens/reset-password.ts:7](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L7) ### re-enter-password > **re-enter-password**: `string` -Defined in: [interfaces/screens/reset-password.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L8) \ No newline at end of file +Defined in: [interfaces/screens/reset-password.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L8) \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.mdx index b604d2673..47828b5de 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordRequestMembers" --- -Defined in: [interfaces/screens/reset-password-request.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L27) +Defined in: [interfaces/screens/reset-password-request.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L27) <RequestExample> @@ -26,7 +26,7 @@ export interface ResetPasswordRequestMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest">ScreenMembersOnResetPasswordRequest</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest)*/} -Defined in: [interfaces/screens/reset-password-request.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L28) +Defined in: [interfaces/screens/reset-password-request.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L28) #### Overrides @@ -81,7 +81,7 @@ Defined in: [interfaces/screens/reset-password-request.ts:28](https://github.com <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest">TransactionMembersOnResetPasswordRequest</a></span>}> {/*> **transaction**: [`TransactionMembersOnResetPasswordRequest`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest)*/} -Defined in: [interfaces/screens/reset-password-request.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L29) +Defined in: [interfaces/screens/reset-password-request.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L29) #### Overrides @@ -103,7 +103,7 @@ Defined in: [interfaces/screens/reset-password-request.ts:29](https://github.com <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -114,7 +114,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -126,7 +126,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='backToLogin' type='Promise<void>'> {/*> **backToLogin**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-request.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L31) +Defined in: [interfaces/screens/reset-password-request.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L31) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -143,7 +143,7 @@ Defined in: [interfaces/screens/reset-password-request.ts:31](https://github.com <ParamField body='getLoginIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> {/*> **getLoginIdentifiers**(): [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} -Defined in: [interfaces/screens/reset-password-request.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L32) +Defined in: [interfaces/screens/reset-password-request.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L32) #### Returns @@ -154,7 +154,7 @@ Defined in: [interfaces/screens/reset-password-request.ts:32](https://github.com <ParamField body='resetPassword' type='Promise<void>'> {/*> **resetPassword**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/reset-password-request.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L30) +Defined in: [interfaces/screens/reset-password-request.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L30) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions">ResetPasswordRequestOptions</a></span>}> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions.mdx index 0d9959303..0c418a81c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordRequestOptions" --- -Defined in: [interfaces/screens/reset-password-request.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L7) +Defined in: [interfaces/screens/reset-password-request.ts:7](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L7) <RequestExample> @@ -24,12 +24,12 @@ export interface ResetPasswordRequestOptions { <ParamField body='captcha?' type='string'> {/*> `optional` **captcha**: `string`*/} -Defined in: [interfaces/screens/reset-password-request.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L9) +Defined in: [interfaces/screens/reset-password-request.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L9) </ParamField> <ParamField body='username' type='string'> {/*> **username**: `string`*/} -Defined in: [interfaces/screens/reset-password-request.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L8) +Defined in: [interfaces/screens/reset-password-request.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L8) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.mdx index 374b5912a..7775b5ad0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.mdx @@ -2,7 +2,7 @@ title: "ResetPasswordSuccessMembers" --- -Defined in: [interfaces/screens/reset-password-success.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-success.ts#L14) +Defined in: [interfaces/screens/reset-password-success.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-success.ts#L14) <RequestExample> @@ -22,7 +22,7 @@ export interface ResetPasswordSuccessMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -33,7 +33,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess">ScreenMembersOnResetPasswordSuccess</a></span>}> {/*> **screen**: [`ScreenMembersOnResetPasswordSuccess`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess)*/} -Defined in: [interfaces/screens/reset-password-success.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-success.ts#L15) +Defined in: [interfaces/screens/reset-password-success.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-success.ts#L15) #### Overrides @@ -77,7 +77,7 @@ Defined in: [interfaces/screens/reset-password-success.ts:15](https://github.com <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) +Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/base-context.ts:30](https://github.com/auth0/univ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope.mdx index 0349883ef..bc5d45d4a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope.mdx @@ -2,7 +2,7 @@ title: "Scope" --- -Defined in: [interfaces/models/screen.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L58) +Defined in: [interfaces/models/screen.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L58) <RequestExample> @@ -19,12 +19,12 @@ export interface Scope { <ParamField body='description?' type='string'> {/*> `optional` **description**: `string`*/} -Defined in: [interfaces/models/screen.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L60) +Defined in: [interfaces/models/screen.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L60) </ParamField> <ParamField body='value' type='string'> {/*> **value**: `string`*/} -Defined in: [interfaces/models/screen.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L59) +Defined in: [interfaces/models/screen.ts:59](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L59) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.mdx index 9fb9b495e..02a418245 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers.mdx @@ -2,7 +2,7 @@ title: "ScreenMembers" --- -Defined in: [interfaces/models/screen.ts:80](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L80) +Defined in: [interfaces/models/screen.ts:80](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L80) <RequestExample> @@ -85,61 +85,61 @@ export interface ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) </ParamField> <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) </ParamField> <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) </ParamField> <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) </ParamField> <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) </ParamField> <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) </ParamField> <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) </ParamField> <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) </ParamField> <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation.mdx index 7395ec357..fe8b57070 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnAcceptInvitation" --- -Defined in: [interfaces/screens/accept-invitation.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L9) +Defined in: [interfaces/screens/accept-invitation.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L9) <RequestExample> @@ -25,7 +25,7 @@ export interface ScreenMembersOnAcceptInvitation extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -36,7 +36,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -47,7 +47,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -58,7 +58,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -69,7 +69,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='email'> {/*> **data**: \{ `email`: `string`; `inviter`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/accept-invitation.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L10) +Defined in: [interfaces/screens/accept-invitation.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/accept-invitation.ts#L10) #### Overrides @@ -80,7 +80,7 @@ Defined in: [interfaces/screens/accept-invitation.ts:10](https://github.com/auth <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -91,7 +91,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -102,7 +102,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -113,7 +113,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent.mdx index 05ca0078b..b17c3ade8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnConsent" --- -Defined in: [interfaces/screens/consent.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/consent.ts#L20) +Defined in: [interfaces/screens/consent.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/consent.ts#L20) ScreenMembersOnConsent @@ -25,7 +25,7 @@ export interface ScreenMembersOnConsent extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -36,7 +36,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -47,7 +47,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -58,7 +58,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -69,7 +69,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) Screen-specific data. @@ -82,14 +82,14 @@ Screen-specific data. <ParamField body='hideScopes' type='boolean'> {/*> **hideScopes**: `boolean`*/} -Defined in: [interfaces/screens/consent.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/consent.ts#L22) +Defined in: [interfaces/screens/consent.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/consent.ts#L22) </ParamField> <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -100,7 +100,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -111,7 +111,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -122,14 +122,14 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='scopes' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope">Scope</a></span>}> {/*> **scopes**: [`Scope`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope)[]*/} -Defined in: [interfaces/screens/consent.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/consent.ts#L21) +Defined in: [interfaces/screens/consent.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/consent.ts#L21) </ParamField> <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent.mdx index 87c81a676..77bfe96b1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnCustomizedConsent" --- -Defined in: [interfaces/screens/customized-consent.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L19) +Defined in: [interfaces/screens/customized-consent.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L19) ScreenMembersOnCustomizedConsent @@ -38,7 +38,7 @@ export interface ScreenMembersOnCustomizedConsent extends ScreenMembers { <ParamField body='authorizationDetails' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail">AuthorizationDetail</a></span>}> {/*> **authorizationDetails**: [`AuthorizationDetail`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail)[]*/} -Defined in: [interfaces/screens/customized-consent.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L34) +Defined in: [interfaces/screens/customized-consent.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L34) An array of `AuthorizationDetail` objects. Each object provides granular details about specific data or @@ -51,7 +51,7 @@ This list should be displayed to the user for their review. <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -73,7 +73,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -84,7 +84,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -95,7 +95,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) Screen-specific data. @@ -108,7 +108,7 @@ Screen-specific data. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -119,7 +119,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -130,7 +130,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -141,7 +141,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='scopes' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope">Scope</a></span>}> {/*> **scopes**: [`Scope`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope)[]*/} -Defined in: [interfaces/screens/customized-consent.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L25) +Defined in: [interfaces/screens/customized-consent.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/customized-consent.ts#L25) An array of `Scope` objects detailing each permission (scope) being requested. These are typically high-level permissions like 'read:profile' or 'openid'. @@ -152,7 +152,7 @@ This list should be displayed to the user for their review. <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx index 20d3584f5..a0d43a035 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnDeviceCodeConfirmation" --- -Defined in: [interfaces/screens/device-code-confirmation.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L8) +Defined in: [interfaces/screens/device-code-confirmation.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L8) Interface describing the data available on the Device Code Confirmation screen. @@ -26,7 +26,7 @@ export interface ScreenMembersOnDeviceCodeConfirmation extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='textCode'> {/*> **data**: \{ `textCode`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/device-code-confirmation.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L9) +Defined in: [interfaces/screens/device-code-confirmation.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/device-code-confirmation.ts#L9) #### Overrides @@ -81,7 +81,7 @@ Defined in: [interfaces/screens/device-code-confirmation.ts:9](https://github.co <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -103,7 +103,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -114,7 +114,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx index b46d5370a..38f92d123 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnEmailIdentifierChallenge" --- -Defined in: [interfaces/screens/email-identifier-challenge.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L12) +Defined in: [interfaces/screens/email-identifier-challenge.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L12) <RequestExample> @@ -26,7 +26,7 @@ export interface ScreenMembersOnEmailIdentifierChallenge extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='email?'> {/*> **data**: \{ `email?`: `string`; `messageType?`: `string`; `resendLimitReached?`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/email-identifier-challenge.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L13) +Defined in: [interfaces/screens/email-identifier-challenge.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L13) #### Overrides @@ -81,7 +81,7 @@ Defined in: [interfaces/screens/email-identifier-challenge.ts:13](https://github <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -103,7 +103,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -114,7 +114,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge.mdx index d2d48230b..58f970946 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnEmailOTPChallenge" --- -Defined in: [interfaces/screens/email-otp-challenge.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L10) +Defined in: [interfaces/screens/email-otp-challenge.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L10) Represents the members of the Email OTP Challenge screen. Extends the base ScreenMembers interface. @@ -25,7 +25,7 @@ export interface ScreenMembersOnEmailOTPChallenge extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -36,7 +36,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -47,7 +47,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -58,7 +58,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -69,7 +69,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) #### Inherited from @@ -80,7 +80,7 @@ Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal- <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -91,7 +91,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -102,7 +102,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -113,7 +113,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult.mdx index b16e8519c..d9c5fe69b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnEmailVerificationResult" --- -Defined in: [interfaces/screens/email-verification-result.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts#L16) +Defined in: [interfaces/screens/email-verification-result.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts#L16) ScreenMembersOnEmailVerificationResult @@ -41,7 +41,7 @@ export interface ScreenMembersOnEmailVerificationResult extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -52,7 +52,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -63,7 +63,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -85,7 +85,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='status'> {/*> **data**: \{ `status`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/email-verification-result.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts#L21) +Defined in: [interfaces/screens/email-verification-result.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts#L21) Screen-specific data. @@ -112,7 +112,7 @@ This status should be displayed to the user to inform them of the outcome. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -123,7 +123,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) Navigation links available on this screen. @@ -136,7 +136,7 @@ Navigation links available on this screen. <ParamField body='loginLink' type='string'> {/*> **loginLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/email-verification-result.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts#L34) +Defined in: [interfaces/screens/email-verification-result.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-verification-result.ts#L34) Navigation links available on this screen. @@ -145,7 +145,7 @@ Navigation links available on this screen. <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -156,7 +156,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin.mdx index 16ed56133..e95a73bd0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnLogin" --- -Defined in: [interfaces/screens/login.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L19) +Defined in: [interfaces/screens/login.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L19) Extended screen members interface for the login screen @@ -28,7 +28,7 @@ export interface ScreenMembersOnLogin extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -39,7 +39,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -50,7 +50,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='username?'> {/*> **data**: \{ `username?`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/login.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L22) +Defined in: [interfaces/screens/login.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L22) #### Overrides @@ -83,7 +83,7 @@ Defined in: [interfaces/screens/login.ts:22](https://github.com/auth0/universal- <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -116,21 +116,21 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='resetPasswordLink' type='string'> {/*> **resetPasswordLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/login.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L21) +Defined in: [interfaces/screens/login.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L21) </ParamField> <ParamField body='signupLink' type='string'> {/*> **signupLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/login.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L20) +Defined in: [interfaces/screens/login.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L20) </ParamField> <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId.mdx index aec507c75..45851d695 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnLoginId" --- -Defined in: [interfaces/screens/login-id.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L31) +Defined in: [interfaces/screens/login-id.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L31) <RequestExample> @@ -24,7 +24,7 @@ export interface ScreenMembersOnLoginId extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -35,7 +35,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -57,7 +57,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) #### Inherited from @@ -79,7 +79,7 @@ Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal- <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -90,7 +90,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -101,7 +101,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -112,28 +112,28 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='publicKey' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential">AllowCredential</a></span>}> {/*> **publicKey**: \{ `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential)[]; `challenge`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/login-id.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L34) +Defined in: [interfaces/screens/login-id.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L34) </ParamField> <ParamField body='resetPasswordLink' type='string'> {/*> **resetPasswordLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/login-id.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L33) +Defined in: [interfaces/screens/login-id.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L33) </ParamField> <ParamField body='signupLink' type='string'> {/*> **signupLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/login-id.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L32) +Defined in: [interfaces/screens/login-id.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L32) </ParamField> <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword.mdx index 6da0fff81..4a6f13d60 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnLoginPassword" --- -Defined in: [interfaces/screens/login-password.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L14) +Defined in: [interfaces/screens/login-password.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L14) <RequestExample> @@ -27,7 +27,7 @@ export interface ScreenMembersOnLoginPassword extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -49,7 +49,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -60,7 +60,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -71,7 +71,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='username'> {/*> **data**: \{ `username`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/login-password.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L18) +Defined in: [interfaces/screens/login-password.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L18) #### Overrides @@ -82,14 +82,14 @@ Defined in: [interfaces/screens/login-password.ts:18](https://github.com/auth0/u <ParamField body='editIdentifierLink' type='string'> {/*> **editIdentifierLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/login-password.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L17) +Defined in: [interfaces/screens/login-password.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L17) </ParamField> <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -100,7 +100,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -111,7 +111,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -122,21 +122,21 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='resetPasswordLink' type='string'> {/*> **resetPasswordLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/login-password.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L16) +Defined in: [interfaces/screens/login-password.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L16) </ParamField> <ParamField body='signupLink' type='string'> {/*> **signupLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/login-password.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L15) +Defined in: [interfaces/screens/login-password.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L15) </ParamField> <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx index d7cb432a6..07f64e3b1 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnLoginPasswordlessEmailCode" --- -Defined in: [interfaces/screens/login-passwordless-email-code.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L7) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:7](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L7) <RequestExample> @@ -28,7 +28,7 @@ export interface ScreenMembersOnLoginPasswordlessEmailCode extends ScreenMembers <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -39,7 +39,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -50,7 +50,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='email?'> {/*> **data**: \{ `email?`: `string`; `username?`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/login-passwordless-email-code.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L11) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L11) #### Overrides @@ -83,14 +83,14 @@ Defined in: [interfaces/screens/login-passwordless-email-code.ts:11](https://git <ParamField body='editIdentifierLink' type='string'> {/*> **editIdentifierLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/login-passwordless-email-code.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L8) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L8) </ParamField> <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -101,7 +101,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -112,7 +112,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -123,21 +123,21 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='resetPasswordLink' type='string'> {/*> **resetPasswordLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/login-passwordless-email-code.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L9) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L9) </ParamField> <ParamField body='signupLink' type='string'> {/*> **signupLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/login-passwordless-email-code.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L10) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L10) </ParamField> <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx index 4a41ad65f..acd093905 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnLoginPasswordlessSmsOtp" --- -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L14) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L14) <RequestExample> @@ -28,14 +28,14 @@ export interface ScreenMembersOnLoginPasswordlessSmsOtp extends ScreenMembers { <ParamField body='backLink' type='string'> {/*> **backLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L17) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L17) </ParamField> <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -57,7 +57,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -79,7 +79,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='object'> {/*> **data**: `object`*/} -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L18) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L18) #### phone\_number @@ -98,7 +98,7 @@ Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:18](https://github <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -109,7 +109,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -120,7 +120,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -131,21 +131,21 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='resetPasswordLink' type='string'> {/*> **resetPasswordLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L16) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L16) </ParamField> <ParamField body='signupLink' type='string'> {/*> **signupLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L15) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L15) </ParamField> <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes.mdx index 17db616a0..175db6578 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaCountryCodes" --- -Defined in: [interfaces/screens/mfa-country-codes.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L8) +Defined in: [interfaces/screens/mfa-country-codes.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L8) Interface for screen data specific to mfa-country-codes screen @@ -27,7 +27,7 @@ export interface ScreenMembersOnMfaCountryCodes extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -49,7 +49,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -60,7 +60,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -71,7 +71,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix">PhonePrefix</a></span>}> {/*> **data**: \{ `phone_prefixes`: [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-country-codes.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L9) +Defined in: [interfaces/screens/mfa-country-codes.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L9) #### Type Declaration @@ -94,7 +94,7 @@ List of available phone prefixes <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -116,7 +116,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -127,7 +127,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge.mdx index ad085a54a..549dbe1c2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaEmailChallenge" --- -Defined in: [interfaces/screens/mfa-email-challenge.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L10) +Defined in: [interfaces/screens/mfa-email-challenge.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L10) Interface for the screen data specific to mfa-email-challenge screen @@ -27,7 +27,7 @@ export interface ScreenMembersOnMfaEmailChallenge extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -49,7 +49,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -60,7 +60,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -71,7 +71,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='email'> {/*> **data**: \{ `email`: `string`; `showRememberDevice?`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-email-challenge.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L11) +Defined in: [interfaces/screens/mfa-email-challenge.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L11) #### Overrides @@ -82,7 +82,7 @@ Defined in: [interfaces/screens/mfa-email-challenge.ts:11](https://github.com/au <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -93,7 +93,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -104,7 +104,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -115,7 +115,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList.mdx index 27b8d5eb7..c787c47e8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaEmailList" --- -Defined in: [interfaces/screens/mfa-email-list.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L8) +Defined in: [interfaces/screens/mfa-email-list.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L8) Interface for the screen data specific to mfa-email-list screen @@ -27,7 +27,7 @@ export interface ScreenMembersOnMfaEmailList extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -49,7 +49,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -60,7 +60,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -71,7 +71,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='enrolled_emails'> {/*> **data**: \{ `enrolled_emails`: `string`[]; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-email-list.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L9) +Defined in: [interfaces/screens/mfa-email-list.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L9) #### Type Declaration @@ -94,7 +94,7 @@ List of enrolled email addresses <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -116,7 +116,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -127,7 +127,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult.mdx index ec2941912..c71d0a557 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaEnrollResult" --- -Defined in: [interfaces/screens/mfa-enroll-result.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts#L13) +Defined in: [interfaces/screens/mfa-enroll-result.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts#L13) ScreenMembersOnMfaEnrollResult @@ -36,7 +36,7 @@ export interface ScreenMembersOnMfaEnrollResult extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -47,7 +47,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -58,7 +58,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -69,7 +69,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -80,7 +80,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='status'> {/*> **data**: \{ `status`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-enroll-result.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts#L18) +Defined in: [interfaces/screens/mfa-enroll-result.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-enroll-result.ts#L18) Screen-specific data. @@ -107,7 +107,7 @@ This status can be used to display an appropriate message to the user. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -118,7 +118,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -129,7 +129,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -140,7 +140,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions.mdx index 17b350f1a..44220e921 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaLoginOptions" --- -Defined in: [interfaces/screens/mfa-login-options.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L9) +Defined in: [interfaces/screens/mfa-login-options.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L9) Interface for the screen data specific to mfa-login-options screen @@ -27,7 +27,7 @@ export interface ScreenMembersOnMfaLoginOptions extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -49,7 +49,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -60,7 +60,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -71,7 +71,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='enrolled_factors'> {/*> **data**: \{ `enrolled_factors`: `string`[]; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-login-options.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L10) +Defined in: [interfaces/screens/mfa-login-options.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L10) #### Type Declaration @@ -94,7 +94,7 @@ List of enrolled MFA factors for the user <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -116,7 +116,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -127,7 +127,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge.mdx index e2c9ac700..140f2cc97 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaOtpChallenge" --- -Defined in: [interfaces/screens/mfa-otp-challenge.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L8) +Defined in: [interfaces/screens/mfa-otp-challenge.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L8) Interface for the screen data specific to mfa-otp-challenge screen @@ -26,7 +26,7 @@ export interface ScreenMembersOnMfaOtpChallenge extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='showRememberDevice?'> {/*> **data**: \{ `showRememberDevice?`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-otp-challenge.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L9) +Defined in: [interfaces/screens/mfa-otp-challenge.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L9) #### Overrides @@ -81,7 +81,7 @@ Defined in: [interfaces/screens/mfa-otp-challenge.ts:9](https://github.com/auth0 <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -103,7 +103,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -114,7 +114,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx index 5d48ed747..0f6f67ec2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaOtpEnrollmentCode" --- -Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L32) +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L32) Interface for the screen data specific to the mfa-otp-enrollment-code screen. @@ -29,7 +29,7 @@ export interface ScreenMembersOnMfaOtpEnrollmentCode extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -51,7 +51,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -73,7 +73,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='text_code'> {/*> **data**: \{ `text_code`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L33) +Defined in: [interfaces/screens/mfa-otp-enrollment-code.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L33) #### Type Declaration @@ -96,7 +96,7 @@ The text code to display to the user. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -107,7 +107,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -118,7 +118,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -129,7 +129,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx index 3608f597e..59eecd4fb 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaOtpEnrollmentQr" --- -Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L8) +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L8) Interface for the screen data specific to mfa-otp-enrollment-qr screen @@ -26,7 +26,7 @@ export interface ScreenMembersOnMfaOtpEnrollmentQr extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='qr_code'> {/*> **data**: \{ `qr_code`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L9) +Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-qr.ts#L9) #### Overrides @@ -81,7 +81,7 @@ Defined in: [interfaces/screens/mfa-otp-enrollment-qr.ts:9](https://github.com/a <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -103,7 +103,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -114,7 +114,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx index 00d31599c..14a51aaca 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaPhoneChallenge" --- -Defined in: [interfaces/screens/mfa-phone-challenge.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L16) +Defined in: [interfaces/screens/mfa-phone-challenge.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L16) ScreenMembersOnMfaPhoneChallenge @@ -31,7 +31,7 @@ export interface ScreenMembersOnMfaPhoneChallenge extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -42,7 +42,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -53,7 +53,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -64,7 +64,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -75,7 +75,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='phoneNumber'> {/*> **data**: \{ `phoneNumber`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-phone-challenge.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L21) +Defined in: [interfaces/screens/mfa-phone-challenge.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-phone-challenge.ts#L21) #### Type Declaration @@ -98,7 +98,7 @@ The phone number (often masked) associated with this MFA challenge. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -109,7 +109,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -120,7 +120,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -131,7 +131,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush.mdx index 2d65e4392..be96aef7a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaPushChallengePush" --- -Defined in: [interfaces/screens/mfa-push-challenge-push.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L13) +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L13) Interface for the screen data specific to mfa-push-challenge-push screen @@ -29,7 +29,7 @@ export interface ScreenMembersOnMfaPushChallengePush extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -51,7 +51,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -73,7 +73,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='deviceName'> {/*> **data**: \{ `deviceName`: `string`; `showRememberDevice?`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-push-challenge-push.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L14) +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L14) #### Type Declaration @@ -102,7 +102,7 @@ Whether to show the remember device option <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -113,7 +113,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -124,7 +124,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -135,7 +135,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx index fc080748c..da3b88d05 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaPushEnrollmentQr" --- -Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L13) +Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L13) Interface for the screen data specific to mfa-push-enrollment-qr screen @@ -28,7 +28,7 @@ export interface ScreenMembersOnMfaPushEnrollmentQr extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -39,7 +39,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -50,7 +50,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='qrCode'> {/*> **data**: \{ `qrCode`: `string`; `qrUri`: `string`; `showCodeCopy`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L14) +Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L14) #### Overrides @@ -83,7 +83,7 @@ Defined in: [interfaces/screens/mfa-push-enrollment-qr.ts:14](https://github.com <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -116,7 +116,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome.mdx index c1d7a32f3..bc08895a0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaPushWelcome" --- -Defined in: [interfaces/screens/mfa-push-welcome.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L9) +Defined in: [interfaces/screens/mfa-push-welcome.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L9) <RequestExample> @@ -28,7 +28,7 @@ export interface ScreenMembersOnMfaPushWelcome extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -39,7 +39,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -50,7 +50,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) #### Inherited from @@ -83,7 +83,7 @@ Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal- <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -116,7 +116,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='screen' type='object'> {/*> **screen**: `object`*/} -Defined in: [interfaces/screens/mfa-push-welcome.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L10) +Defined in: [interfaces/screens/mfa-push-welcome.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-welcome.ts#L10) #### links @@ -139,7 +139,7 @@ Defined in: [interfaces/screens/mfa-push-welcome.ts:10](https://github.com/auth0 <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx index f175702b1..5266eef88 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaRecoveryCodeChallengeNewCode" --- -Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L11) +Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L11) ScreenMembersOnMfaRecoveryCodeChallengeNewCode @@ -34,7 +34,7 @@ export interface ScreenMembersOnMfaRecoveryCodeChallengeNewCode extends ScreenMe <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -45,7 +45,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -56,7 +56,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -67,7 +67,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='textCode'> {/*> **data**: \{ `textCode`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L16) +Defined in: [interfaces/screens/mfa-recovery-code-challenge-new-code.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-challenge-new-code.ts#L16) #### Type Declaration @@ -102,7 +102,7 @@ It is crucial that the user saves this code securely as it will be needed for fu <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -113,7 +113,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -124,7 +124,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -135,7 +135,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx index 28942f85c..76bdc867b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaRecoveryCodeEnrollment" --- -Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L8) +Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L8) Interface describing the data available on the Mfa Recovery Code Enrollment screen. @@ -29,7 +29,7 @@ export interface ScreenMembersOnMfaRecoveryCodeEnrollment extends ScreenMembers <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -51,7 +51,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -73,7 +73,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='textCode'> {/*> **data**: \{ `textCode`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L9) +Defined in: [interfaces/screens/mfa-recovery-code-enrollment.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-recovery-code-enrollment.ts#L9) #### Type Declaration @@ -96,7 +96,7 @@ The recovery code to display to the user. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -107,7 +107,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -118,7 +118,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -129,7 +129,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge.mdx index ab4abe8de..f26ddac6f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaSmsChallenge" --- -Defined in: [interfaces/screens/mfa-sms-challenge.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L16) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L16) Interface for the screen data specific to mfa-sms-challenge screen @@ -37,7 +37,7 @@ export interface ScreenMembersOnMfaSmsChallenge extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -81,7 +81,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='phoneNumber?'> {/*> **data**: \{ `phoneNumber?`: `string`; `showLinkVoice?`: `boolean`; `showRememberDevice?`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-sms-challenge.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L17) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L17) #### Type Declaration @@ -116,7 +116,7 @@ Whether to show the remember device option <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -127,7 +127,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -138,7 +138,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -149,7 +149,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx index 3aacd01cb..491f8d512 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaSmsEnrollment" --- -Defined in: [interfaces/screens/mfa-sms-enrollment.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L11) +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L11) <RequestExample> @@ -24,7 +24,7 @@ export interface ScreenMembersOnMfaSmsEnrollment extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -35,7 +35,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -57,7 +57,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='phone?'> {/*> **data**: \{ `phone?`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-sms-enrollment.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L12) +Defined in: [interfaces/screens/mfa-sms-enrollment.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L12) #### Overrides @@ -79,7 +79,7 @@ Defined in: [interfaces/screens/mfa-sms-enrollment.ts:12](https://github.com/aut <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -90,7 +90,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -101,7 +101,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -112,7 +112,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx index d1ad91b45..40e170a90 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaVoiceChallenge" --- -Defined in: [interfaces/screens/mfa-voice-challenge.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L30) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L30) Extended screen members interface for the MFA Voice Challenge screen. @@ -42,7 +42,7 @@ export interface ScreenMembersOnMfaVoiceChallenge extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -53,7 +53,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -64,7 +64,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -75,7 +75,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='phoneNumber?'> {/*> **data**: \{ `phoneNumber?`: `string`; `showLinkSms?`: `boolean`; `showRememberDevice?`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-voice-challenge.ts:34](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L34) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L34) Additional screen data specific to MFA voice challenge. @@ -123,7 +123,7 @@ Whether to show the remember device option. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -134,7 +134,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -145,7 +145,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -156,7 +156,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx index d956481db..bd129aff3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaWebAuthnChangeKeyNickname" --- -Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L15) +Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L15) ScreenMembersOnMfaWebAuthnChangeKeyNickname @@ -37,7 +37,7 @@ export interface ScreenMembersOnMfaWebAuthnChangeKeyNickname extends ScreenMembe <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -81,7 +81,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='nickname'> {/*> **data**: \{ `nickname`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L20) +Defined in: [interfaces/screens/mfa-webauthn-change-key-nickname.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-change-key-nickname.ts#L20) Screen-specific data. @@ -117,7 +117,7 @@ This value should be displayed to the user for context. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -128,7 +128,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -139,7 +139,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -150,7 +150,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx index 61ca94fa8..397d0bb55 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaWebAuthnEnrollmentSuccess" --- -Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L17) +Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L17) ScreenMembersOnMfaWebAuthnEnrollmentSuccess @@ -44,7 +44,7 @@ export interface ScreenMembersOnMfaWebAuthnEnrollmentSuccess extends ScreenMembe <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType">WebAuthnType</a></span>}> {/*> **data**: \{ `nickname`: `string`; `webauthnType`: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType); \} \| `null`*/} -Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L22) +Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L22) Screen-specific data. @@ -132,7 +132,7 @@ The type of WebAuthn authenticator that was successfully enrolled. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -143,7 +143,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -154,7 +154,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -165,7 +165,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError.mdx index 3fc73cd32..8f9156bcd 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaWebAuthnError" --- -Defined in: [interfaces/screens/mfa-webauthn-error.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L20) +Defined in: [interfaces/screens/mfa-webauthn-error.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L20) ScreenMembersOnMfaWebAuthnError @@ -40,7 +40,7 @@ export interface ScreenMembersOnMfaWebAuthnError extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -51,7 +51,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -73,7 +73,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -84,7 +84,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType">WebAuthnType</a></span>}> {/*> **data**: \{ `errorType`: `string`; `webauthnType`: [`WebAuthnType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType); \} \| `null`*/} -Defined in: [interfaces/screens/mfa-webauthn-error.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L28) +Defined in: [interfaces/screens/mfa-webauthn-error.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L28) #### Type Declaration @@ -113,7 +113,7 @@ The type of WebAuthn authenticator involved. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -124,7 +124,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -135,7 +135,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -146,7 +146,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx index 1d06c6ba2..27c775fde 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaWebAuthnPlatformChallenge" --- -Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L16) +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L16) ScreenMembersOnMfaWebAuthnPlatformChallenge @@ -36,7 +36,7 @@ export interface ScreenMembersOnMfaWebAuthnPlatformChallenge extends ScreenMembe <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -47,7 +47,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -58,7 +58,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -69,7 +69,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -80,7 +80,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) Screen-specific data. @@ -93,7 +93,7 @@ Screen-specific data. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -104,7 +104,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -115,7 +115,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -126,7 +126,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='publicKey' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential">AllowCredential</a></span>}> {/*> **publicKey**: \{ `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential)[]; `challenge`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L23) +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L23) The public key credential request options (specifically the challenge) needed to call `navigator.credentials.get()`. This is derived from `universal_login_context.screen.data.passkey.public_key`. @@ -136,7 +136,7 @@ needed to call `navigator.credentials.get()`. This is derived from `universal_lo <ParamField body='showRememberDevice' type='boolean'> {/*> **showRememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L29) +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L29) Indicates whether the "Remember this device" checkbox should be displayed. @@ -145,7 +145,7 @@ Indicates whether the "Remember this device" checkbox should be displayed. <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx index cf1bbf8e1..9589824b4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaWebAuthnPlatformEnrollment" --- -Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L11) +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L11) ScreenMembersOnMfaWebAuthnPlatformEnrollment @@ -29,7 +29,7 @@ export interface ScreenMembersOnMfaWebAuthnPlatformEnrollment extends ScreenMemb <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -51,7 +51,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -73,7 +73,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) #### Inherited from @@ -84,7 +84,7 @@ Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal- <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -95,7 +95,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -106,7 +106,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -117,14 +117,14 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='publicKey' type='authenticatorSelection'> {/*> **publicKey**: \{ `authenticatorSelection`: \{ `authenticatorAttachment?`: `string`; `residentKey`: `string`; `userVerification`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `alg`: `number`; `type`: `string`; \}\]; `rp`: \{ `id`: `string`; `name`: `string`; \}; `user`: \{ `displayName`: `string`; `id`: `string`; `name`: `string`; \}; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L17) +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L17) </ParamField> <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx index 79a718e9d..07df400bc 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaWebAuthnRoamingChallenge" --- -Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L17) +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L17) ScreenMembersOnMfaWebAuthnRoamingChallenge @@ -26,7 +26,7 @@ export interface ScreenMembersOnMfaWebAuthnRoamingChallenge extends ScreenMember <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) Screen-specific data. @@ -83,7 +83,7 @@ Screen-specific data. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -116,21 +116,21 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='publicKey' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential">AllowCredential</a></span>}> {/*> **publicKey**: \{ `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential)[]; `challenge`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L20) +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L20) </ParamField> <ParamField body='showRememberDevice?' type='boolean'> {/*> `optional` **showRememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L18) +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L18) </ParamField> <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from @@ -141,5 +141,5 @@ Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal- <ParamField body='webauthnType' type='string'> {/*> **webauthnType**: `string` \| `null`*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L19) +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L19) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx index 19216e795..29ab8cde9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnMfaWebAuthnRoamingEnrollment" --- -Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L7) +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:7](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L7) Interface for screen data specific to mfa-webauthn-roaming-enrollment screen. @@ -25,7 +25,7 @@ export interface ScreenMembersOnMfaWebAuthnRoamingEnrollment extends ScreenMembe <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -36,7 +36,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -47,7 +47,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -58,7 +58,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -69,7 +69,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) #### Inherited from @@ -80,7 +80,7 @@ Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal- <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -91,7 +91,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -102,7 +102,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -113,14 +113,14 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='publicKey' type='authenticatorSelection'> {/*> **publicKey**: \{ `authenticatorSelection`: \{ `authenticatorAttachment?`: `string`; `residentKey`: `string`; `userVerification`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `alg`: `number`; `type`: `string`; \}\]; `rp`: \{ `id`: `string`; `name`: `string`; \}; `user`: \{ `displayName`: `string`; `id`: `string`; `name`: `string`; \}; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L9) +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L9) </ParamField> <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from @@ -131,5 +131,5 @@ Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal- <ParamField body='webauthnType' type='string'> {/*> **webauthnType**: `string` \| `null`*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L8) +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L8) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection.mdx index e6349db10..6a73410df 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnOrganizationSelection" --- -Defined in: [interfaces/screens/organization-selection.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L26) +Defined in: [interfaces/screens/organization-selection.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L26) Interface for the screen data specific to organization-selection screen. @@ -29,7 +29,7 @@ export interface ScreenMembersOnOrganizationSelection extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -51,7 +51,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -73,14 +73,14 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/screens/organization-selection.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L27) +Defined in: [interfaces/screens/organization-selection.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L27) </ParamField> <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) #### Inherited from @@ -91,7 +91,7 @@ Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal- <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -102,7 +102,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -113,7 +113,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -124,28 +124,28 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/screens/organization-selection.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L28) +Defined in: [interfaces/screens/organization-selection.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L28) </ParamField> <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/screens/organization-selection.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L29) +Defined in: [interfaces/screens/organization-selection.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L29) </ParamField> <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}> {/*> **screen**: [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers)*/} -Defined in: [interfaces/screens/organization-selection.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L30) +Defined in: [interfaces/screens/organization-selection.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L30) </ParamField> <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from @@ -156,12 +156,12 @@ Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal- <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}> {/*> **transaction**: [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers)*/} -Defined in: [interfaces/screens/organization-selection.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L31) +Defined in: [interfaces/screens/organization-selection.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L31) </ParamField> <ParamField body='User' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **User**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/screens/organization-selection.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L32) +Defined in: [interfaces/screens/organization-selection.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L32) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment.mdx index 89238c492..5de372173 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnPasskeyEnrollment" --- -Defined in: [interfaces/screens/passkey-enrollment.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L19) +Defined in: [interfaces/screens/passkey-enrollment.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L19) <RequestExample> @@ -24,14 +24,14 @@ export interface ScreenMembersOnPasskeyEnrollment extends ScreenMembers { <ParamField body='backLink' type='string'> {/*> **backLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/passkey-enrollment.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L20) +Defined in: [interfaces/screens/passkey-enrollment.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L20) </ParamField> <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -42,7 +42,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -53,7 +53,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -64,7 +64,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -75,7 +75,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal- <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -97,7 +97,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -108,14 +108,14 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='loginLink' type='string'> {/*> **loginLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/passkey-enrollment.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L21) +Defined in: [interfaces/screens/passkey-enrollment.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L21) </ParamField> <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -126,14 +126,14 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='publicKey' type='authenticatorSelection'> {/*> **publicKey**: \{ `authenticatorSelection`: \{ `authenticatorAttachment?`: `string`; `residentKey`: `string`; `userVerification`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `alg`: `number`; `type`: `string`; \}\]; `rp`: \{ `id`: `string`; `name`: `string`; \}; `user`: \{ `displayName`: `string`; `id`: `string`; `name`: `string`; \}; \} \| `null`*/} -Defined in: [interfaces/screens/passkey-enrollment.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L22) +Defined in: [interfaces/screens/passkey-enrollment.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L22) </ParamField> <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx index e6b40b026..c5be9ab29 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnPasskeyEnrollmentLocal" --- -Defined in: [interfaces/screens/passkey-enrollment-local.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L24) +Defined in: [interfaces/screens/passkey-enrollment-local.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L24) <RequestExample> @@ -22,7 +22,7 @@ export interface ScreenMembersOnPasskeyEnrollmentLocal extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -33,7 +33,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal- <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -110,14 +110,14 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='publicKey' type='authenticatorSelection'> {/*> **publicKey**: \{ `authenticatorSelection`: \{ `authenticatorAttachment?`: `string`; `residentKey`: `string`; `userVerification`: `string`; \}; `challenge`: `string`; `pubKeyCredParams`: \[\{ `alg`: `number`; `type`: `string`; \}\]; `rp`: \{ `id`: `string`; `name`: `string`; \}; `user`: \{ `displayName`: `string`; `id`: `string`; `name`: `string`; \}; \} \| `null`*/} -Defined in: [interfaces/screens/passkey-enrollment-local.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L25) +Defined in: [interfaces/screens/passkey-enrollment-local.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L25) </ParamField> <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx index 0083f7b85..c4164ebb5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnPhoneIdentifierChallenge" --- -Defined in: [interfaces/screens/phone-identifier-challenge.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L26) +Defined in: [interfaces/screens/phone-identifier-challenge.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L26) <RequestExample> @@ -28,7 +28,7 @@ export interface ScreenMembersOnPhoneIdentifierChallenge extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -39,7 +39,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -50,7 +50,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='messageType?'> {/*> **data**: \{ `messageType?`: `"voice"` \| `"text"`; `phone?`: `string`; `resendLimitReached?`: `boolean`; `showLinkSms?`: `boolean`; `showLinkVoice?`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/phone-identifier-challenge.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L27) +Defined in: [interfaces/screens/phone-identifier-challenge.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L27) #### Overrides @@ -83,7 +83,7 @@ Defined in: [interfaces/screens/phone-identifier-challenge.ts:27](https://github <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -116,7 +116,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx index 2d6c65c56..294e3a12e 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnPhoneIdentifierEnrollment" --- -Defined in: [interfaces/screens/phone-identifier-enrollment.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L10) +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L10) <RequestExample> @@ -26,7 +26,7 @@ export interface ScreenMembersOnPhoneIdentifierEnrollment extends ScreenMembers <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='messageType?'> {/*> **data**: \{ `messageType?`: `"voice"` \| `"text"`; `phone?`: `"string"`; \} \| `null`*/} -Defined in: [interfaces/screens/phone-identifier-enrollment.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L11) +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L11) #### Overrides @@ -81,14 +81,14 @@ Defined in: [interfaces/screens/phone-identifier-enrollment.ts:11](https://githu <ParamField body='editIdentifierLink' type='string'> {/*> **editIdentifierLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/phone-identifier-enrollment.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L15) +Defined in: [interfaces/screens/phone-identifier-enrollment.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L15) </ParamField> <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -121,7 +121,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword.mdx index 99eb5ac8a..898ce7bba 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnResetPassword" --- -Defined in: [interfaces/screens/reset-password.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L14) +Defined in: [interfaces/screens/reset-password.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L14) <RequestExample> @@ -24,7 +24,7 @@ export interface ScreenMembersOnResetPassword extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -35,7 +35,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -57,7 +57,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='username?'> {/*> **data**: \{ `username?`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/reset-password.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L15) +Defined in: [interfaces/screens/reset-password.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L15) #### Overrides @@ -79,7 +79,7 @@ Defined in: [interfaces/screens/reset-password.ts:15](https://github.com/auth0/u <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -90,7 +90,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -101,7 +101,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -112,7 +112,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail.mdx index 2db9b5bce..e059cac62 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnResetPasswordEmail" --- -Defined in: [interfaces/screens/reset-password-email.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L13) +Defined in: [interfaces/screens/reset-password-email.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L13) <RequestExample> @@ -24,7 +24,7 @@ export interface ScreenMembersOnResetPasswordEmail extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -35,7 +35,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -57,7 +57,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='username?'> {/*> **data**: \{ `username?`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/reset-password-email.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L14) +Defined in: [interfaces/screens/reset-password-email.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L14) #### Overrides @@ -79,7 +79,7 @@ Defined in: [interfaces/screens/reset-password-email.ts:14](https://github.com/a <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -90,7 +90,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -101,7 +101,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -112,7 +112,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError.mdx index 8ae097911..dc25be793 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnResetPasswordError" --- -Defined in: [interfaces/screens/reset-password-error.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts#L9) +Defined in: [interfaces/screens/reset-password-error.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts#L9) <RequestExample> @@ -24,7 +24,7 @@ export interface ScreenMembersOnResetPasswordError extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -35,7 +35,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -57,7 +57,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='username?'> {/*> **data**: \{ `username?`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/reset-password-error.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts#L10) +Defined in: [interfaces/screens/reset-password-error.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-error.ts#L10) #### Overrides @@ -79,7 +79,7 @@ Defined in: [interfaces/screens/reset-password-error.ts:10](https://github.com/a <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -90,7 +90,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -101,7 +101,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -112,7 +112,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx index 9830efff2..6131f7a87 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnResetPasswordMfaEmailChallenge" --- -Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L8) +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L8) Interface for the screen data specific to reset-password-mfa-email-challenge screen @@ -26,7 +26,7 @@ export interface ScreenMembersOnResetPasswordMfaEmailChallenge extends ScreenMem <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='email'> {/*> **data**: \{ `email`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L9) +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L9) #### Overrides @@ -81,7 +81,7 @@ Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:9](https:/ <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -103,7 +103,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -114,7 +114,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx index 3656b53e9..49e9cbcd8 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnResetPasswordMfaPhoneChallenge" --- -Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L15) +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L15) ScreenMembersOnResetPasswordMfaPhoneChallenge @@ -31,7 +31,7 @@ export interface ScreenMembersOnResetPasswordMfaPhoneChallenge extends ScreenMem <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -42,7 +42,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -53,7 +53,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -64,7 +64,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -75,7 +75,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='phoneNumber'> {/*> **data**: \{ `phoneNumber`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L20) +Defined in: [interfaces/screens/reset-password-mfa-phone-challenge.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-phone-challenge.ts#L20) #### Type Declaration @@ -98,7 +98,7 @@ The phone number (often masked) associated with this MFA challenge. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -109,7 +109,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -120,7 +120,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -131,7 +131,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx index a743e7343..625dca1e0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnResetPasswordMfaPushChallengePush" --- -Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L12) +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L12) Interface for the screen data specific to reset-password-mfa-push-challenge-push screen @@ -22,7 +22,7 @@ export interface ScreenMembersOnResetPasswordMfaPushChallengePush <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -33,7 +33,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='deviceName'> {/*> **data**: \{ `deviceName`: `string`; `rememberDevice?`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L14) +Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L14) #### Overrides @@ -77,7 +77,7 @@ Defined in: [interfaces/screens/reset-password-mfa-push-challenge-push.ts:14](ht <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx index 4968ade04..e74d18620 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnResetPasswordMfaSmsChallenge" --- -Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L11) +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L11) <RequestExample> @@ -28,7 +28,7 @@ export interface ScreenMembersOnResetPasswordMfaSmsChallenge extends ScreenMembe <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -39,7 +39,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -50,7 +50,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='phoneNumber'> {/*> **data**: \{ `phoneNumber`: `string`; `showLinkVoice?`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L12) +Defined in: [interfaces/screens/reset-password-mfa-sms-challenge.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L12) #### Type Declaration @@ -99,7 +99,7 @@ Whether to show the link to switch to voice call verification <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -121,7 +121,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -132,7 +132,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx index b4d97761e..4a6701419 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnResetPasswordMfaVoiceChallenge" --- -Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L9) +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L9) Interface for the screen data specific to reset-password-mfa-voice-challenge screen. @@ -34,7 +34,7 @@ export interface ScreenMembersOnResetPasswordMfaVoiceChallenge extends ScreenMem <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -45,7 +45,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -56,7 +56,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -67,7 +67,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='phoneNumber'> {/*> **data**: \{ `phoneNumber`: `string`; `showLinkSms?`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L10) +Defined in: [interfaces/screens/reset-password-mfa-voice-challenge.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L10) #### Type Declaration @@ -107,7 +107,7 @@ Whether to show the link to switch to SMS verification. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -118,7 +118,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -129,7 +129,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -140,7 +140,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx index 5363bf621..020452dc9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge" --- -Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L30) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L30) ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge @@ -37,7 +37,7 @@ export interface ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge extend <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -81,7 +81,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) Screen-specific data. @@ -94,7 +94,7 @@ Screen-specific data. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -116,7 +116,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -127,7 +127,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='publicKey' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential">AllowCredential</a></span>}> {/*> **publicKey**: \{ `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential)[]; `challenge`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L37) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L37) A convenience accessor for `data.passkey.public_key`. Provides the challenge and other parameters for the @@ -138,7 +138,7 @@ A convenience accessor for `data.passkey.public_key`. <ParamField body='showRememberDevice' type='boolean'> {/*> **showRememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L44) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts:44](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L44) A convenience accessor for `data.show_remember_device`. Indicates if the "Remember this device" option should be displayed. @@ -149,7 +149,7 @@ A convenience accessor for `data.show_remember_device`. <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx index e5c641f73..e81215690 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge" --- -Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L43) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L43) ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge @@ -41,7 +41,7 @@ export interface ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge extends <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -52,7 +52,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -63,7 +63,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -85,7 +85,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) Screen-specific data, including WebAuthn challenge options and the "show remember device" flag. @@ -99,7 +99,7 @@ including WebAuthn challenge options and the "show remember device" flag. <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -121,7 +121,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -132,7 +132,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='publicKey' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential">AllowCredential</a></span>}> {/*> **publicKey**: \{ `allowCredentials?`: [`AllowCredential`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential)[]; `challenge`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L52) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:52](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L52) A convenience accessor for `screen.data.passkey.public_key`. Provides the challenge and related options for `navigator.credentials.get()`. @@ -142,7 +142,7 @@ Provides the challenge and related options for `navigator.credentials.get()`. <ParamField body='showRememberDevice' type='boolean'> {/*> **showRememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L61) +Defined in: [interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts:61](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L61) A convenience accessor for `screen.data.show_remember_device`. Indicates if the "Remember this device" option should be displayed. Defaults to `false` if not present. @@ -152,7 +152,7 @@ Indicates if the "Remember this device" option should be displayed. Defaults to <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest.mdx index ac78bc428..3f7accee3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnResetPasswordRequest" --- -Defined in: [interfaces/screens/reset-password-request.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L19) +Defined in: [interfaces/screens/reset-password-request.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L19) <RequestExample> @@ -26,7 +26,7 @@ export interface ScreenMembersOnResetPasswordRequest extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='email?'> {/*> **data**: \{ `email?`: `string`; `phone?`: `string`; `username?`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/reset-password-request.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L20) +Defined in: [interfaces/screens/reset-password-request.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L20) #### Overrides @@ -81,7 +81,7 @@ Defined in: [interfaces/screens/reset-password-request.ts:20](https://github.com <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -103,7 +103,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -114,7 +114,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess.mdx index 2d18c9b01..24920a642 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnResetPasswordSuccess" --- -Defined in: [interfaces/screens/reset-password-success.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-success.ts#L12) +Defined in: [interfaces/screens/reset-password-success.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-success.ts#L12) <RequestExample> @@ -20,7 +20,7 @@ export interface ScreenMembersOnResetPasswordSuccess extends ScreenMembers {} <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -31,7 +31,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -42,7 +42,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -53,7 +53,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -64,7 +64,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) #### Inherited from @@ -75,7 +75,7 @@ Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal- <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -97,7 +97,7 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -108,7 +108,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup.mdx index 1a901cc53..dc0240948 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnSignup" --- -Defined in: [interfaces/screens/signup.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L23) +Defined in: [interfaces/screens/signup.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L23) <RequestExample> @@ -22,7 +22,7 @@ export interface ScreenMembersOnSignup extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -33,7 +33,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal- <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -99,14 +99,14 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='loginLink' type='string'> {/*> **loginLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/signup.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L24) +Defined in: [interfaces/screens/signup.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L24) </ParamField> <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -117,7 +117,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId.mdx index 53006197b..03e407b36 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnSignupId" --- -Defined in: [interfaces/screens/signup-id.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L25) +Defined in: [interfaces/screens/signup-id.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L25) <RequestExample> @@ -22,7 +22,7 @@ export interface ScreenMembersOnSignupId extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -33,7 +33,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate">PasskeyCreate</a></span>}> {/*> **data**: `Record`\<`string`, `string` \| `boolean` \| [`PasskeyCreate`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) \| `string`[] \| `Record`\<`string`, `string`[]\> \| [`PhonePrefix`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix)[]\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L86) +Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/screen.ts:86](https://github.com/auth0/universal- <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -99,14 +99,14 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='loginLink' type='string'> {/*> **loginLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/signup-id.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L26) +Defined in: [interfaces/screens/signup-id.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L26) </ParamField> <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -117,7 +117,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword.mdx index 21b1aff8c..0714d9546 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword.mdx @@ -2,7 +2,7 @@ title: "ScreenMembersOnSignupPassword" --- -Defined in: [interfaces/screens/signup-password.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L29) +Defined in: [interfaces/screens/signup-password.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L29) <RequestExample> @@ -28,7 +28,7 @@ export interface ScreenMembersOnSignupPassword extends ScreenMembers { <ParamField body='captcha' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext">CaptchaContext</a></span>}> {/*> **captcha**: [`CaptchaContext`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) \| `null`*/} -Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L89) +Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) #### Inherited from @@ -39,7 +39,7 @@ Defined in: [interfaces/models/screen.ts:89](https://github.com/auth0/universal- <ParamField body='captchaImage' type='string'> {/*> **captchaImage**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L82) +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) #### Inherited from @@ -50,7 +50,7 @@ Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal- <ParamField body='captchaProvider' type='string'> {/*> **captchaProvider**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L84) +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal- <ParamField body='captchaSiteKey' type='string'> {/*> **captchaSiteKey**: `string` \| `null`*/} -Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L83) +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal- <ParamField body='data' type='email?'> {/*> **data**: \{ `email?`: `string`; `phoneNumber?`: `string`; `username?`: `string`; \} \| `null`*/} -Defined in: [interfaces/screens/signup-password.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L32) +Defined in: [interfaces/screens/signup-password.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L32) #### Overrides @@ -83,14 +83,14 @@ Defined in: [interfaces/screens/signup-password.ts:32](https://github.com/auth0/ <ParamField body='editLink' type='string'> {/*> **editLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/signup-password.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L31) +Defined in: [interfaces/screens/signup-password.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L31) </ParamField> <ParamField body='isCaptchaAvailable' type='boolean'> {/*> **isCaptchaAvailable**: `boolean`*/} -Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L85) +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) #### Inherited from @@ -101,7 +101,7 @@ Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal- <ParamField body='links' type='Record'> {/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L87) +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) #### Inherited from @@ -112,14 +112,14 @@ Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal- <ParamField body='loginLink' type='string'> {/*> **loginLink**: `string` \| `null`*/} -Defined in: [interfaces/screens/signup-password.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L30) +Defined in: [interfaces/screens/signup-password.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L30) </ParamField> <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L81) +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) #### Inherited from @@ -130,7 +130,7 @@ Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal- <ParamField body='texts' type='Record'> {/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} -Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L88) +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions.mdx index 2bd75bce7..238229cbc 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions.mdx @@ -2,7 +2,7 @@ title: "SelectCountryCodeOptions" --- -Defined in: [interfaces/screens/mfa-country-codes.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L18) +Defined in: [interfaces/screens/mfa-country-codes.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L18) Options for selecting a country code @@ -32,7 +32,7 @@ Any additional custom options > **country\_code**: `string` -Defined in: [interfaces/screens/mfa-country-codes.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L20) +Defined in: [interfaces/screens/mfa-country-codes.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L20) The country code (e.g. 'US', 'GB') @@ -41,6 +41,6 @@ The country code (e.g. 'US', 'GB') > **phone\_prefix**: `string` -Defined in: [interfaces/screens/mfa-country-codes.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L22) +Defined in: [interfaces/screens/mfa-country-codes.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L22) The phone prefix (e.g. '+1', '+44') \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions.mdx index ccff3a676..0c5dc7c33 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions.mdx @@ -2,7 +2,7 @@ title: "SelectMfaEmailOptions" --- -Defined in: [interfaces/screens/mfa-email-list.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L18) +Defined in: [interfaces/screens/mfa-email-list.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L18) Options for selecting an email address @@ -32,7 +32,7 @@ Any additional custom options <ParamField body='index' type='number'> {/*> **index**: `number`*/} -Defined in: [interfaces/screens/mfa-email-list.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L23) +Defined in: [interfaces/screens/mfa-email-list.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-list.ts#L23) #### Param diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions.mdx index deec3bca8..c0d688cea 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions.mdx @@ -2,7 +2,7 @@ title: "SelectMfaPushDeviceOptions" --- -Defined in: [interfaces/screens/mfa-push-list.ts:7](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L7) +Defined in: [interfaces/screens/mfa-push-list.ts:7](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L7) Options for selecting an MFA push device. @@ -29,7 +29,7 @@ export interface SelectMfaPushDeviceOptions { <ParamField body='deviceIndex' type='number'> {/*> **deviceIndex**: `number`*/} -Defined in: [interfaces/screens/mfa-push-list.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L12) +Defined in: [interfaces/screens/mfa-push-list.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L12) The index of the device to select from the list of enrolled devices. The index is 0-based. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectOrganizationOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectOrganizationOptions.mdx index 75f9f9771..a0e65adce 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectOrganizationOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectOrganizationOptions.mdx @@ -2,7 +2,7 @@ title: "SelectOrganizationOptions" --- -Defined in: [interfaces/screens/organization-picker.ts:4](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L4) +Defined in: [interfaces/screens/organization-picker.ts:4](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L4) <RequestExample> @@ -19,12 +19,12 @@ export interface SelectOrganizationOptions { <ParamField body='organization' type='string'> {/*> **organization**: `string`*/} -Defined in: [interfaces/screens/organization-picker.ts:5](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L5) +Defined in: [interfaces/screens/organization-picker.ts:5](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L5) </ParamField> <ParamField body='state' type='string'> {/*> **state**: `string`*/} -Defined in: [interfaces/screens/organization-picker.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L6) +Defined in: [interfaces/screens/organization-picker.ts:6](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L6) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions.mdx index abbeafd84..cb25a4ee2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions.mdx @@ -2,7 +2,7 @@ title: "ShowErrorOptions" --- -Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L14) +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L14) Options for submitting a WebAuthn browser error. @@ -33,7 +33,7 @@ Any additional custom options. <ParamField body='error' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>}> {/*> **error**: [`WebAuthnErrorDetails`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails)*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L18) +Defined in: [interfaces/screens/mfa-webauthn-roaming-enrollment.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L18) The details of the WebAuthn error. </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.mdx index 749197b03..51dbfd6e4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.mdx @@ -2,7 +2,7 @@ title: "SignupIdMembers" --- -Defined in: [interfaces/screens/signup-id.ts:54](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L54) +Defined in: [interfaces/screens/signup-id.ts:54](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L54) <RequestExample> @@ -28,7 +28,7 @@ export interface SignupIdMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -39,7 +39,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -50,7 +50,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId">ScreenMembersOnSignupId</a></span>}> {/*> **screen**: [`ScreenMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId)*/} -Defined in: [interfaces/screens/signup-id.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L55) +Defined in: [interfaces/screens/signup-id.ts:55](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L55) #### Overrides @@ -83,7 +83,7 @@ Defined in: [interfaces/screens/signup-id.ts:55](https://github.com/auth0/univer <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId">TransactionMembersOnSignupId</a></span>}> {/*> **transaction**: [`TransactionMembersOnSignupId`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId)*/} -Defined in: [interfaces/screens/signup-id.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L56) +Defined in: [interfaces/screens/signup-id.ts:56](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L56) #### Overrides @@ -105,7 +105,7 @@ Defined in: [interfaces/screens/signup-id.ts:56](https://github.com/auth0/univer <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -116,7 +116,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -128,7 +128,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='federatedSignup' type='Promise<void>'> {/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/signup-id.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L58) +Defined in: [interfaces/screens/signup-id.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L58) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions">FederatedSignupOptions</a></span>}> @@ -145,7 +145,7 @@ Defined in: [interfaces/screens/signup-id.ts:58](https://github.com/auth0/univer <ParamField body='getSignupIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier">Identifier</a>[]</span>}> {/*> **getSignupIdentifiers**(): [`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier)[] \| `null`*/} -Defined in: [interfaces/screens/signup-id.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L59) +Defined in: [interfaces/screens/signup-id.ts:59](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L59) #### Returns @@ -156,7 +156,7 @@ Defined in: [interfaces/screens/signup-id.ts:59](https://github.com/auth0/univer <ParamField body='pickCountryCode' type='Promise<void>'> {/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/signup-id.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L60) +Defined in: [interfaces/screens/signup-id.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L60) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -173,7 +173,7 @@ Defined in: [interfaces/screens/signup-id.ts:60](https://github.com/auth0/univer <ParamField body='signup' type='Promise<void>'> {/*> **signup**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/signup-id.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L57) +Defined in: [interfaces/screens/signup-id.ts:57](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L57) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions">SignupOptions</a></span>}> @@ -190,7 +190,7 @@ Defined in: [interfaces/screens/signup-id.ts:57](https://github.com/auth0/univer <ParamField body='validateUsername' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}> {/*> **validateUsername**(`username`): [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult)*/} -Defined in: [interfaces/screens/signup-id.ts:61](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L61) +Defined in: [interfaces/screens/signup-id.ts:61](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L61) <Expandable title="Parameters"> <ParamField body='username' type='string'> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.mdx index 803a3ac51..421833659 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.mdx @@ -2,7 +2,7 @@ title: "SignupMembers" --- -Defined in: [interfaces/screens/signup.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L35) +Defined in: [interfaces/screens/signup.ts:35](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L35) <RequestExample> @@ -50,7 +50,7 @@ export interface SignupMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -61,7 +61,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -83,7 +83,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup">ScreenMembersOnSignup</a></span>}> {/*> **screen**: [`ScreenMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup)*/} -Defined in: [interfaces/screens/signup.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L36) +Defined in: [interfaces/screens/signup.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L36) #### Overrides @@ -105,7 +105,7 @@ Defined in: [interfaces/screens/signup.ts:36](https://github.com/auth0/universal <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -116,7 +116,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup">TransactionMembersOnSignup</a></span>}> {/*> **transaction**: [`TransactionMembersOnSignup`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup)*/} -Defined in: [interfaces/screens/signup.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L37) +Defined in: [interfaces/screens/signup.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L37) #### Overrides @@ -127,7 +127,7 @@ Defined in: [interfaces/screens/signup.ts:37](https://github.com/auth0/universal <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -138,7 +138,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -150,7 +150,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='federatedSignup' type='Promise<void>'> {/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/signup.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L39) +Defined in: [interfaces/screens/signup.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L39) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions">FederatedSignupPayloadOptions</a></span>}> @@ -167,7 +167,7 @@ Defined in: [interfaces/screens/signup.ts:39](https://github.com/auth0/universal <ParamField body='getSignupIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier">Identifier</a>[]</span>}> {/*> **getSignupIdentifiers**(): [`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier)[] \| `null`*/} -Defined in: [interfaces/screens/signup.ts:63](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L63) +Defined in: [interfaces/screens/signup.ts:63](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L63) **`Utility Feature`** @@ -203,7 +203,7 @@ Identifier <ParamField body='pickCountryCode' type='Promise<void>'> {/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/signup.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L40) +Defined in: [interfaces/screens/signup.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L40) <Expandable title="Parameters"> <ParamField body='payload?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}> @@ -220,7 +220,7 @@ Defined in: [interfaces/screens/signup.ts:40](https://github.com/auth0/universal <ParamField body='signup' type='Promise<void>'> {/*> **signup**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/signup.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L38) +Defined in: [interfaces/screens/signup.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L38) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions">SignupPayloadOptions</a></span>}> @@ -237,7 +237,7 @@ Defined in: [interfaces/screens/signup.ts:38](https://github.com/auth0/universal <ParamField body='validatePassword' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> {/*> **validatePassword**(`password`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult)*/} -Defined in: [interfaces/screens/signup.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L41) +Defined in: [interfaces/screens/signup.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L41) <Expandable title="Parameters"> <ParamField body='password' type='string'> @@ -254,7 +254,7 @@ Defined in: [interfaces/screens/signup.ts:41](https://github.com/auth0/universal <ParamField body='validateUsername' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult">UsernameValidationResult</a></span>}> {/*> **validateUsername**(`username`): [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult)*/} -Defined in: [interfaces/screens/signup.ts:64](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L64) +Defined in: [interfaces/screens/signup.ts:64](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L64) <Expandable title="Parameters"> <ParamField body='username' type='string'> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions.mdx index 234ebda79..5a39a7322 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions.mdx @@ -2,7 +2,7 @@ title: "SignupOptions" --- -Defined in: [interfaces/screens/signup-id.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L46) +Defined in: [interfaces/screens/signup-id.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L46) <RequestExample> @@ -26,26 +26,26 @@ export interface SignupOptions { <ParamField body='captcha?' type='string'> {/*> `optional` **captcha**: `string`*/} -Defined in: [interfaces/screens/signup-id.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L50) +Defined in: [interfaces/screens/signup-id.ts:50](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L50) </ParamField> <ParamField body='email?' type='string'> {/*> `optional` **email**: `string`*/} -Defined in: [interfaces/screens/signup-id.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L47) +Defined in: [interfaces/screens/signup-id.ts:47](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L47) </ParamField> <ParamField body='phone?' type='string'> {/*> `optional` **phone**: `string`*/} -Defined in: [interfaces/screens/signup-id.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L49) +Defined in: [interfaces/screens/signup-id.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L49) </ParamField> <ParamField body='username?' type='string'> {/*> `optional` **username**: `string`*/} -Defined in: [interfaces/screens/signup-id.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L48) +Defined in: [interfaces/screens/signup-id.ts:48](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L48) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.mdx index 80df31418..e71ade764 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.mdx @@ -2,7 +2,7 @@ title: "SignupPasswordMembers" --- -Defined in: [interfaces/screens/signup-password.ts:55](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L55) +Defined in: [interfaces/screens/signup-password.ts:55](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L55) <RequestExample> @@ -26,7 +26,7 @@ export interface SignupPasswordMembers extends BaseMembers { <ParamField body='branding' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}> {/*> **branding**: [`BrandingMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers)*/} -Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) +Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/base-context.ts:24](https://github.com/auth0/univ <ParamField body='client' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}> {/*> **client**: [`ClientMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers)*/} -Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) +Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/base-context.ts:25](https://github.com/auth0/univ <ParamField body='organization' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}> {/*> **organization**: [`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers)*/} -Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) +Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/base-context.ts:26](https://github.com/auth0/univ <ParamField body='prompt' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}> {/*> **prompt**: [`PromptMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers)*/} -Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) +Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/base-context.ts:27](https://github.com/auth0/univ <ParamField body='screen' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword">ScreenMembersOnSignupPassword</a></span>}> {/*> **screen**: [`ScreenMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword)*/} -Defined in: [interfaces/screens/signup-password.ts:56](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L56) +Defined in: [interfaces/screens/signup-password.ts:56](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L56) #### Overrides @@ -81,7 +81,7 @@ Defined in: [interfaces/screens/signup-password.ts:56](https://github.com/auth0/ <ParamField body='tenant' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}> {/*> **tenant**: [`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers)*/} -Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) +Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [interfaces/models/base-context.ts:29](https://github.com/auth0/univ <ParamField body='transaction' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword">TransactionMembersOnSignupPassword</a></span>}> {/*> **transaction**: [`TransactionMembersOnSignupPassword`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword)*/} -Defined in: [interfaces/screens/signup-password.ts:57](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L57) +Defined in: [interfaces/screens/signup-password.ts:57](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L57) #### Overrides @@ -103,7 +103,7 @@ Defined in: [interfaces/screens/signup-password.ts:57](https://github.com/auth0/ <ParamField body='untrustedData' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}> {/*> **untrustedData**: [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers)*/} -Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) +Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) #### Inherited from @@ -114,7 +114,7 @@ Defined in: [interfaces/models/base-context.ts:32](https://github.com/auth0/univ <ParamField body='user' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}> {/*> **user**: [`UserMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers)*/} -Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) +Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) #### Inherited from @@ -126,7 +126,7 @@ Defined in: [interfaces/models/base-context.ts:31](https://github.com/auth0/univ <ParamField body='federatedSignup' type='Promise<void>'> {/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/signup-password.ts:59](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L59) +Defined in: [interfaces/screens/signup-password.ts:59](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L59) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions">FederatedSignupPasswordPayloadOptions</a></span>}> @@ -143,7 +143,7 @@ Defined in: [interfaces/screens/signup-password.ts:59](https://github.com/auth0/ <ParamField body='signup' type='Promise<void>'> {/*> **signup**(`payload`): `Promise`\<`void`\>*/} -Defined in: [interfaces/screens/signup-password.ts:58](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L58) +Defined in: [interfaces/screens/signup-password.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L58) <Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions">SignupPasswordOptions</a></span>}> @@ -160,7 +160,7 @@ Defined in: [interfaces/screens/signup-password.ts:58](https://github.com/auth0/ <ParamField body='validatePassword' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}> {/*> **validatePassword**(`password`): [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult)*/} -Defined in: [interfaces/screens/signup-password.ts:60](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L60) +Defined in: [interfaces/screens/signup-password.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L60) <Expandable title="Parameters"> <ParamField body='password' type='string'> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions.mdx index 7afcceede..ec9a409be 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions.mdx @@ -2,7 +2,7 @@ title: "SignupPasswordOptions" --- -Defined in: [interfaces/screens/signup-password.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L46) +Defined in: [interfaces/screens/signup-password.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L46) <RequestExample> @@ -27,33 +27,33 @@ export interface SignupPasswordOptions { <ParamField body='captcha?' type='string'> {/*> `optional` **captcha**: `string`*/} -Defined in: [interfaces/screens/signup-password.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L51) +Defined in: [interfaces/screens/signup-password.ts:51](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L51) </ParamField> <ParamField body='email?' type='string'> {/*> `optional` **email**: `string`*/} -Defined in: [interfaces/screens/signup-password.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L47) +Defined in: [interfaces/screens/signup-password.ts:47](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L47) </ParamField> <ParamField body='password' type='string'> {/*> **password**: `string`*/} -Defined in: [interfaces/screens/signup-password.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L50) +Defined in: [interfaces/screens/signup-password.ts:50](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L50) </ParamField> <ParamField body='phoneNumber?' type='string'> {/*> `optional` **phoneNumber**: `string`*/} -Defined in: [interfaces/screens/signup-password.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L49) +Defined in: [interfaces/screens/signup-password.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L49) </ParamField> <ParamField body='username?' type='string'> {/*> `optional` **username**: `string`*/} -Defined in: [interfaces/screens/signup-password.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L48) +Defined in: [interfaces/screens/signup-password.ts:48](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L48) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions.mdx index 8812a7345..17aa74d8d 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions.mdx @@ -2,7 +2,7 @@ title: "SignupPayloadOptions" --- -Defined in: [interfaces/screens/signup.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L9) +Defined in: [interfaces/screens/signup.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L9) <RequestExample> @@ -27,33 +27,33 @@ export interface SignupOptions { <ParamField body='captcha?' type='string'> {/*> `optional` **captcha**: `string`*/} -Defined in: [interfaces/screens/signup.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L14) +Defined in: [interfaces/screens/signup.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L14) </ParamField> <ParamField body='email?' type='string'> {/*> `optional` **email**: `string`*/} -Defined in: [interfaces/screens/signup.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L10) +Defined in: [interfaces/screens/signup.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L10) </ParamField> <ParamField body='password?' type='string'> {/*> `optional` **password**: `string`*/} -Defined in: [interfaces/screens/signup.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L13) +Defined in: [interfaces/screens/signup.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L13) </ParamField> <ParamField body='phoneNumber?' type='string'> {/*> `optional` **phoneNumber**: `string`*/} -Defined in: [interfaces/screens/signup.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L12) +Defined in: [interfaces/screens/signup.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L12) </ParamField> <ParamField body='username?' type='string'> {/*> `optional` **username**: `string`*/} -Defined in: [interfaces/screens/signup.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L11) +Defined in: [interfaces/screens/signup.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L11) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions.mdx index 4c2cbf03e..cffd4f4ca 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions.mdx @@ -2,7 +2,7 @@ title: "StartResendOptions" --- -Defined in: [interfaces/utils/resend-control.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L11) +Defined in: [interfaces/utils/resend-control.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L11) Options for configuring resend functionality @@ -22,13 +22,13 @@ export interface StartResendOptions { <ParamField body='onStatusChange?' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/OnStatusChangeCallback">OnStatusChangeCallback</a></span>}> {/*> `optional` **onStatusChange**: [`OnStatusChangeCallback`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/OnStatusChangeCallback)*/} -Defined in: [interfaces/utils/resend-control.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L13) +Defined in: [interfaces/utils/resend-control.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L13) </ParamField> <ParamField body='Returns' type='unknown'>{/*> `optional` **onTimeout**: () => `void`*/} -Defined in: [interfaces/utils/resend-control.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L14) +Defined in: [interfaces/utils/resend-control.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L14) < `void` @@ -39,5 +39,5 @@ Defined in: [interfaces/utils/resend-control.ts:14](https://github.com/auth0/uni <ParamField body='timeoutSeconds?' type='number'> {/*> `optional` **timeoutSeconds**: `number`*/} -Defined in: [interfaces/utils/resend-control.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L12) +Defined in: [interfaces/utils/resend-control.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L12) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions.mdx index cc3b7c802..700e07f11 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions.mdx @@ -2,7 +2,7 @@ title: "SubmitCaptchaOptions" --- -Defined in: [interfaces/screens/interstitial-captcha.ts:3](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts#L3) +Defined in: [interfaces/screens/interstitial-captcha.ts:3](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts#L3) <RequestExample> @@ -23,5 +23,5 @@ export interface SubmitCaptchaOptions { <ParamField body='captcha' type='string'> {/*> **captcha**: `string`*/} -Defined in: [interfaces/screens/interstitial-captcha.ts:4](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts#L4) +Defined in: [interfaces/screens/interstitial-captcha.ts:4](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts#L4) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions.mdx index 537c7e172..be9a74aed 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions.mdx @@ -2,7 +2,7 @@ title: "SubmitCodeOptions" --- -Defined in: [interfaces/screens/login-passwordless-email-code.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L21) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L21) <RequestExample> @@ -24,12 +24,12 @@ export interface SubmitCodeOptions { <ParamField body='captcha?' type='string'> {/*> `optional` **captcha**: `string`*/} -Defined in: [interfaces/screens/login-passwordless-email-code.ts:23](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L23) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L23) </ParamField> <ParamField body='code' type='string'> {/*> **code**: `string` \| `number`*/} -Defined in: [interfaces/screens/login-passwordless-email-code.ts:22](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L22) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L22) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions.mdx index c69bc02c7..64f6aa3c9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions.mdx @@ -2,7 +2,7 @@ title: "SubmitOTPOptions" --- -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L28) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L28) <RequestExample> @@ -25,19 +25,19 @@ export interface SubmitOTPOptions { <ParamField body='captcha?' type='string'> {/*> `optional` **captcha**: `string`*/} -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L31) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L31) </ParamField> <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L30) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L30) </ParamField> <ParamField body='username?' type='string'> {/*> `optional` **username**: `string`*/} -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L29) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L29) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions.mdx index 2d69423e0..7feb5b1eb 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions.mdx @@ -2,7 +2,7 @@ title: "SubmitPasskeyCredentialOptions" --- -Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L28) +Defined in: [interfaces/screens/mfa-webauthn-platform-enrollment.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L28) SubmitPasskeyCredentialOptions diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers.mdx index f57f5d425..8aed77714 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers.mdx @@ -2,7 +2,7 @@ title: "TenantMembers" --- -Defined in: [interfaces/models/tenant.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/tenant.ts#L8) +Defined in: [interfaces/models/tenant.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/tenant.ts#L8) <RequestExample> @@ -21,26 +21,26 @@ export interface TenantMembers { <ParamField body='enabledFactors' type='string'> {/*> **enabledFactors**: `string`[] \| `null`*/} -Defined in: [interfaces/models/tenant.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/tenant.ts#L12) +Defined in: [interfaces/models/tenant.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/tenant.ts#L12) </ParamField> <ParamField body='enabledLocales' type='string'> {/*> **enabledLocales**: `string`[] \| `null`*/} -Defined in: [interfaces/models/tenant.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/tenant.ts#L11) +Defined in: [interfaces/models/tenant.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/tenant.ts#L11) </ParamField> <ParamField body='friendlyName' type='string'> {/*> **friendlyName**: `string` \| `null`*/} -Defined in: [interfaces/models/tenant.ts:10](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/tenant.ts#L10) +Defined in: [interfaces/models/tenant.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/tenant.ts#L10) </ParamField> <ParamField body='name' type='string'> {/*> **name**: `string` \| `null`*/} -Defined in: [interfaces/models/tenant.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/tenant.ts#L9) +Defined in: [interfaces/models/tenant.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/tenant.ts#L9) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.mdx index a89bd5bb2..4a677d021 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.mdx @@ -2,7 +2,7 @@ title: "TransactionMembers" --- -Defined in: [interfaces/models/transaction.ts:165](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L165) +Defined in: [interfaces/models/transaction.ts:165](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L165) <RequestExample> @@ -39,61 +39,61 @@ export interface TransactionMembers { <ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) </ParamField> <ParamField body='connectionStrategy' type='string'> {/*> **connectionStrategy**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) </ParamField> <ParamField body='countryCode' type='string'> {/*> **countryCode**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) </ParamField> <ParamField body='countryPrefix' type='string'> {/*> **countryPrefix**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) </ParamField> <ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} -Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) </ParamField> <ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> {/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) </ParamField> <ParamField body='hasErrors' type='boolean'> {/*> **hasErrors**: `boolean`*/} -Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) </ParamField> <ParamField body='locale' type='string'> {/*> **locale**: `string`*/} -Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) </ParamField> <ParamField body='state' type='string'> {/*> **state**: `string`*/} -Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin.mdx index 686bafb54..3579656de 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin.mdx @@ -2,7 +2,7 @@ title: "TransactionMembersOnLogin" --- -Defined in: [interfaces/screens/login.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L37) +Defined in: [interfaces/screens/login.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L37) Extended transaction members interface for the login screen @@ -28,14 +28,14 @@ export interface TransactionMembersOnLogin extends TransactionMembers { <ParamField body='allowedIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> {/*> **allowedIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} -Defined in: [interfaces/screens/login.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L42) +Defined in: [interfaces/screens/login.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L42) </ParamField> <ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/univ <ParamField body='connectionStrategy' type='string'> {/*> **connectionStrategy**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) #### Inherited from @@ -57,7 +57,7 @@ Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/univ <ParamField body='countryCode' type='string'> {/*> **countryCode**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/univ <ParamField body='countryPrefix' type='string'> {/*> **countryPrefix**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) #### Inherited from @@ -79,7 +79,7 @@ Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/univ <ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} -Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) #### Inherited from @@ -90,7 +90,7 @@ Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/univ <ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> {/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) #### Inherited from @@ -101,7 +101,7 @@ Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/univ <ParamField body='hasErrors' type='boolean'> {/*> **hasErrors**: `boolean`*/} -Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) #### Inherited from @@ -112,28 +112,28 @@ Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/univ <ParamField body='isForgotPasswordEnabled' type='boolean'> {/*> **isForgotPasswordEnabled**: `boolean`*/} -Defined in: [interfaces/screens/login.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L39) +Defined in: [interfaces/screens/login.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L39) </ParamField> <ParamField body='isPasskeyEnabled' type='boolean'> {/*> **isPasskeyEnabled**: `boolean`*/} -Defined in: [interfaces/screens/login.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L40) +Defined in: [interfaces/screens/login.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L40) </ParamField> <ParamField body='isSignupEnabled' type='boolean'> {/*> **isSignupEnabled**: `boolean`*/} -Defined in: [interfaces/screens/login.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L38) +Defined in: [interfaces/screens/login.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L38) </ParamField> <ParamField body='locale' type='string'> {/*> **locale**: `string`*/} -Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) #### Inherited from @@ -144,14 +144,14 @@ Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/univ <ParamField body='passwordPolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy">PasswordPolicy</a></span>}> {/*> **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy) \| `null`*/} -Defined in: [interfaces/screens/login.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login.ts#L41) +Defined in: [interfaces/screens/login.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L41) </ParamField> <ParamField body='state' type='string'> {/*> **state**: `string`*/} -Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId.mdx index f42bf99c6..07859f141 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId.mdx @@ -2,7 +2,7 @@ title: "TransactionMembersOnLoginId" --- -Defined in: [interfaces/screens/login-id.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L37) +Defined in: [interfaces/screens/login-id.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L37) <RequestExample> @@ -27,14 +27,14 @@ export interface TransactionMembersOnLoginId extends TransactionMembers { <ParamField body='allowedIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> {/*> **allowedIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} -Defined in: [interfaces/screens/login-id.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L43) +Defined in: [interfaces/screens/login-id.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L43) </ParamField> <ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) #### Inherited from @@ -45,7 +45,7 @@ Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/univ <ParamField body='connectionStrategy' type='string'> {/*> **connectionStrategy**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) #### Inherited from @@ -56,7 +56,7 @@ Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/univ <ParamField body='countryCode' type='string'> {/*> **countryCode**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) #### Inherited from @@ -67,7 +67,7 @@ Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/univ <ParamField body='countryPrefix' type='string'> {/*> **countryPrefix**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/univ <ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} -Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) #### Inherited from @@ -89,7 +89,7 @@ Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/univ <ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> {/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) #### Inherited from @@ -100,7 +100,7 @@ Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/univ <ParamField body='hasErrors' type='boolean'> {/*> **hasErrors**: `boolean`*/} -Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) #### Inherited from @@ -111,35 +111,35 @@ Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/univ <ParamField body='isForgotPasswordEnabled' type='boolean'> {/*> **isForgotPasswordEnabled**: `boolean`*/} -Defined in: [interfaces/screens/login-id.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L40) +Defined in: [interfaces/screens/login-id.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L40) </ParamField> <ParamField body='isPasskeyEnabled' type='boolean'> {/*> **isPasskeyEnabled**: `boolean`*/} -Defined in: [interfaces/screens/login-id.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L39) +Defined in: [interfaces/screens/login-id.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L39) </ParamField> <ParamField body='isSignupEnabled' type='boolean'> {/*> **isSignupEnabled**: `boolean`*/} -Defined in: [interfaces/screens/login-id.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L38) +Defined in: [interfaces/screens/login-id.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L38) </ParamField> <ParamField body='isUsernameRequired' type='boolean'> {/*> **isUsernameRequired**: `boolean`*/} -Defined in: [interfaces/screens/login-id.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L41) +Defined in: [interfaces/screens/login-id.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L41) </ParamField> <ParamField body='locale' type='string'> {/*> **locale**: `string`*/} -Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) #### Inherited from @@ -150,7 +150,7 @@ Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/univ <ParamField body='state' type='string'> {/*> **state**: `string`*/} -Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) #### Inherited from @@ -161,5 +161,5 @@ Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/univ <ParamField body='usernamePolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy">UsernamePolicy</a></span>}> {/*> **usernamePolicy**: [`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy) \| `null`*/} -Defined in: [interfaces/screens/login-id.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-id.ts#L42) +Defined in: [interfaces/screens/login-id.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L42) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword.mdx index f8e37a6e4..731770b07 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword.mdx @@ -2,7 +2,7 @@ title: "TransactionMembersOnLoginPassword" --- -Defined in: [interfaces/screens/login-password.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L27) +Defined in: [interfaces/screens/login-password.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L27) <RequestExample> @@ -27,7 +27,7 @@ export interface TransactionMembersOnLoginPassword extends TransactionMembers { <ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/univ <ParamField body='connectionStrategy' type='string'> {/*> **connectionStrategy**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) #### Inherited from @@ -49,7 +49,7 @@ Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/univ <ParamField body='countryCode' type='string'> {/*> **countryCode**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) #### Inherited from @@ -60,7 +60,7 @@ Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/univ <ParamField body='countryPrefix' type='string'> {/*> **countryPrefix**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) #### Inherited from @@ -71,7 +71,7 @@ Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/univ <ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} -Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/univ <ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> {/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) #### Inherited from @@ -93,7 +93,7 @@ Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/univ <ParamField body='hasErrors' type='boolean'> {/*> **hasErrors**: `boolean`*/} -Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) #### Inherited from @@ -104,28 +104,28 @@ Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/univ <ParamField body='isForgotPasswordEnabled' type='boolean'> {/*> **isForgotPasswordEnabled**: `boolean`*/} -Defined in: [interfaces/screens/login-password.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L29) +Defined in: [interfaces/screens/login-password.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L29) </ParamField> <ParamField body='isPasskeyEnabled' type='boolean'> {/*> **isPasskeyEnabled**: `boolean`*/} -Defined in: [interfaces/screens/login-password.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L30) +Defined in: [interfaces/screens/login-password.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L30) </ParamField> <ParamField body='isSignupEnabled' type='boolean'> {/*> **isSignupEnabled**: `boolean`*/} -Defined in: [interfaces/screens/login-password.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L28) +Defined in: [interfaces/screens/login-password.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L28) </ParamField> <ParamField body='locale' type='string'> {/*> **locale**: `string`*/} -Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) #### Inherited from @@ -136,7 +136,7 @@ Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/univ <ParamField body='state' type='string'> {/*> **state**: `string`*/} -Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) #### Inherited from @@ -148,7 +148,7 @@ Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/univ <ParamField body='getAllowedIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a>[]</span>}> {/*> **getAllowedIdentifiers**(): [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} -Defined in: [interfaces/screens/login-password.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L33) +Defined in: [interfaces/screens/login-password.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L33) #### Returns @@ -159,7 +159,7 @@ Defined in: [interfaces/screens/login-password.ts:33](https://github.com/auth0/u <ParamField body='getPasswordPolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy">PasswordPolicy</a></span>}> {/*> **getPasswordPolicy**(): [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy) \| `null`*/} -Defined in: [interfaces/screens/login-password.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L31) +Defined in: [interfaces/screens/login-password.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L31) #### Returns @@ -170,7 +170,7 @@ Defined in: [interfaces/screens/login-password.ts:31](https://github.com/auth0/u <ParamField body='getUsernamePolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy">UsernamePolicy</a></span>}> {/*> **getUsernamePolicy**(): [`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy) \| `null`*/} -Defined in: [interfaces/screens/login-password.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-password.ts#L32) +Defined in: [interfaces/screens/login-password.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L32) #### Returns diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx index c50eebca2..eeb84c4a5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx @@ -2,7 +2,7 @@ title: "TransactionMembersOnLoginPasswordlessEmailCode" --- -Defined in: [interfaces/screens/login-passwordless-email-code.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L17) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L17) <RequestExample> @@ -22,7 +22,7 @@ export interface TransactionMembersOnLoginPasswordlessEmailCode extends Transact <ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) #### Inherited from @@ -33,7 +33,7 @@ Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/univ <ParamField body='connectionStrategy' type='string'> {/*> **connectionStrategy**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/univ <ParamField body='countryCode' type='string'> {/*> **countryCode**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/univ <ParamField body='countryPrefix' type='string'> {/*> **countryPrefix**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/univ <ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} -Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/univ <ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> {/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/univ <ParamField body='hasErrors' type='boolean'> {/*> **hasErrors**: `boolean`*/} -Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) #### Inherited from @@ -99,14 +99,14 @@ Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/univ <ParamField body='isSignupEnabled' type='boolean'> {/*> **isSignupEnabled**: `boolean` \| `null`*/} -Defined in: [interfaces/screens/login-passwordless-email-code.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L18) +Defined in: [interfaces/screens/login-passwordless-email-code.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L18) </ParamField> <ParamField body='locale' type='string'> {/*> **locale**: `string`*/} -Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) #### Inherited from @@ -117,7 +117,7 @@ Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/univ <ParamField body='state' type='string'> {/*> **state**: `string`*/} -Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx index c39bb60b5..3f5948c3b 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx @@ -2,7 +2,7 @@ title: "TransactionMembersOnLoginPasswordlessSmsOtp" --- -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L24) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L24) <RequestExample> @@ -22,7 +22,7 @@ export interface TransactionMembersOnLoginPasswordlessSmsOtp extends Transaction <ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) #### Inherited from @@ -33,7 +33,7 @@ Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/univ <ParamField body='connectionStrategy' type='string'> {/*> **connectionStrategy**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/univ <ParamField body='countryCode' type='string'> {/*> **countryCode**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/univ <ParamField body='countryPrefix' type='string'> {/*> **countryPrefix**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/univ <ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} -Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/univ <ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> {/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/univ <ParamField body='hasErrors' type='boolean'> {/*> **hasErrors**: `boolean`*/} -Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) #### Inherited from @@ -99,14 +99,14 @@ Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/univ <ParamField body='isSignupEnabled' type='boolean'> {/*> **isSignupEnabled**: `boolean`*/} -Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L25) +Defined in: [interfaces/screens/login-passwordless-sms-otp.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L25) </ParamField> <ParamField body='locale' type='string'> {/*> **locale**: `string`*/} -Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) #### Inherited from @@ -117,7 +117,7 @@ Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/univ <ParamField body='state' type='string'> {/*> **state**: `string`*/} -Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword.mdx index 2f6fc4e78..b64b5a5ad 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword.mdx @@ -2,7 +2,7 @@ title: "TransactionMembersOnResetPassword" --- -Defined in: [interfaces/screens/reset-password.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L19) +Defined in: [interfaces/screens/reset-password.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L19) <RequestExample> @@ -22,7 +22,7 @@ export interface TransactionMembersOnResetPassword extends TransactionMembers { <ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) #### Inherited from @@ -33,7 +33,7 @@ Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/univ <ParamField body='connectionStrategy' type='string'> {/*> **connectionStrategy**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) #### Inherited from @@ -44,7 +44,7 @@ Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/univ <ParamField body='countryCode' type='string'> {/*> **countryCode**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) #### Inherited from @@ -55,7 +55,7 @@ Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/univ <ParamField body='countryPrefix' type='string'> {/*> **countryPrefix**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/univ <ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} -Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/univ <ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> {/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/univ <ParamField body='hasErrors' type='boolean'> {/*> **hasErrors**: `boolean`*/} -Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/univ <ParamField body='locale' type='string'> {/*> **locale**: `string`*/} -Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) #### Inherited from @@ -110,14 +110,14 @@ Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/univ <ParamField body='passwordPolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy">PasswordPolicy</a></span>}> {/*> **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy) \| `null`*/} -Defined in: [interfaces/screens/reset-password.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L20) +Defined in: [interfaces/screens/reset-password.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L20) </ParamField> <ParamField body='state' type='string'> {/*> **state**: `string`*/} -Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest.mdx index b08901b0f..0e74ca0af 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest.mdx @@ -2,7 +2,7 @@ title: "TransactionMembersOnResetPasswordRequest" --- -Defined in: [interfaces/screens/reset-password-request.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L13) +Defined in: [interfaces/screens/reset-password-request.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L13) <RequestExample> @@ -24,14 +24,14 @@ export interface TransactionMembersOnResetPasswordRequest extends TransactionMem <ParamField body='allowedIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> {/*> **allowedIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} -Defined in: [interfaces/screens/reset-password-request.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L14) +Defined in: [interfaces/screens/reset-password-request.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L14) </ParamField> <ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) #### Inherited from @@ -42,7 +42,7 @@ Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/univ <ParamField body='connectionStrategy' type='string'> {/*> **connectionStrategy**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) #### Inherited from @@ -53,7 +53,7 @@ Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/univ <ParamField body='countryCode' type='string'> {/*> **countryCode**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) #### Inherited from @@ -64,7 +64,7 @@ Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/univ <ParamField body='countryPrefix' type='string'> {/*> **countryPrefix**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) #### Inherited from @@ -75,7 +75,7 @@ Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/univ <ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} -Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/univ <ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> {/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) #### Inherited from @@ -97,7 +97,7 @@ Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/univ <ParamField body='hasErrors' type='boolean'> {/*> **hasErrors**: `boolean`*/} -Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) #### Inherited from @@ -108,14 +108,14 @@ Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/univ <ParamField body='hasFlexibleIdentifier' type='boolean'> {/*> **hasFlexibleIdentifier**: `boolean`*/} -Defined in: [interfaces/screens/reset-password-request.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L16) +Defined in: [interfaces/screens/reset-password-request.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L16) </ParamField> <ParamField body='locale' type='string'> {/*> **locale**: `string`*/} -Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) #### Inherited from @@ -126,14 +126,14 @@ Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/univ <ParamField body='requiredIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> {/*> **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} -Defined in: [interfaces/screens/reset-password-request.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L15) +Defined in: [interfaces/screens/reset-password-request.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L15) </ParamField> <ParamField body='state' type='string'> {/*> **state**: `string`*/} -Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup.mdx index 1485dfbd7..17ba41f4c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup.mdx @@ -2,7 +2,7 @@ title: "TransactionMembersOnSignup" --- -Defined in: [interfaces/screens/signup.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L27) +Defined in: [interfaces/screens/signup.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L27) <RequestExample> @@ -26,7 +26,7 @@ export interface TransactionMembersOnSignup extends TransactionMembers { <ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/univ <ParamField body='connectionStrategy' type='string'> {/*> **connectionStrategy**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) #### Inherited from @@ -48,7 +48,7 @@ Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/univ <ParamField body='countryCode' type='string'> {/*> **countryCode**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/univ <ParamField body='countryPrefix' type='string'> {/*> **countryPrefix**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/univ <ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} -Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) #### Inherited from @@ -81,7 +81,7 @@ Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/univ <ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> {/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/univ <ParamField body='hasErrors' type='boolean'> {/*> **hasErrors**: `boolean`*/} -Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) #### Inherited from @@ -103,14 +103,14 @@ Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/univ <ParamField body='isPasskeyEnabled' type='boolean'> {/*> **isPasskeyEnabled**: `boolean`*/} -Defined in: [interfaces/screens/signup.ts:28](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L28) +Defined in: [interfaces/screens/signup.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L28) </ParamField> <ParamField body='locale' type='string'> {/*> **locale**: `string`*/} -Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) #### Inherited from @@ -121,28 +121,28 @@ Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/univ <ParamField body='optionalIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> {/*> **optionalIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} -Defined in: [interfaces/screens/signup.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L31) +Defined in: [interfaces/screens/signup.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L31) </ParamField> <ParamField body='passwordPolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy">PasswordPolicy</a></span>}> {/*> **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy) \| `null`*/} -Defined in: [interfaces/screens/signup.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L32) +Defined in: [interfaces/screens/signup.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L32) </ParamField> <ParamField body='requiredIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> {/*> **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} -Defined in: [interfaces/screens/signup.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L30) +Defined in: [interfaces/screens/signup.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L30) </ParamField> <ParamField body='state' type='string'> {/*> **state**: `string`*/} -Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) #### Inherited from @@ -153,5 +153,5 @@ Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/univ <ParamField body='usernamePolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy">UsernamePolicy</a></span>}> {/*> **usernamePolicy**: [`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy) \| `null`*/} -Defined in: [interfaces/screens/signup.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup.ts#L29) +Defined in: [interfaces/screens/signup.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L29) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId.mdx index 445253e94..15d5635c9 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId.mdx @@ -2,7 +2,7 @@ title: "TransactionMembersOnSignupId" --- -Defined in: [interfaces/screens/signup-id.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L29) +Defined in: [interfaces/screens/signup-id.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L29) <RequestExample> @@ -25,7 +25,7 @@ export interface TransactionMembersOnSignupId extends TransactionMembers { <ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) #### Inherited from @@ -36,7 +36,7 @@ Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/univ <ParamField body='connectionStrategy' type='string'> {/*> **connectionStrategy**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) #### Inherited from @@ -47,7 +47,7 @@ Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/univ <ParamField body='countryCode' type='string'> {/*> **countryCode**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) #### Inherited from @@ -58,7 +58,7 @@ Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/univ <ParamField body='countryPrefix' type='string'> {/*> **countryPrefix**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) #### Inherited from @@ -69,7 +69,7 @@ Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/univ <ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} -Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) #### Inherited from @@ -80,7 +80,7 @@ Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/univ <ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> {/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) #### Inherited from @@ -91,7 +91,7 @@ Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/univ <ParamField body='hasErrors' type='boolean'> {/*> **hasErrors**: `boolean`*/} -Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) #### Inherited from @@ -102,14 +102,14 @@ Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/univ <ParamField body='isPasskeyEnabled' type='boolean'> {/*> **isPasskeyEnabled**: `boolean`*/} -Defined in: [interfaces/screens/signup-id.ts:30](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L30) +Defined in: [interfaces/screens/signup-id.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L30) </ParamField> <ParamField body='locale' type='string'> {/*> **locale**: `string`*/} -Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) #### Inherited from @@ -120,21 +120,21 @@ Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/univ <ParamField body='optionalIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> {/*> **optionalIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} -Defined in: [interfaces/screens/signup-id.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L33) +Defined in: [interfaces/screens/signup-id.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L33) </ParamField> <ParamField body='requiredIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> {/*> **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} -Defined in: [interfaces/screens/signup-id.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L32) +Defined in: [interfaces/screens/signup-id.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L32) </ParamField> <ParamField body='state' type='string'> {/*> **state**: `string`*/} -Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) #### Inherited from @@ -145,5 +145,5 @@ Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/univ <ParamField body='usernamePolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy">UsernamePolicy</a></span>}> {/*> **usernamePolicy**: [`UsernamePolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy) \| `null`*/} -Defined in: [interfaces/screens/signup-id.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L31) +Defined in: [interfaces/screens/signup-id.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L31) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword.mdx index 238b43c18..2ae41d098 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword.mdx @@ -2,7 +2,7 @@ title: "TransactionMembersOnSignupPassword" --- -Defined in: [interfaces/screens/signup-password.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L39) +Defined in: [interfaces/screens/signup-password.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L39) <RequestExample> @@ -25,7 +25,7 @@ export interface TransactionMembersOnSignupPassword extends TransactionMembers { <ParamField body='alternateConnections' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **alternateConnections**: ([`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection))[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) +Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) #### Inherited from @@ -36,7 +36,7 @@ Defined in: [interfaces/models/transaction.ts:174](https://github.com/auth0/univ <ParamField body='connectionStrategy' type='string'> {/*> **connectionStrategy**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) #### Inherited from @@ -47,7 +47,7 @@ Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/univ <ParamField body='countryCode' type='string'> {/*> **countryCode**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) #### Inherited from @@ -58,7 +58,7 @@ Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/univ <ParamField body='countryPrefix' type='string'> {/*> **countryPrefix**: `string` \| `null`*/} -Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) #### Inherited from @@ -69,7 +69,7 @@ Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/univ <ParamField body='currentConnection' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection">Connection</a></span>}> {/*> **currentConnection**: [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) \| `null`*/} -Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) #### Inherited from @@ -80,7 +80,7 @@ Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/univ <ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error">Error</a></span>}> {/*> **errors**: [`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error)[] \| `null`*/} -Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) +Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) #### Inherited from @@ -91,7 +91,7 @@ Defined in: [interfaces/models/transaction.ts:172](https://github.com/auth0/univ <ParamField body='hasErrors' type='boolean'> {/*> **hasErrors**: `boolean`*/} -Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) #### Inherited from @@ -102,14 +102,14 @@ Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/univ <ParamField body='isPasskeyEnabled' type='boolean'> {/*> **isPasskeyEnabled**: `boolean`*/} -Defined in: [interfaces/screens/signup-password.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L40) +Defined in: [interfaces/screens/signup-password.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L40) </ParamField> <ParamField body='locale' type='string'> {/*> **locale**: `string`*/} -Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) #### Inherited from @@ -120,28 +120,28 @@ Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/univ <ParamField body='optionalIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> {/*> **optionalIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} -Defined in: [interfaces/screens/signup-password.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L43) +Defined in: [interfaces/screens/signup-password.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L43) </ParamField> <ParamField body='passwordPolicy' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy">PasswordPolicy</a></span>}> {/*> **passwordPolicy**: [`PasswordPolicy`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy) \| `null`*/} -Defined in: [interfaces/screens/signup-password.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L41) +Defined in: [interfaces/screens/signup-password.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L41) </ParamField> <ParamField body='requiredIdentifiers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType">IdentifierType</a></span>}> {/*> **requiredIdentifiers**: [`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType)[] \| `null`*/} -Defined in: [interfaces/screens/signup-password.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L42) +Defined in: [interfaces/screens/signup-password.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L42) </ParamField> <ParamField body='state' type='string'> {/*> **state**: `string`*/} -Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) #### Inherited from diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx index e66dd8332..07da57fa7 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions.mdx @@ -2,7 +2,7 @@ title: "TryAnotherMethodMfaOtpChallengeOptions" --- -Defined in: [interfaces/screens/mfa-otp-challenge.ts:38](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L38) +Defined in: [interfaces/screens/mfa-otp-challenge.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L38) Options for trying another method diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions.mdx index a886dd5b2..be6bb8ee2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions.mdx @@ -2,7 +2,7 @@ title: "TryAnotherMethodOptions" --- -Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:37](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L37) +Defined in: [interfaces/screens/reset-password-mfa-email-challenge.ts:37](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L37) Options for trying another method. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions.mdx index a631d0335..935568106 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions.mdx @@ -2,7 +2,7 @@ title: "TryAnotherMethodPayloadOptions" --- -Defined in: [interfaces/screens/mfa-email-challenge.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L49) +Defined in: [interfaces/screens/mfa-email-challenge.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L49) Options for trying another method diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.mdx index e7e5a16b4..a2fb97660 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers.mdx @@ -2,7 +2,7 @@ title: "UntrustedDataMembers" --- -Defined in: [interfaces/models/untrusted-data.ts:14](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L14) +Defined in: [interfaces/models/untrusted-data.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L14) <RequestExample> @@ -32,12 +32,12 @@ export interface UntrustedDataMembers { <ParamField body='authorizationParams' type='key'> {/*> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null`*/} -Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) +Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) </ParamField> <ParamField body='submittedFormData' type='key'> {/*> **submittedFormData**: \{\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `null` \| `undefined`; \} \| `null`*/} -Defined in: [interfaces/models/untrusted-data.ts:15](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L15) +Defined in: [interfaces/models/untrusted-data.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L15) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx index 789fd1c34..886fdd532 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx @@ -2,7 +2,7 @@ title: "UntrustedDataMembersOnMfaEmailChallenge" --- -Defined in: [interfaces/screens/mfa-email-challenge.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L20) +Defined in: [interfaces/screens/mfa-email-challenge.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L20) Interface for untrusted data specific to mfa-email-challenge screen @@ -26,7 +26,7 @@ export interface UntrustedDataMembersOnMfaEmailChallenge extends UntrustedDataMe <ParamField body='authorizationParams' type='key'> {/*> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null`*/} -Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) +Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/un <ParamField body='submittedFormData' type='rememberDevice'> {/*> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-email-challenge.ts:21](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L21) +Defined in: [interfaces/screens/mfa-email-challenge.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L21) #### Overrides diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx index 777cc00b6..fbf666a9c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx @@ -2,7 +2,7 @@ title: "UntrustedDataMembersOnMfaOtpChallenge" --- -Defined in: [interfaces/screens/mfa-otp-challenge.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L17) +Defined in: [interfaces/screens/mfa-otp-challenge.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L17) Interface for untrusted data specific to mfa-otp-challenge screen @@ -26,7 +26,7 @@ export interface UntrustedDataMembersOnMfaOtpChallenge extends UntrustedDataMemb <ParamField body='authorizationParams' type='key'> {/*> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null`*/} -Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) +Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/un <ParamField body='submittedFormData' type='rememberDevice'> {/*> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-otp-challenge.ts:18](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L18) +Defined in: [interfaces/screens/mfa-otp-challenge.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L18) #### Overrides diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx index 81e3f70ca..7dea6adb2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx @@ -2,7 +2,7 @@ title: "UntrustedDataMembersOnMfaPushChallengePush" --- -Defined in: [interfaces/screens/mfa-push-challenge-push.ts:25](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L25) +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L25) Interface for untrusted data specific to mfa-push-challenge-push screen @@ -22,7 +22,7 @@ export interface UntrustedDataMembersOnMfaPushChallengePush <ParamField body='authorizationParams' type='key'> {/*> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null`*/} -Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) +Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) #### Inherited from @@ -33,7 +33,7 @@ Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/un <ParamField body='submittedFormData' type='rememberDevice'> {/*> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-push-challenge-push.ts:27](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L27) +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L27) #### Overrides diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx index 015d5cc88..62c156786 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx @@ -2,7 +2,7 @@ title: "UntrustedDataMembersOnMfaSmsChallenge" --- -Defined in: [interfaces/screens/mfa-sms-challenge.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L51) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:51](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L51) Interface for untrusted data specific to mfa-sms-challenge screen @@ -26,7 +26,7 @@ export interface UntrustedDataMembersOnMfaSmsChallenge extends UntrustedDataMemb <ParamField body='authorizationParams' type='key'> {/*> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null`*/} -Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) +Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/un <ParamField body='submittedFormData' type='rememberDevice'> {/*> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-sms-challenge.ts:52](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L52) +Defined in: [interfaces/screens/mfa-sms-challenge.ts:52](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L52) #### Overrides diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx index d896c9067..e8aa06d43 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx @@ -2,7 +2,7 @@ title: "UntrustedDataMembersOnMfaVoiceChallenge" --- -Defined in: [interfaces/screens/mfa-voice-challenge.ts:146](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L146) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:146](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L146) Interface for untrusted data specific to mfa-voice-challenge screen @@ -26,7 +26,7 @@ export interface UntrustedDataMembersOnMfaVoiceChallenge extends UntrustedDataMe <ParamField body='authorizationParams' type='key'> {/*> **authorizationParams**: \{\[`key`: `` `ext-${string}` ``\]: `string`; `login_hint?`: `string`; `screen_hint?`: `string`; `ui_locales?`: `string`; \} \| `null`*/} -Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) +Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [interfaces/models/untrusted-data.ts:16](https://github.com/auth0/un <ParamField body='submittedFormData' type='rememberDevice'> {/*> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null`*/} -Defined in: [interfaces/screens/mfa-voice-challenge.ts:147](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L147) +Defined in: [interfaces/screens/mfa-voice-challenge.ts:147](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L147) #### Overrides diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers.mdx index 8ed340647..625f7ba17 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers.mdx @@ -2,7 +2,7 @@ title: "UserMembers" --- -Defined in: [interfaces/models/user.ts:39](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L39) +Defined in: [interfaces/models/user.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L39) <RequestExample> @@ -29,82 +29,82 @@ export interface UserMembers { <ParamField body='appMetadata' type='key'> {/*> **appMetadata**: \{\[`key`: `string`\]: `string`; \} \| `null`*/} -Defined in: [interfaces/models/user.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L51) +Defined in: [interfaces/models/user.ts:51](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L51) </ParamField> <ParamField body='email' type='string'> {/*> **email**: `string` \| `null`*/} -Defined in: [interfaces/models/user.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L41) +Defined in: [interfaces/models/user.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L41) </ParamField> <ParamField body='enrolledDevices' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice">EnrolledDevice</a></span>}> {/*> **enrolledDevices**: [`EnrolledDevice`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice)[] \| `null`*/} -Defined in: [interfaces/models/user.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L48) +Defined in: [interfaces/models/user.ts:48](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L48) </ParamField> <ParamField body='enrolledEmails' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail">EnrolledEmail</a></span>}> {/*> **enrolledEmails**: [`EnrolledEmail`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail)[] \| `null`*/} -Defined in: [interfaces/models/user.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L46) +Defined in: [interfaces/models/user.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L46) </ParamField> <ParamField body='enrolledFactors' type='string'> {/*> **enrolledFactors**: `string`[] \| `null`*/} -Defined in: [interfaces/models/user.ts:45](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L45) +Defined in: [interfaces/models/user.ts:45](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L45) </ParamField> <ParamField body='enrolledPhoneNumbers' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber">EnrolledPhoneNumber</a></span>}> {/*> **enrolledPhoneNumbers**: [`EnrolledPhoneNumber`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber)[] \| `null`*/} -Defined in: [interfaces/models/user.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L47) +Defined in: [interfaces/models/user.ts:47](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L47) </ParamField> <ParamField body='id' type='string'> {/*> **id**: `string` \| `null`*/} -Defined in: [interfaces/models/user.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L40) +Defined in: [interfaces/models/user.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L40) </ParamField> <ParamField body='organizations' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Organizations">Organizations</a></span>}> {/*> **organizations**: [`Organizations`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Organizations)[] \| `null`*/} -Defined in: [interfaces/models/user.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L49) +Defined in: [interfaces/models/user.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L49) </ParamField> <ParamField body='phoneNumber' type='string'> {/*> **phoneNumber**: `string` \| `null`*/} -Defined in: [interfaces/models/user.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L43) +Defined in: [interfaces/models/user.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L43) </ParamField> <ParamField body='picture' type='string'> {/*> **picture**: `string` \| `null`*/} -Defined in: [interfaces/models/user.ts:44](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L44) +Defined in: [interfaces/models/user.ts:44](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L44) </ParamField> <ParamField body='userMetadata' type='key'> {/*> **userMetadata**: \{\[`key`: `string`\]: `string`; \} \| `null`*/} -Defined in: [interfaces/models/user.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L50) +Defined in: [interfaces/models/user.ts:50](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L50) </ParamField> <ParamField body='username' type='string'> {/*> **username**: `string` \| `null`*/} -Defined in: [interfaces/models/user.ts:42](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/user.ts#L42) +Defined in: [interfaces/models/user.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L42) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy.mdx index 6706754e5..2acc7564f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy.mdx @@ -2,7 +2,7 @@ title: "UsernamePolicy" --- -Defined in: [interfaces/models/transaction.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L47) +Defined in: [interfaces/models/transaction.ts:47](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L47) <RequestExample> @@ -24,7 +24,7 @@ export interface UsernamePolicy { <ParamField body='allowedFormats?' type='object'> {/*> `optional` **allowedFormats**: `object`*/} -Defined in: [interfaces/models/transaction.ts:51](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L51) +Defined in: [interfaces/models/transaction.ts:51](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L51) #### usernameInEmailFormat? @@ -39,19 +39,19 @@ Defined in: [interfaces/models/transaction.ts:51](https://github.com/auth0/unive <ParamField body='isActive?' type='boolean'> {/*> `optional` **isActive**: `boolean`*/} -Defined in: [interfaces/models/transaction.ts:48](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L48) +Defined in: [interfaces/models/transaction.ts:48](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L48) </ParamField> <ParamField body='maxLength' type='number'> {/*> **maxLength**: `number`*/} -Defined in: [interfaces/models/transaction.ts:49](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L49) +Defined in: [interfaces/models/transaction.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L49) </ParamField> <ParamField body='minLength' type='number'> {/*> **minLength**: `number`*/} -Defined in: [interfaces/models/transaction.ts:50](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/transaction.ts#L50) +Defined in: [interfaces/models/transaction.ts:50](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L50) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError.mdx index 5b988bbb7..fd2fd2c69 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError.mdx @@ -2,7 +2,7 @@ title: "UsernameValidationError" --- -Defined in: [interfaces/utils/validate-username.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L6) +Defined in: [interfaces/utils/validate-username.ts:6](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L6) Represents a single username validation error returned during validation. @@ -39,7 +39,7 @@ export interface UsernameValidationError { <ParamField body='code' type='string'> {/*> **code**: `string`*/} -Defined in: [interfaces/utils/validate-username.ts:12](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L12) +Defined in: [interfaces/utils/validate-username.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L12) A unique identifier for the validation rule that failed. @@ -50,7 +50,7 @@ Example: `"username-too-short"`, `"username-invalid-characters"` <ParamField body='field' type='string'> {/*> **field**: `string`*/} -Defined in: [interfaces/utils/validate-username.ts:24](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L24) +Defined in: [interfaces/utils/validate-username.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L24) The field associated with the validation error, typically "username", "email", or "phone". @@ -59,7 +59,7 @@ The field associated with the validation error, typically "username", "email", o <ParamField body='message' type='string'> {/*> **message**: `string`*/} -Defined in: [interfaces/utils/validate-username.ts:19](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L19) +Defined in: [interfaces/utils/validate-username.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L19) A human-readable description of the error. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult.mdx index 841d9adb9..39ef55891 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult.mdx @@ -2,7 +2,7 @@ title: "UsernameValidationResult" --- -Defined in: [interfaces/utils/validate-username.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L31) +Defined in: [interfaces/utils/validate-username.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L31) The result of validating a username against one or more rules. @@ -31,7 +31,7 @@ export interface UsernameValidationResult { <ParamField body='errors' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError">UsernameValidationError</a></span>}> {/*> **errors**: [`UsernameValidationError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError)[]*/} -Defined in: [interfaces/utils/validate-username.ts:43](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L43) +Defined in: [interfaces/utils/validate-username.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L43) An array of [UsernameValidationError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError) objects representing the individual rules that failed, if any. @@ -43,7 +43,7 @@ This array is empty if [UsernameValidationResult.isValid](#isvalid) is `true`. <ParamField body='isValid' type='boolean'> {/*> **isValid**: `boolean`*/} -Defined in: [interfaces/utils/validate-username.ts:35](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L35) +Defined in: [interfaces/utils/validate-username.ts:35](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L35) Indicates whether the username passed all validation rules. </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions.mdx index 65737689f..b20e77afe 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions.mdx @@ -2,7 +2,7 @@ title: "VerifyPlatformAuthenticatorOptions" --- -Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:40](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L40) +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L40) VerifyPlatformAuthenticatorOptions @@ -33,7 +33,7 @@ export interface VerifyPlatformAuthenticatorOptions extends CustomOptions { <ParamField body='rememberDevice?' type='boolean'> {/*> `optional` **rememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:46](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L46) +Defined in: [interfaces/screens/mfa-webauthn-platform-challenge.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L46) Optional. If true, attempts to remember the browser for future MFA challenges. Corresponds to the `rememberBrowser` form field. This is only applicable if `screen.showRememberDevice` is true. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions.mdx index ec1bcdb3a..a167996ee 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions.mdx @@ -2,7 +2,7 @@ title: "VerifySecurityKeyOptions" --- -Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:31](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L31) +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:31](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L31) VerifySecurityKeyOptions @@ -28,7 +28,7 @@ export interface VerifySecurityKeyOptions extends CustomOptions { <ParamField body='rememberDevice?' type='boolean'> {/*> `optional` **rememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L32) +Defined in: [interfaces/screens/mfa-webauthn-roaming-challenge.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L32) Optional. If true, attempts to remember the browser for future MFA challenges. Corresponds to the `rememberBrowser` form field. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx index 950f030f5..e5b96b9d2 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx @@ -2,7 +2,7 @@ title: "WebAuthnEnrollSuccessContinueOptions" --- -Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:47](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L47) +Defined in: [interfaces/screens/mfa-webauthn-enrollment-success.ts:47](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L47) ContinueOptions diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails.mdx index b28e4d44c..9ff4be84f 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails.mdx @@ -2,7 +2,7 @@ title: "WebAuthnErrorDetails" --- -Defined in: [interfaces/common/index.ts:9](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L9) +Defined in: [interfaces/common/index.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L9) Details of a WebAuthn browser error. @@ -37,7 +37,7 @@ Any additional error properties. <ParamField body='message' type='string'> {/*> **message**: `string`*/} -Defined in: [interfaces/common/index.ts:17](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L17) +Defined in: [interfaces/common/index.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L17) The error message. @@ -46,7 +46,7 @@ The error message. <ParamField body='name' type='string'> {/*> **name**: `string`*/} -Defined in: [interfaces/common/index.ts:13](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/common/index.ts#L13) +Defined in: [interfaces/common/index.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L13) The name of the error (e.g., "NotAllowedError"). </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions.mdx index 184a7e03f..9808a98a0 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions.mdx @@ -2,7 +2,7 @@ title: "WithRememberOptions" --- -Defined in: [interfaces/screens/mfa-push-challenge-push.ts:32](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L32) +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L32) <RequestExample> @@ -26,5 +26,5 @@ export interface WithRememberOptions extends CustomOptions { <ParamField body='rememberDevice?' type='boolean'> {/*> `optional` **rememberDevice**: `boolean`*/} -Defined in: [interfaces/screens/mfa-push-challenge-push.ts:33](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L33) +Defined in: [interfaces/screens/mfa-push-challenge-push.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L33) </ParamField> \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/AuthenticatorTransport.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/AuthenticatorTransport.mdx index 27a6b9c1b..879d987c4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/AuthenticatorTransport.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/AuthenticatorTransport.mdx @@ -5,7 +5,7 @@ title: "Type Alias: AuthenticatorTransport" <ParamField body="AuthenticatorTransport" type='usb | nfc | ble | internal | hybrid'> {/*> **AuthenticatorTransport** = `"usb"` \| `"nfc"` \| `"ble"` \| `"internal"` \| `"hybrid"`*/} -Defined in: [interfaces/models/screen.ts:8](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/models/screen.ts#L8) +Defined in: [interfaces/models/screen.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L8) <RequestExample> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType.mdx index fc8fa7b7f..3c0e1b15c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType.mdx @@ -5,7 +5,7 @@ title: "Type Alias: IdentifierType" <ParamField body="IdentifierType" type='phone | email | username'> {/*> **IdentifierType** = `"phone"` \| `"email"` \| `"username"`*/} -Defined in: [src/constants/identifiers.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/constants/identifiers.ts#L20) +Defined in: [src/constants/identifiers.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/constants/identifiers.ts#L20) Type representing valid identifier values diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaEnrollFactorType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaEnrollFactorType.mdx index 45765ab40..cb82551e3 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaEnrollFactorType.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaEnrollFactorType.mdx @@ -5,7 +5,7 @@ title: "Type Alias: MfaEnrollFactorType" <ParamField body="MfaEnrollFactorType" type='push-notification | otp | sms | phone | voice | webauthn-roaming'> {/*> **MfaEnrollFactorType** = `"push-notification"` \| `"otp"` \| `"sms"` \| `"phone"` \| `"voice"` \| `"webauthn-roaming"`*/} -Defined in: [src/constants/mfa-factors.ts:73](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/constants/mfa-factors.ts#L73) +Defined in: [src/constants/mfa-factors.ts:73](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/constants/mfa-factors.ts#L73) Type definition for MFA enroll factor constants diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaLoginFactorType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaLoginFactorType.mdx index bcd4db41f..24cae1e0a 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaLoginFactorType.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaLoginFactorType.mdx @@ -5,7 +5,7 @@ title: "Type Alias: MfaLoginFactorType" <ParamField body="MfaLoginFactorType" type='push-notification | otp | sms | phone | voice | email | recovery-code | webauthn-roaming | webauthn-platform | duo'> {/*> **MfaLoginFactorType** = `"push-notification"` \| `"otp"` \| `"sms"` \| `"phone"` \| `"voice"` \| `"email"` \| `"recovery-code"` \| `"webauthn-roaming"` \| `"webauthn-platform"` \| `"duo"`*/} -Defined in: [src/constants/mfa-factors.ts:36](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/src/constants/mfa-factors.ts#L36) +Defined in: [src/constants/mfa-factors.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/constants/mfa-factors.ts#L36) Type definition for MFA login factor constants diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions.mdx index 580bcd78f..1eef986f4 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions.mdx @@ -5,7 +5,7 @@ title: "Type Alias: MfaPollingOptions" <ParamField body="MfaPollingOptions" type='object'> {/*> **MfaPollingOptions** = `object`*/} -Defined in: [interfaces/utils/polling-control.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L11) +Defined in: [interfaces/utils/polling-control.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L11) Configuration options for managing an MFA push-notification polling process. @@ -16,7 +16,7 @@ the challenge endpoint is queried and how success or failure is handled. <ParamField body='intervalMs?' type='number'> {/*> `optional` **intervalMs**: `number`*/} -Defined in: [interfaces/utils/polling-control.ts:20](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L20) +Defined in: [interfaces/utils/polling-control.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L20) Optional interval, in **milliseconds**, between consecutive polling requests. @@ -33,7 +33,7 @@ Implementation-specific (commonly 5000 ms) <ParamField body='onCompleted()?' type='() => void'> {/*> `optional` **onCompleted**: () => `void`*/} -Defined in: [interfaces/utils/polling-control.ts:29](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L29) +Defined in: [interfaces/utils/polling-control.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L29) Optional callback executed once the MFA push challenge is successfully approved and polling completes. @@ -49,7 +49,7 @@ approved and polling completes. <ParamField body='onError()?' type='(error) => void'> {/*> `optional` **onError**: (`error`) => `void`*/} -Defined in: [interfaces/utils/polling-control.ts:41](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L41) +Defined in: [interfaces/utils/polling-control.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/polling-control.ts#L41) Optional callback invoked if an error occurs while polling. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/OnStatusChangeCallback.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/OnStatusChangeCallback.mdx index 2b89ac37c..4ffcc228c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/OnStatusChangeCallback.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/OnStatusChangeCallback.mdx @@ -5,7 +5,7 @@ title: "Type Alias: OnStatusChangeCallback" <ParamField body="OnStatusChangeCallback" type='(remainingSeconds, isDisabled) => void'> {/*> **OnStatusChangeCallback** = (`remainingSeconds`, `isDisabled`) => `void`*/} -Defined in: [interfaces/utils/resend-control.ts:6](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L6) +Defined in: [interfaces/utils/resend-control.ts:6](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L6) Callback function for status changes during resend countdown. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType.mdx index 53ef3699a..ef7109e54 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType.mdx @@ -5,7 +5,7 @@ title: "Type Alias: ScreenIdentifierType" <ParamField body="ScreenIdentifierType" type='email | phone | username'> {/*> **ScreenIdentifierType** = `"email"` \| `"phone"` \| `"username"`*/} -Defined in: [interfaces/utils/signup-identifiers.ts:16](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts#L16) +Defined in: [interfaces/utils/signup-identifiers.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts#L16) Represents the types of user identifiers that can be used during signup. diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType.mdx index 9f8856054..daf902c44 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType.mdx @@ -5,7 +5,7 @@ title: "Type Alias: WebAuthnType" <ParamField body="WebAuthnType" type='webauthn-roaming | webauthn-platform'> {/*> **WebAuthnType** = `"webauthn-roaming"` \| `"webauthn-platform"`*/} -Defined in: [interfaces/screens/mfa-webauthn-error.ts:11](https://github.com/auth0/universal-login/blob/41ce742a4ee4c4f52541f94813d5a46ef3da573d/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L11) +Defined in: [interfaces/screens/mfa-webauthn-error.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-error.ts#L11) <RequestExample> From 130552b88637da80d8df049ac0d6e801eac235c4 Mon Sep 17 00:00:00 2001 From: Gabriel <gabrielraeder@outlook.com.br> Date: Wed, 19 Nov 2025 14:06:34 -0300 Subject: [PATCH 7/7] save changes to docs.json --- main/docs.json | 351 ++++++------------ .../interfaces/InterstitialCaptchaMembers.mdx | 2 +- .../Screens/interfaces/PasskeyCreate.mdx | 2 +- 3 files changed, 118 insertions(+), 237 deletions(-) diff --git a/main/docs.json b/main/docs.json index 78df9b24a..bb8f1b4b8 100644 --- a/main/docs.json +++ b/main/docs.json @@ -1334,8 +1334,6 @@ "group": "Other", "pages": [ "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AcceptInvitation", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailIdentifierChallenge", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailOTPChallenge", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailVerificationResult", @@ -1346,9 +1344,7 @@ "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollmentLocal", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierChallenge", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierEnrollment", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/RedeemTicket", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError" + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/RedeemTicket" ] } ] @@ -1356,8 +1352,6 @@ { "group": "Interfaces", "pages": [ - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers", @@ -1367,109 +1361,17 @@ "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CurrentScreenOptions", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FlattenedTheme", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers", @@ -1483,46 +1385,10 @@ "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation", @@ -1541,7 +1407,6 @@ "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr", @@ -1581,22 +1446,6 @@ "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectOrganizationOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin", @@ -1609,9 +1458,6 @@ "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge", @@ -1622,11 +1468,11 @@ "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions", "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails", - "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions" + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError" ] }, { @@ -1666,82 +1512,117 @@ "group": "Screens", "pages": [ "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index", - "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index" + { + "group": "Login", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-email-verification/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-id/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-password/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-email-code/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/login-passwordless-sms-otp/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-aborted/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/logout-complete/index" + ] + }, + { + "group": "Signup", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-id/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/signup-password/index" + ] + }, + { + "group": "MFA", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-begin-enroll-options/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-country-codes/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-detect-browser-capabilities/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-email-list/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-enroll-result/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-login-options/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-code/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-otp-enrollment-qr/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-phone-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-challenge-push/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-enrollment-qr/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-list/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-push-welcome/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-challenge-new-code/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-recovery-code-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-sms-list/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-voice-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-change-key-nickname/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-enrollment-success/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-error/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-not-available-error/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-platform-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/mfa-webauthn-roaming-enrollment/index" + ] + }, + { + "group": "Password", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-email/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-error/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-email-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-otp-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-phone-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-push-challenge-push/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-recovery-code-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-sms-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-voice-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-platform-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-mfa-webauthn-roaming-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-request/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/reset-password-success/index" + ] + }, + { + "group": "Device", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-allowed/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-activation-denied/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/device-code-confirmation/index" + ] + }, + { + "group": "Consent", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/consent/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/customized-consent/index" + ] + }, + { + "group": "Other", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/accept-invitation/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-identifier-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-otp-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/email-verification-result/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/interstitial-captcha/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-picker/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/organization-selection/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/passkey-enrollment-local/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-challenge/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/phone-identifier-enrollment/index", + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/redeem-ticket/index" + ] + } ] }, { diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.mdx index 7e57d592a..78bf308b5 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.mdx @@ -78,7 +78,7 @@ Defined in: [interfaces/models/base-context.ts:28](https://github.com/auth0/univ Defined in: [interfaces/screens/interstitial-captcha.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts#L9) -<<Expandable title="Parameters"> +<Expandable title="Parameters"> <ParamField body='payload' type={<span><a href="/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions">SubmitCaptchaOptions</a></span>}> [`SubmitCaptchaOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions) </ParamField> diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate.mdx index dde238082..762e4486c 100644 --- a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate.mdx +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate.mdx @@ -43,7 +43,7 @@ export interface PasskeyCreate { Defined in: [interfaces/models/screen.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L24) -<<ParamField body='authenticatorSelection' type='object'> +<ParamField body='authenticatorSelection' type='object'> {/*> **authenticatorSelection**: `object`*/} ##### authenticatorSelection.authenticatorAttachment?